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 objectdefinitie op te halen in BlueDolphin. Dit endpoint wordt gebruikt om een specifieke definitie en al haar attributen in de repository op te zoeken of om te verifiëren dat een definitie succesvol is verwijderd en niet meer bestaat.
HTTP-responsen
HTTP response statuscode | Interpretatie |
200 OK | Objectdefinitie succesvol opgehaald |
400 Bad Request | Er zijn één of meer validatiefouten opgetreden. Kan BlueDolphin Objectconfiguratie niet laden. |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
403 Forbidden | De gebruiker mag deze objectdefinitie niet ophalen |
Om een bestaande objectdefinitie op te halen, doe je een GET-verzoek naar het /object-definitions/{id} endpoint en geef je het volgende op:
Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door het ID van de objectdefinitie die je wilt ophalen.
De header voor je API-verzoek
Om de bestaande objectdefinitie met het id 6408d42fef4b30e933647ab2 op te halen, sturen we een GET-verzoek naar de URI https://public-api.eu.bluedolphin.app/v1/object-definitions/6408d42fef4b30e933647ab2.
curl -L 'https://public-api.eu.bluedolphin.app/v1/object-definitions/6408d42fef4b30e933647ab2' \-H 'tenant: yourtenantname' \-H 'x-api-key: YOURAPIKEYSECRET'
Response-eigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor de objectdefinitie |
name | string | De naam van de objectdefinitie |
type | object | Informatie over het objecttype waarop de objectdefinitie is gebaseerd. Geeft het uitgebreide type terug, inclusief categorie, category_internal en kleur. |
status | number | Geeft aan of de definitie actief (0) of uitgeschakeld (1) is |
object_properties | array | Een lijst van objecteigenschappen |
object_properties[].name | string | De naam van de objecteigenschap |
object_properties[].value | string | De standaard waarde van de objecteigenschap |
related_boem | array | Een lijst van gekoppelde/gerelateerde objectvragenlijsten |
related_boem[].id | string | Unieke identificatie voor de gerelateerde objectvragenlijst |
related_boem[].name | string | De naam van de gerelateerde objectvragenlijst |
Een succesvol verzoek geeft een response met een 200 OK HTTP statuscode en de volgende body terug:
{ "id": "6408d42fef4b30e933647ab2", "name": "Nieuwe Applicatie", "type": { "id": "6194ee942e86804e0c21c638", "name": "Applicatiecomponent", "name_internal": "application_component", "category": "Applicationlayer", "category_internal": "application_layer", "color": "#1EAAF0" }, "status": 0, "object_properties": [ { "name": "Naam", "value": "" }, { "name": "Leverancier", "value": "AWS" } ], "related_boem": [ { "id": "6409d89638102b8f57abab3e", "name": "Applicatie Vragenlijst" } ]}