Retrieve objects – BlueDolphin

Here you can find the steps for retrieving (all) objects for a specific workspace. The endpoint serves to retrieve the list of (all) objects that are available in the repository for the requested workspace, along with the objects' main properties.

HTTP responses

HTTP response status code	Interpretation
200 OK	A list of objects retrieved successfully
400 Bad request	One or more parameters are missing or incorrect. The response body returns a specific error. For example: 'workspace_id is missing or incorrect'.
401 Unauthorized	Invalid or missing API key secret and/or tenant

To retrieve the list of objects for a given workspace, make a GET request to the /objects endpoint specifying:

Resource/endpoint destination URL

To get a complete list of objects, send a request to GET /objects?workspace_id={workspace_id}. Alternatively, to get a filtered list of objects, set the optional parameters in a request to GET /objects?workspace_id={workspace_id}[&filter=all][&title={title}|&name={name}|&related={id}].

Query parameters

Query parameters title, name, and related are mutually exclusive.

Parameter	Required	Type	Default	Description
filter	X	string	all	Embeds the following three scenarios: all (must be lower case), where all objects are searched Layer name (for example, business_layer), where all objects within a specific layer are searched Object definition ID, where all objects from a specific object definition are searched
workspace_id	✓	string		Unique identifier for the workspace where the requested objects are located
take	X	number (0 or positive)	100	The number of objects to be returned
start_with	X	string		Unique identifier for the object (object ID) from which to initiate search (dependent on the filter and workspace_id parameters)
is_archived	X	string	false	Filters objects based on their archival status. Possible values are `true` or `false`. If not specified, a response returns all active objects. If set to `true`, a response returns all archived objects.
title	X	string		Returns objects whose title contains the value of the parameter
name	X	string		Returns objects whose name equals the value of the parameter
related	X	string		Returns all objects that are related to the object with a given object ID

The header for your API request

In this example, we want to retrieve the filtered list of active objects which contains all objects of the type Application Function for the specific workspace. The id of the object definition Application Function is 532fff94b41391c17ce263b7 and the id of the workspace is 63f621863279a10a8eefa7a9.

To get the list, we will pass a GET request to the URI https://public-api.eu.bluedolphin.app/v1/objects?workspace_id=63f621863279a10a8eefa7a9&filter=532fff94b41391c17ce263b7.

curl -L 'https://public-api.eu.bluedolphin.app/v1/objects?workspace_id=63f621863279a10a8eefa7a9&filter=532fff94b41391c17ce263b7' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json'

Response properties

Property	Type	Description
total_items	number	The total number of items in the requested area (by filter). When the number is greater than the `start_with`/`take` parameters, a new request is required to retrieve the remainder.
items	array	A list containing the requested objects
items[].id	string	Unique identifier for the object
items[].title	string	The name of the object
items[].type	object	Object definition that the object is based on
type[].id	string	Unique identifier for the object definition
type[].name	string	The name of the object definition
type[].name_internal	string	The name of the underlying ArchiMate type (that the object definition is based on).

A successful call returns a response with a 200 OK HTTP status code and the following body:

{
    "total_items": 4,
    "items": [
        {
            "id": "64369407346524508498f6e7",
            "title": "Information delivery",
            "type": {
                "id": "532fff94b41391c17ce263b7",
                "name": "Application Function",
                "name_internal": "application_function"
            }
        },
        {
            "id": "64369407346524508498e6ff",
            "title": "Provision of accountability data",
            "type": {
                "id": "532fff94b41391c17ce263b7",
                "name": "Application Function",
                "name_internal": "application_function"
            }
        },
        {
            "id": "64369407346524508498e6db",
            "title": "Provision of areal data for road management",
            "type": {
                "id": "532fff94b41391c17ce263b7",
                "name": "Application Function",
                "name_internal": "application_function"
            }
        },
        {
            "id": "64369407346524508498e6f3",
            "title": "Provision of statistical data",
            "type": {
                "id": "532fff94b41391c17ce263b7",
                "name": "Application Function",
                "name_internal": "application_function"
            }
        }
    ]
}

HTTP responses

Query parameters

Response properties

Related articles