Last updated 1 month ago
Was this helpful?
Demo accounts are only available when the engine is running in development mode.
/info
curl -L \ --url '/info'
No body
/demo-accounts
curl -L \ --url '/demo-accounts'
/scenarios
curl -L \ --url '/scenarios' \ --header 'Authorization: Bearer jwt'
[ { "id": "text", "name": "text", "title": "text", "description": "text" } ]
curl -L \ --request POST \ --url '/scenarios' \ --header 'Authorization: Bearer jwt' \ --header 'Content-Type: application/json'
/scenarios/{id}
Scenario ID
application/json
application/yaml
curl -L \ --url '/scenarios/{id}' \ --header 'Authorization: Bearer jwt'
curl -L \ --request DELETE \ --url '/scenarios/{id}' \ --header 'Authorization: Bearer jwt'
/processes
List page (max 100 processes per page)
Also return processes where user is not an actor in (admin only)
curl -L \ --url '/processes' \ --header 'Authorization: Bearer jwt'
curl -L \ --request POST \ --url '/processes' \ --header 'Authorization: Bearer jwt' \ --header 'As-Actor: text' \ --header 'Content-Type: application/json' \ --data '{"scenario":"text","action":{},"actors":{"ANY_ADDITIONAL_PROPERTY":{"id":"text","title":"text","ANY_ADDITIONAL_PROPERTY":"anything"}}}'
/processes/{id}
Process ID
curl -L \ --url '/processes/{id}' \ --header 'Authorization: Bearer jwt'
/processes/{id}//{action}
Process action
Specify actor when multiple actors could have performed the action and actor cannot be determined based on the user
curl -L \ --request POST \ --url '/processes/{id}/{action}' \ --header 'Authorization: Bearer jwt' \ --header 'Content-Type: application/json'
/apikey
curl -L \ --url '/apikey' \ --header 'Authorization: Bearer jwt'
[ { "id": "text", "token": "text", "name": "text", "description": {}, "issued": "2025-02-22T08:29:17.464Z", "expirationDays": 1, "expiration": "2025-02-22T08:29:17.464Z", "lastUsed": "2025-02-22T08:29:17.464Z", "revoked": "2025-02-22T08:29:17.464Z", "privileges": "scenario:read", "processes": [ { "scenario": "123e4567-e89b-12d3-a456-426614174000", "actors": [ "text" ], "actions": [ "text" ] } ] } ]
curl -L \ --request POST \ --url '/apikey' \ --header 'Authorization: Bearer jwt' \ --header 'Content-Type: application/json' \ --data '{"name":"text","description":"text","privileges":["scenario:read"],"processes":[{"actors":[null],"actions":[null]}]}'
{ "id": "text", "token": "text", "name": "text", "description": {}, "issued": "2025-02-22T08:29:17.464Z", "expirationDays": 1, "expiration": "2025-02-22T08:29:17.464Z", "lastUsed": "2025-02-22T08:29:17.464Z", "revoked": "2025-02-22T08:29:17.464Z", "privileges": "scenario:read", "processes": [ { "scenario": "123e4567-e89b-12d3-a456-426614174000", "actors": [ "text" ], "actions": [ "text" ] } ] }
/apikey/{id}
curl -L \ --request DELETE \ --url '/apikey/{id}' \ --header 'Authorization: Bearer jwt'
