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 voor het aanmaken van een nieuwe objectdefinitie. Wanneer er binnen een organisatie behoefte is om het conventiemodel uit te breiden, kan dit worden gedaan door een nieuwe definitie toe te voegen aan de repository.
Let op: Het is niet mogelijk om nieuwe BPMN-objectdefinities toe te voegen via de API.
HTTP-responses
HTTP response statuscode | Interpretatie |
201 OK | Objectdefinitie succesvol aangemaakt |
400 Bad Request | Eén of meer parameters ontbreken of zijn onjuist |
401 Unauthorized | Ongeldige of ontbrekende API-key secret en/of tenant |
403 Forbidden | De gebruiker mag deze objectdefinitie niet aanmaken |
Vereisten
Voordat je aan de slag kunt met objectdefinities, zorg ervoor dat de beschikbare objectsjablonen en hun ID's vooraf beschikbaar zijn.
Om nieuwe definities toe te kunnen voegen, heb je ook een lijst met rollen en hun ID's nodig. Selecteer vervolgens uit deze lijst de rollen die je wilt inschakelen voor een specifieke objectdefinitie. Om de lijst met beschikbare rollen en hun ID's te bekijken, gebruik je de SCIM-endpoint Get groups, waarbij groepen in SCIM gelijk staan aan rollen in BlueDolphin.
Om een nieuwe objectdefinitie aan te maken, doe je een POST-verzoek naar de /object-definitions-endpoint met daarin:
Bedrijfsmiddel/endpoint bestemmings-URL
De header voor je API-verzoek
De request body, die het volgende moet bevatten:
Parameter | Vereist | Type | Beschrijving |
name | ✓ | string | De naam van de objectdefinitie. Deze moet uniek zijn binnen de tenant en minimaal één en maximaal 256 tekens bevatten. |
object_template_id | ✓ | string | Unieke identificatie van het sjabloon waarop de definitie is gebaseerd. |
roles | ✓ | array | Een lijst met rol-ID's waarvoor de definitie is ingeschakeld. |
Hieronder vind je een voorbeeld van een API-verzoek om een nieuwe objectdefinitie aan te maken met de naam Nieuwe Applicatie van het sjabloontype Applicatiecomponent.
curl -L 'https://public-api.eu.bluedolphin.app/v1/object-definitions' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{ "name": "Nieuwe Applicatie", "object_template_id": "6194ff942e86804e0c21c649", "roles": [ "63f61f77d32a6efc5d8630a3", "63f61f77d32a6efc5d8630c6" ]}'Response-eigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie van de objectdefinitie |
name | string | De naam van de objectdefinitie |
type | object | Objecttype waarop de objectdefinitie is gebaseerd |
type[].id | string | Unieke identificatie van het objecttype |
type[].name | string | De naam van het objecttype |
type[].name_internal | string | De interne naam van het objecttype |
type[].category | string | De categorie van het objecttype |
type[].category_internal | string | De interne categorie van het objecttype |
type[].color | string | De hexadecimale kleurcode van de objectdefinitie of het object in lijsten en werksets. Bijvoorbeeld, de kleur blauw (#1EAAF0) wordt gebruikt voor de applicatielaag. |
status | number | De status van de objectdefinitie, die altijd 0 (ingeschakeld) is na aanmaak |
object_properties | array | Een lijst met objecteigenschappen |
object_properties[].name | string | De naam van de objecteigenschap |
object_properties[].value | string | De waarde van de objecteigenschap |
related_boem | array | Een lijst met gerelateerde objectvragenlijsten |
related_boem[].id | string | Unieke identificatie van de gerelateerde objectvragenlijst |
related_boem[].name | string | De naam van de gerelateerde objectvragenlijst |
Een geslaagde call geeft een response terug met een 201 OK HTTP-statuscode en de volgende body:
{ "id": "64a42dc72539a230838f9d22", "name": "Nieuwe Applicatie", "type": { "id": "6194ff942e86804e0c21c649", "name": "Applicatiecomponent", "name_internal": "application_component", "category": "Applicatielaag", "category_internal": "application_layer", "color": "#1EAAF0" }, "status": 0, "object_properties": [ { "name": "Naam", "value": "" } ], "related_boem": []}
Er is nu een nieuwe objectdefinitie aangemaakt met het id 64a42dc72539a230838f9d22.
De response bevat ook de location response header die de URL aangeeft van de zojuist aangemaakte objectdefinitie. Dus, de location header voor het bovenstaande voorbeeld zou zijn: http://public-api.eu.bluedolphin.app/v1/object-definitions/64a42dc72539a230838f9d22.