Here you can find the steps for retrieving (all) object definitions. This endpoint serves to retrieve the list of (all) object definitions that are available in the repository, as well as their properties.
HTTP responses
HTTP response status code | Interpretation |
200 OK | Object definitions retrieved successfully |
400 Bad Request | One or more parameters are missing or incorrect. The response body returns a specific error. For example: 'take' must be greater than or equal to '0'. |
401 Unauthorized | Invalid or missing API key secret and/or tenant |
403 Forbidden | The user is not allowed to retrieve these object definitions |
To retrieve the list of object definitions, make a GET request to the /object-definitions endpoint specifying:
Resource/endpoint destination URL. You can choose to send a request to get a complete list or, alternatively, set the optional parameters in the request URI to get a filtered list of definitions.
Parameter | Required | Type | Default | Description |
start | X | number | 0 | Get object definitions starting from this value |
take | X | number | 100 | The number of object definitions to return |
include_disabled | X | boolean | false | If the value is set to “false”, the response contains only active object definitions. If the value is set to “true”, the response contains both active and disabled object definitions. |
The header for your API request
To retrieve the filtered list of both active and disabled object definitions, where we get the first 10 starting from 0, we pass a GET request to the URI https://public-api.eu.bluedolphin.app/v1/object-definitions?take=10&start=0&include_disabled=true.
curl -L 'https://public-api.eu.bluedolphin.app/v1/object-definitions?take=10&start=1&include_disabled=true' \ -H 'tenant: yourtenantname' \ -H 'x-api-key: YOURAPIKEYSECRET'
Response properties
Property | Type | Description |
total_items | number | The total number of object definitions |
items | array | A list that contains the requested object definitions |
items[].id | string | Unique identifier for the object definition |
items[].name | string | The name of the object definition |
items[].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. |
A successful call returns a response with a 200 OK HTTP status code and the following body:
{
"total_items": 24,
"items": [
{
"id": "59f855d6ec9d263f70d7ab80",
"name": "Application Collaboration",
"type": {
"id": "54abdbf6c3aef5e1b9fb17b3",
"name": "Application Collaboration",
"name_internal": "application_collaboration",
"category": "Applicationlayer",
"category_internal": "application_layer",
"color": "#1EAAF0"
}
},
{
"id": "532eeed0b41281c17ce263b9",
"name": "Application Component",
"type": {
"id": "6194ee942e86804e0c21c638",
"name": "Application Component",
"name_internal": "application_component",
"category": "Applicationlayer",
"category_internal": "application_layer",
"color": "#1EAAF0"
}
},
{
"id": "532eee94b41281c17ce263b7",
"name": "Application Function",
"type": {
"id": "532eee94b41281c17ce263b7",
"name": "Application Function",
"name_internal": "application_function",
"category": "Applicationlayer",
"category_internal": "application_layer",
"color": "#1EAAF0"
}
},
{
"id": "53ce28d1f04ebf0160572211",
"name": "Application Service",
"type": {
"id": "53ce28d1f04ebf0160572211",
"name": "Application Service",
"name_internal": "application_service",
"category": "Applicationlayer",
"category_internal": "application_layer",
"color": "#1EAAF0"
}
},
{
"id": "53ce2981f04ebf0160531233",
"name": "Artifact",
"type": {
"id": "53ce2981f04ebf0160531233",
"name": "Artifact",
"name_internal": "artifact",
"category": "Technologylayer",
"category_internal": "technology_layer",
"color": "#48b220"
}
},
{
"id": "5d25c54b0c0ba6e79c12e7cb",
"name": "Business Actor",
"type": {
"id": "5d25c5530c0ba6e79c12e7d5",
"name": "Business Actor",
"name_internal": "business_actor",
"category": "Businesslayer",
"category_internal": "business_layer",
"color": "#FCC13D"
}
},
{
"id": "5d25c4940c0cf6f25c01872e",
"name": "Business Collaboration",
"type": {
"id": "5d25c49b0c0ef6f25c018738",
"name": "Business Collaboration",
"name_internal": "business_collaboration",
"category": "Businesslayer",
"category_internal": "business_layer",
"color": "#FCC13D"
}
},
{
"id": "5d25cbe70c0ba6e79c23d41b",
"name": "Business Event",
"type": {
"id": "5d25cbee0c0ba6e79c23d425",
"name": "Business Event",
"name_internal": "business_event",
"category": "Businesslayer",
"category_internal": "business_layer",
"color": "#FCC13D"
}
},
{
"id": "5d25c5123c0ba6e79c23defa",
"name": "Business Function",
"type": {
"id": "5d25c6262c0ba6e79c23df04",
"name": "Business Function",
"name_internal": "business_function",
"category": "Businesslayer",
"category_internal": "business_layer",
"color": "#FCC13D"
}
},
{
"id": "5d25be6e1c0ba6f25c017a84",
"name": "Business Interaction",
"type": {
"id": "5d25be681c0ba6e79c23d40c",
"name": "Business Interaction",
"name_internal": "business_interaction",
"category": "Businesslayer",
"category_internal": "business_layer",
"color": "#FCC13D"
}
}
]
}