Retrieve an object – BlueDolphin

Here we describe the steps for retrieving a single object in BlueDolphin. This endpoint serves to retrieve a specific object and its attributes from the repository or to verify that an object has been successfully deleted and is no longer existing.

HTTP responses

HTTP response status code	Interpretation
200 OK	Object retrieved successfully
400 Bad Request	Object cannot be found or loaded
401 Unauthorized	Invalid or missing API key secret and/or tenant

To retrieve an existing object, make a GET request to the /objects/{id} endpoint specifying:

Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object that you want to retrieve.
The header for your API request

To retrieve the existing object with the id 643e9020d97c6a7e28775377, we will pass a GET request to the URI https://public-api.eu.bluedolphin.app/v1/objects/643e9020d97c6a7e28775377.

curl -L 'https://public-api.eu.bluedolphin.app/v1/objects/643e9020d97c6a7e28775377' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json'

Response properties

Property	Type	Description
id	string	Unique identifier for the object
object_title	string	The name of the object
type	object	Object definition that the object is based on
workspace	object	Information on the workspace where the object is located (See the table Workspace)
created_information	object	Information on the creation of the object (See the table User information)
modified_information	object	Information on the modification of the object (See the table User information)
status	number	Specifies whether the object is active (2), disabled (4) or archived (5). Note that retrieving disabled objects is not possible and returns a 400 status code.
object_properties	array	A list of object properties
object_properties[].name	string	The name of the object property
object_properties[].value	string	The value of the object property
boem	array	A list of the questionnaires of the object
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[].field_type	string	The type of the questionnaire field
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
related_objects	array	A list of accepted/active related objects
related_objects[].relationship_id	string	The identifier of the relationship
related_objects[].object_id	string	The identifier of the related object
related_objects[].object_title	string	The name of the related object
related_objects[].type	object	Object definition that the related object is based on
related_objects[].relationship	object	Relationship type that the relationship is based on

Workspace

Property	Type	Description
id	string	Unique identifier for the workspace
name	string	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": "643e9020d97c6a7e28775377",
    "object_title": "BlueDolphin",
    "type": {
        "id": "640b3d7d4a28b925fcf8b9b4",
        "name": "Application",
        "name_internal": "application_component"
    },
    "workspace": {
        "id": "63f621863279a10a8eefa7a9",
        "name": "mainworkspace"
    },
    "created_information": {
        "user_id": "63f6322c275ab8fea702f9b7",
        "first_name": "Hannah",
        "last_name": "Blake",
        "date": "2023-04-18T12:42:08.075Z"
    },
    "modified_information": null,
    "status": 2,
    "object_properties": [
        {
            "name": "Name",
            "value": ""
        }
    ],
    "boem": [
        {
            "id": "58edcaf2829327621dfff9e5",
            "name": "Application Info",
            "items": [
                {
                    "field_type": "dropdown",
                    "id": "dfbf6463-c17d-4107-8903-51cf0968267c",
                    "name": "Is this application Single Point of Failure (SPOF)?",
                    "value": ""
                },
                {
                    "field_type": "currency",
                    "id": "e59a6e32-bef9-430c-86dc-9dbc31e49b46",
                    "name": "Estimate of annual application costs",
                    "value": ""
                },
                {
                    "field_type": "relation",
                    "id": "6cb46f87-b1a6-4fbd-9043-1f32b4a8f9d2",
                    "name": "What are the functions of this application?",
                    "value": "532fff94b41281c17ce263b7|58a0378a63bab70ae83525d9"
                },
                {
                    "field_type": "dropdown",
                    "id": "c29271a2-7634-4abc-962a-bb2af522c547",
                    "name": "Which stadium applies to this application?",
                    "value": ""
                }
            ]
        }
    ],
    "related_objects": [
        {
            "relationship_id": "21435a647f12172fc4cc72f0",
            "object_id": "64369407346524508417d7b2",
            "object_title": "Acquisition and development of building lots",
            "type": {
                "id": "5d25c4bc0c0ba6e79c23d123",
                "name": "Business Process",
                "name_internal": "business_process"
            },
            "relationship": {
                "template_id": "5123e9d68ccee096c838fe93",
                "name": "used by",
                "type": "usedby"
            }
        }
    ]
}

HTTP responses

Response properties

Workspace

User information

Related articles