Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Hier beschrijven we de stappen om een enkel object op te halen in BlueDolphin. Deze endpoint wordt gebruikt om een specifiek object en zijn eigenschappen uit de repository op te halen of om te verifiëren dat een object succesvol is verwijderd en niet meer bestaat.
HTTP-responses
HTTP response statuscode | Interpretatie |
200 OK | Object succesvol opgehaald |
400 Bad Request | Object kan niet worden gevonden of geladen |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
Om een bestaand object op te halen, doe je een GET-verzoek naar de /objects/{id} endpoint met:
Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door het ID van het object dat je wilt ophalen.
De header voor je API-verzoek
Om het bestaande object met het id 643e9020d97c6a7e28775377 op te halen, sturen we een GET-verzoek naar de 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-eigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor het object |
object_title | string | De naam van het object |
type | object | Objectdefinitie waarop het object is gebaseerd |
workspace | object | Informatie over de workspace waarin het object zich bevindt (Zie de tabel Workspace) |
object_lifecycle_state | string | De lifecycle status kan Huidig of Toekomstig zijn |
created_information | object | Informatie over het aanmaken van het object (Zie de tabel Gebruikersinformatie) |
modified_information | object | Informatie over het wijzigen van het object (Zie de tabel Gebruikersinformatie) |
status | number | Geeft aan of het object actief (2), uitgeschakeld (4) of archived (5) is. Let op: uitgeschakelde objecten kunnen niet worden opgehaald en geven een 400 statuscode terug. |
object_properties | array | Een lijst van objecteigenschappen |
object_properties[].name | string | De naam van de objecteigenschap |
object_properties[].value | string | De waarde van de objecteigenschap |
boem | array | Een lijst van de vragenlijsten van het object |
boem[].id | string | Unieke identificatie voor de vragenlijst |
boem[].name | string | De naam van de vragenlijst |
boem[].items | array | Een lijst van vragenlijstvelden |
boem[].items[].field_type | string | Het type van het vragenlijstveld |
boem[].items[].id | string | Unieke identificatie voor het vragenlijstveld |
boem[].items[].name | string | De naam van het vragenlijstveld |
boem[].items[].value | string | De waarde van het vragenlijstveld |
related_objects | array | Een lijst van geaccepteerde/actieve gerelateerde objecten |
related_objects[].relationship_id | string | De identificatie van de relatie |
related_objects[].object_id | string | De identificatie van het gerelateerde object |
related_objects[].object_title | string | De naam van het gerelateerde object |
related_objects[].type | object | Objectdefinitie waarop het gerelateerde object is gebaseerd |
related_objects[].relationship | object | Relatietype waarop de relatie is gebaseerd |
Workspace
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor de workspace |
name | string | Naam van de workspace |
Gebruikersinformatie
Eigenschap | Type | Beschrijving |
date | string | De stringversie van de ISO datum en tijd |
user_id | string | Unieke identificatie voor de gebruiker |
first_name | string | De voornaam van de gebruiker |
last_name | string | De achternaam van de gebruiker |
Een succesvol verzoek geeft een response met een 200 OK HTTP statuscode en de volgende body terug:
{ "id": "643e9020d97c6a7e28775377", "object_title": "BlueDolphin", "type": { "id": "640b3d7d4a28b925fcf8b9b4", "name": "Applicatie", "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": "Naam", "value": "" } ], "boem": [ { "id": "58edcaf2829327621dfff9e5", "name": "Applicatie Info", "items": [ { "field_type": "dropdown", "id": "dfbf6463-c17d-4107-8903-51cf0968267c", "name": "Is deze applicatie Single Point of Failure (SPOF)?", "value": "" }, { "field_type": "currency", "id": "e59a6e32-bef9-430c-86dc-9dbc31e49b46", "name": "Schatting van jaarlijkse applicatiekosten", "value": "" }, { "field_type": "relation", "id": "6cb46f87-b1a6-4fbd-9043-1f32b4a8f9d2", "name": "Wat zijn de functies van deze applicatie?", "value": "532fff94b41281c17ce263b7|58a0378a63bab70ae83525d9" }, { "field_type": "dropdown", "id": "c29271a2-7634-4abc-962a-bb2af522c547", "name": "Welk stadium is van toepassing op deze applicatie?", "value": "" } ] } ], "related_objects": [ { "relationship_id": "21435a647f12172fc4cc72f0", "object_id": "64369407346524508417d7b2", "object_title": "Acquisitie en ontwikkeling van bouwkavels", "type": { "id": "5d25c4bc0c0ba6e79c23d123", "name": "Bedrijfsproces", "name_internal": "business_process" }, "relationship": { "template_id": "5123e9d68ccee096c838fe93", "name": "gebruikt", "type": "usedby" } } ]
"object_lifecycle_state": "Toekomstig"}