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 nieuw object aan te maken in je repository.
HTTP-responses
HTTP response status code | Interpretatie |
201 Created | Object succesvol aangemaakt |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
400 Bad Request | Eén of meer parameters ontbreken of zijn onjuist. De response body geeft een specifieke foutmelding terug. Bijvoorbeeld: 'object_type_id is incorrect'. |
403 Forbidden | De gebruiker mag geen objecten van dit type aanmaken |
Voorwaarden
Om een object van een specifiek objecttype aan te maken, moet je rechten hebben voor die objectdefinitie
De combinatie van
object_title,object_type_idenworkspace_idmoet uniek zijn
Om een nieuw object aan te maken, doe je een POST-verzoek naar de /objects endpoint met daarin:
Resource/endpoint bestemmings-URL
De header voor je API-verzoek
De request body, die het volgende moet bevatten:
Parameter | Vereist | Type | Beschrijving |
object_title | ✓ | string | De naam van het object dat je wilt aanmaken. |
object_type_id | ✓ | string | Unieke identificatie voor de objectdefinitie waarop het object gebaseerd wordt. Op te halen via de objectdefinities API. |
object_lifecycle_state | X | string | De lifecycle status kan Huidig of Toekomstig zijn. De standaardwaarde is huidig. |
workspace_id | ✓ | string | Workspace waarin het object wordt geplaatst. |
Hieronder vind je een voorbeeld van een API-verzoek om een nieuw object aan te maken met de naam HiBob van de objectdefinitie Applicatie:
curl -L 'https://public-api.eu.bluedolphin.app/v1/objects' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{ "object_title": "HiBob", "object_type_id": "640b3d7d4a28b925fcf8b8bc", "workspace_id": "63f620763279a10a8eefa7b0"
"object_lifecycle_state": "Future"}'
Een geslaagde call geeft een response terug met een 201 OK HTTP-statuscode en de volgende body:
{ "id": "644779a07470b332c82b8dg0", "object_title": "HiBob"}
Er is nu een nieuw object aangemaakt met het id 644779a07470b332c82b8dg0.
De response bevat ook de location response header die de URL aangeeft van het nieuw aangemaakte object. Dus, de location header voor het bovenstaande voorbeeld zou zijn: http://public-api.eu.bluedolphin.app/v1/objects/644779a07470b332c82b8dg0.