Update an object definition

This endpoint serves to replace an existing object definition. You can update different attributes of an object definition by setting the desired values and passing them to the endpoint PUT /object-definitions/{id}.

Specify the following in your request:

• Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition that you want to have updated/replaced.

• The header for your API request

• The request body

Please ensure that the request body includes values for all parameters that you intend to add and retain for a given definition. Omitting any data in a PUT call will result in its deletion.

HTTP responses

Conditions

• is_mandatory has to be true if you need to update the value of a locked property

• If the request contains an object definition id that is present in the database and of the valid format, a 202 OK is returned

• If the request contains an id of an incorrect format, a 400 Bad Request is returned

• Mandatory/locked properties cannot be removed

• Properties cannot be renamed

Rename an object definition

To change the name of an object definition, use the PUT /object-definitions/{id} endpoint specifying the following in your request:

• Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition that you want to have updated/replaced.

• The header for your API request

• The request body which should include all parameters that you want to keep in the replaced resource

Here is an example API request of how to change the name of the object definition to New Application. Pass a PUT request with the body that contains the desired value for the parameter name.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json' \
-d '{
    "name": "New Application",
    "object_properties": [],
    "related_boem": []
}'

A valid request returns a response with a 202 Accepted HTTP status code and the following body:

{
    "result": "OK"
}

Add an object questionnaire

To add an existing questionnaire to an object definition, make a PUT request to the /object-definitions/{id} endpoint specifying:

• Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition that you want to have updated.

• The header for your API request

• The request body which should include all parameters that you want to keep in the replaced resource

The term boem that is used in the implementation refers to the concept of questionnaire, so all parameters containing boem element serve to handle questionnaires in BlueDolphin.

The example below shows a sample API request to add the existing object questionnaires Application Info and Application Questionnaire to the object definition New Application:

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json' \
-d '{
    "name": "New Application",
    "object_properties": [],
    "related_boem": [
        {
            "id": "58edcaf2829327621cecc9e5"
        },
        {
            "id": "6409d89638102b8f57cece3e"
        }
    ]
}'

A valid request returns a response with a 202 Accepted HTTP status code and the following body:

{
    "result": "OK"
}

Remove an object questionnaire

You can remove an object questionnaire by passing a call to the endpoint PUT /object-definitions/{id}. For a call to be successful, specify the following:

• Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition from which you want to remove a questionnaire.

• The header for your API request

• The request body which should include all parameters that you want to keep in the replaced resource

Here is an example API request of how to remove the existing object questionnaire Application Questionnaire from the object definition New Application. In the previous example, two questionnaires have been added and here we will remove one of them.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json' \
-d '{
    "name": "New Application",
    "object_properties": [],
    "related_boem": [
        {
            "id": "58edcaf2829327621cecc9e5"
        }
    ]
}'

A valid request returns a response with a 202 Accepted HTTP status code and the following body:

{
    "result": "OK"
}

Add an object property

To add a new property to an object definition, make a PUT request to the /object-definitions/{id} endpoint specifying:

• Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition which you want to add a property to.

• The header for your API request

• The request body which should include all parameters that you want to keep in the replaced resource

The example below shows a sample API request to add a new object property of the name Supplier and the standard value Microsoft to the object definition New Application.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json' \
-d '{
    "name": "New Application",
    "object_properties": [
        {
            "name": "Supplier",
            "value": "Microsoft"
        }
    ],
    "related_boem": [
        {
            "id": "58edcaf2829327621cecc9e5"
        }
    ]
}'

A valid request returns a response with a 202 Accepted HTTP status code and the following body:

{
    "result": "OK"
}

Update an object property

Here we describe the steps to update an existing object property. To perform this action, make a PUT request to the /object-definitions/{id} endpoint specifying:

• Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition for which you want to update a property.

• The header for your API request

• The request body which should include all parameters that you want to keep in the replaced resource

The example below shows a sample API request to update the object property of the name Supplier and the standard value Microsoft on the object definition New Application. In this example, we will change the standard value of the property from Microsoft to AWS.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json' \
-d '{
    "name": "New Application",
    "object_properties": [
        {
            "name": "Supplier",
            "value": "AWS"
        }
    ],
    "related_boem": [
       {
            "id": "58edcaf2829327621cecc9e5"
        }
    ]
}'

A valid request returns a response with a 202 Accepted HTTP status code and the following body:

{
    "result": "OK"
}

Remove an object property

In this section we describe the steps to delete an existing object property. To perform this action, make a PUT request to the /object-definitions/{id} endpoint specifying:

• Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition from which you want to remove a property.

• The header for your API request

• The request body which should include all parameters that you want to keep in the replaced resource

The example below shows a sample API request to delete the object property of the name Supplier and the standard value AWS from the object definition New Application.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json' \
-d '{
    "name": "New Application",
    "object_properties": [ ],
    "related_boem": [
        {
            "id": "58edcaf2829327621cecc9e5"
        }
    ]
}'

A valid request returns a response with a 202 Accepted HTTP status code and the following body:

{
    "result": "OK"
}