Here we describe the steps for retrieving an object definition in BlueDolphin. This endpoint serves to look for a specific definition and all its attributes in the repository or to verify that a definition has been successfully deleted and is no longer existing.
HTTP responses
HTTP response status code | Interpretation |
200 OK | Object definition retrieved successfully |
400 Bad Request | One or more validation errors occurred. Unable to load BlueDolphin Object configuration. |
401 Unauthorized | Invalid or missing API key secret and/or tenant |
403 Forbidden | The user is not allowed to retrieve this object definition |
To retrieve an existing object definition, make a GET 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 retrieve.
The header for your API request
To retrieve the existing object definition with the id 6408d42fef4b30e933647ab2, we pass a GET request to the URI https://public-api.eu.bluedolphin.app/v1/object-definitions/6408d42fef4b30e933647ab2.
curl -L 'https://public-api.eu.bluedolphin.app/v1/object-definitions/6408d42fef4b30e933647ab2' \ -H 'tenant: yourtenantname' \ -H 'x-api-key: YOURAPIKEYSECRET'
Response properties
Property | Type | Description |
id | string | Unique identifier for the object definition |
name | string | The name of the object definition |
type | object | Information on the object type that the object definition is based on. Returns the extended type which includes category, category_internal, and color. |
status | number | Specifies whether the definition is active (0) or disabled (1) |
object_properties | array | A list of object properties |
object_properties[].name | string | The name of the object property |
object_properties[].value | string | The standard value of the object property |
related_boem | array | A list of linked/related object questionnaires |
related_boem[].id | string | Unique identifier for the related object questionnaire |
related_boem[].name | string | The name of the related object questionnaire |
A successful call returns a response with a 200 OK HTTP status code and the following body:
{
"id": "6408d42fef4b30e933647ab2",
"name": "New Application",
"type": {
"id": "6194ee942e86804e0c21c638",
"name": "Application Component",
"name_internal": "application_component",
"category": "Applicationlayer",
"category_internal": "application_layer",
"color": "#1EAAF0"
},
"status": 0,
"object_properties": [
{
"name": "Name",
"value": ""
},
{
"name": "Supplier",
"value": "AWS"
}
],
"related_boem": [
{
"id": "6409d89638102b8f57abab3e",
"name": "Application Questionnaire"
}
]
}