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) objectdefinities op te halen. Deze endpoint wordt gebruikt om de lijst van (alle) beschikbare objectdefinities in de repository op te halen, samen met hun eigenschappen.
HTTP-responses
HTTP response statuscode | Interpretatie |
200 OK | Objectdefinities succesvol opgehaald |
400 Bad Request | Eén of meer parameters ontbreken of zijn onjuist. De response body geeft een specifieke foutmelding terug. Bijvoorbeeld: 'take' is groter dan of gelijk aan '0' vereist. |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
403 Forbidden | De gebruiker mag deze objectdefinities niet ophalen |
Om de lijst met objectdefinities op te halen, doe je een GET-verzoek naar de /object-definitions endpoint met de volgende specificaties:
Resource/endpoint bestemmings-URL. Je kunt ervoor kiezen om een verzoek te sturen voor een volledige lijst, of optioneel parameters instellen in de request-URI om een gefilterde lijst van definities op te halen.
Parameter | Vereist | Type | Standaard | Beschrijving |
start | X | number | 0 | Haal objectdefinities op vanaf deze waarde |
take | X | number | 100 | Het aantal objectdefinities dat wordt teruggegeven |
include_disabled | X | boolean | false | Als de waarde “false” is, bevat de response alleen actieve objectdefinities. Als de waarde “true” is, bevat de response zowel actieve als uitgeschakelde objectdefinities. |
De header voor je API-verzoek
Om de gefilterde lijst van zowel actieve als uitgeschakelde objectdefinities op te halen, waarbij we de eerste 10 vanaf 0 ophalen, stuur je een GET-verzoek naar de URI https://public-api.eu.bluedolphin.app/v1/object-definitions?take=10&start=0&include_disabled=true.
curl -L 'https://public-api.eu.bluedolphin.app/v1/object-definitions?take=10&start=1&include_disabled=true' \-H 'tenant: yourtenantname' \-H 'x-api-key: YOURAPIKEYSECRET'
Response-eigenschappen
Eigenschap | Type | Beschrijving |
total_items | number | Het totale aantal objectdefinities |
items | array | Een lijst met de opgevraagde objectdefinities |
items[].id | string | Unieke identificatie voor de objectdefinitie |
items[].name | string | De naam van de objectdefinitie |
items[].type | object | Informatie over het objecttype waarop de objectdefinitie is gebaseerd. Geeft het uitgebreide type terug, inclusief categorie, category_internal en kleur. |
Een succesvol verzoek geeft een response met een 200 OK HTTP-statuscode en de volgende body:
{ "total_items": 24, "items": [ { "id": "59f855d6ec9d263f70d7ab80", "name": "Application Collaboration", "type": { "id": "54abdbf6c3aef5e1b9fb17b3", "name": "Application Collaboration", "name_internal": "application_collaboration", "category": "Applicationlayer", "category_internal": "application_layer", "color": "#1EAAF0" } }, { "id": "532eeed0b41281c17ce263b9", "name": "Application Component", "type": { "id": "6194ee942e86804e0c21c638", "name": "Application Component", "name_internal": "application_component", "category": "Applicationlayer", "category_internal": "application_layer", "color": "#1EAAF0" } }, { "id": "532eee94b41281c17ce263b7", "name": "Application Function", "type": { "id": "532eee94b41281c17ce263b7", "name": "Application Function", "name_internal": "application_function", "category": "Applicationlayer", "category_internal": "application_layer", "color": "#1EAAF0" } }, { "id": "53ce28d1f04ebf0160572211", "name": "Application Service", "type": { "id": "53ce28d1f04ebf0160572211", "name": "Application Service", "name_internal": "application_service", "category": "Applicationlayer", "category_internal": "application_layer", "color": "#1EAAF0" } }, { "id": "53ce2981f04ebf0160531233", "name": "Artifact", "type": { "id": "53ce2981f04ebf0160531233", "name": "Artifact", "name_internal": "artifact", "category": "Technologylayer", "category_internal": "technology_layer", "color": "#48b220" } }, { "id": "5d25c54b0c0ba6e79c12e7cb", "name": "Business Actor", "type": { "id": "5d25c5530c0ba6e79c12e7d5", "name": "Business Actor", "name_internal": "business_actor", "category": "Businesslayer", "category_internal": "business_layer", "color": "#FCC13D" } }, { "id": "5d25c4940c0cf6f25c01872e", "name": "Business Collaboration", "type": { "id": "5d25c49b0c0ef6f25c018738", "name": "Business Collaboration", "name_internal": "business_collaboration", "category": "Businesslayer", "category_internal": "business_layer", "color": "#FCC13D" } }, { "id": "5d25cbe70c0ba6e79c23d41b", "name": "Business Event", "type": { "id": "5d25cbee0c0ba6e79c23d425", "name": "Business Event", "name_internal": "business_event", "category": "Businesslayer", "category_internal": "business_layer", "color": "#FCC13D" } }, { "id": "5d25c5123c0ba6e79c23defa", "name": "Business Function", "type": { "id": "5d25c6262c0ba6e79c23df04", "name": "Business Function", "name_internal": "business_function", "category": "Businesslayer", "category_internal": "business_layer", "color": "#FCC13D" } }, { "id": "5d25be6e1c0ba6f25c017a84", "name": "Business Interaction", "type": { "id": "5d25be681c0ba6e79c23d40c", "name": "Business Interaction", "name_internal": "business_interaction", "category": "Businesslayer", "category_internal": "business_layer", "color": "#FCC13D" } } ]}