Here we describe the steps for retrieving a single relationship in BlueDolphin. This endpoint serves to retrieve a specific relationship from the repository or to verify that a relationship has been successfully deleted and is no longer existing.
HTTP responses
HTTP response status code | Interpretation |
200 OK | Relationship retrieved successfully |
400 Bad Request | Relationship cannot be found or loaded |
401 Unauthorized | Invalid or missing API key secret and/or tenant |
To retrieve an existing relationship, make a GET request to the /relations/{id} endpoint specifying:
Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the relationship that you want to retrieve.
The header for your API request
To retrieve the existing relationship with the id 645a3daf3c2a798611bb0dfc, we will pass a GET request to the URI https://public-api.eu.bluedolphin.app/v1/relations/645a3daf3c2a798611bb0dfc.
curl -L 'https://public-api.eu.bluedolphin.app/v1/relations/645a3daf3c2a798611bb0dfc' \ -H 'x-api-key: YOURAPIKEYSECRET' \ -H 'tenant: yourtenantname' \ -H 'Content-Type: application/json'
Response properties
Property | Type | Description |
id | string | Unique identifier for the relationship |
remark | string | The remark/label of the relationship |
type | object | Information on the relationship type that the relationship is based on |
relationship | object | Information on the relationship definition |
relationship_lifecycle_state | string | The lifecycle state can be Current or Future |
created_information | object | Information on the creation of the relationship |
modified_information | object | Information on the modification of the relationship |
status | number | Specifies whether the relationship is active (2), disabled (4) or archived (5). Note that retrieving disabled relationships is not possible and returns a 400 status code. |
source_id | string | Unique identifier for the source |
source_type | object | Information on the object type that the source object is based on |
source_workspace | object | Information on the workspace where the source object is located (See the table Workspace) |
target_id | string | Unique identifier for the target |
target_type | object | Information on the object type that the target object is based on |
target_workspace | object | Information on the workspace where the target object is located (See the table Workspace) |
boem | array | Information on the relationship questionnaire |
boem[].id | string | Unique identifier for the questionnaire |
boem[].name | string | The name of the questionnaire |
boem[].items | array | A list of questionnaire fields |
boem[].items[].id | string | Unique identifier for the questionnaire field |
boem[].items[].name | string | The name of the questionnaire field |
boem[].items[].value | string | The value of the questionnaire field |
Workspace
Property | Type | Description |
id | string | Unique identifier for the workspace |
name | string | The name of the workspace |
User information
Property | Type | Description |
date | string | The stringed version of the ISO date and time |
user_id | string | Unique identifier for the user |
first_name | string | The first name of the user |
last_name | string | The last name of the user |
A successful call returns a response with a 200 OK HTTP status code and the following body:
{
"id": "645a3daf3c2a798611bb0dfc",
"remark": "optional relationship label",
"relationship_lifecycle_state": "Current"
"type": {
"id": "5478e9d66bbaa096c838fe93",
"name": "Used By Relationship",
"name_internal": "usedby"
},
"relationship": {
"template_id": "5478e9d66bbaa096c838fe93",
"name": "used by",
"type": "usedby"
},
"created_information": {
"user_id": "000000000000000000000000",
"first_name": "BlueDolphin",
"last_name": "",
"date": "2023-05-10T11:58:03.04Z"
},
"modified_information": null,
"status": 2,
"source_id": "643e9020d97c6a7e28775255",
"source_workspace": {
"id": "63f620763279a10a8eefa7b0",
"name": "main"
},
"source_type": {
"id": "640b3d7d4a28b925fcf8b8b2",
"name": "Application",
"name_internal": "application_component"
},
"target_id": "64369407346524508498d5a2",
"target_type": {
"id": "5d25c4bc0c0ba6e79c23d663",
"name": "Business Process",
"name_internal": "business_process"
},
"target_workspace": {
"id": "63f620763279a10a8eefa7b0",
"name": "main"
},
"boem": [
{
"id": "645cc42f8a072cbafe74ffbe",
"name": "The use of BlueDolphin",
"items": [
{
"field_type": "multiselect",
"id": "638204ec-9317-4c8c-a94f-b79e74b16e7a",
"name": "How often do you use BD?",
"value": ""
}
]
}
]
}