Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Hier vind je de stappen om (alle) objecten op te halen voor een specifieke workspace. Het endpoint wordt gebruikt om de lijst van (alle) objecten op te halen die beschikbaar zijn in de repository voor de gevraagde workspace, samen met de belangrijkste eigenschappen van de objecten.
HTTP-responses
HTTP response status code | Interpretatie |
200 OK | Een lijst met objecten is succesvol opgehaald |
400 Bad request | Eén of meer parameters ontbreken of zijn onjuist. De response body geeft een specifieke foutmelding terug. Bijvoorbeeld: 'workspace_id ontbreekt of is onjuist'. |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
Om de lijst met objecten voor een bepaalde workspace op te halen, doe je een GET-verzoek naar het /objects endpoint met de volgende specificatie:
Resource/endpoint bestemmings-URL
Om een volledige lijst van objecten te krijgen, stuur je een verzoek naar GET /objects?workspace_id={workspace_id}. Wil je een gefilterde lijst van objecten, stel dan de optionele parameters in bij een verzoek naar GET /objects?workspace_id={workspace_id}[&filter=all][&title={title}|&name={name}|&related={id}].
Query parameters
Query parameters title, name en related zijn onderling exclusief.
Parameter | Verplicht | Type | Standaard | Beschrijving |
filter | X | string | all | Omvat de volgende drie scenario's:
|
workspace_id | ✓ | string | Unieke identificatie van de workspace waarin de gevraagde objecten zich bevinden | |
take | X | number (0 of positief) | 100 | Het aantal objecten dat wordt teruggegeven |
start_with | X | string | Unieke identificatie van het object (object-ID) vanaf waar de zoekopdracht gestart wordt (afhankelijk van de filter- en workspace_id-parameters) | |
is_archived | X | string | false | Filtert objecten op basis van hun archiveringsstatus. Mogelijke waarden zijn |
title | X | string | Geeft objecten terug waarvan de titel de waarde van de parameter bevat | |
name | X | string | Geeft objecten terug waarvan de naam gelijk is aan de waarde van de parameter | |
related | X | string | Geeft alle objecten terug die gerelateerd zijn aan het object met een opgegeven object-ID |
De header voor je API-verzoek
In dit voorbeeld willen we de gefilterde lijst van actieve objecten ophalen die alle objecten van het type Applicatiefunctie bevat voor de specifieke workspace. De id van de objectdefinitie Applicatiefunctie is 532fff94b41391c17ce263b7 en de id van de workspace is 63f621863279a10a8eefa7a9.
Om de lijst op te halen, sturen we een GET-verzoek naar de 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-eigenschappen
Eigenschap | Type | Beschrijving |
total_items | number | Het totale aantal items in het gevraagde gebied (volgens filter). Wanneer het aantal groter is dan de |
items | array | Een lijst met de opgevraagde objecten |
items[].id | string | Unieke identificatie van het object |
items[].title | string | De naam van het object |
items[].type | object | Objectdefinitie waarop het object is gebaseerd |
type[].id | string | Unieke identificatie van de objectdefinitie |
type[].name | string | De naam van de objectdefinitie |
type[].name_internal | string | De naam van het onderliggende ArchiMate-type (waarop de objectdefinitie is gebaseerd). |
Een succesvol verzoek geeft een response met een 200 OK HTTP-statuscode en de volgende body terug:
{ "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" } } ]}