HTTP API

FSM

GET/api/v1/fsm/definitions

List_definitions

GET
/api/v1/fsm/definitions

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Query Parameters

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64
Range0 <= value
page_size?integer

Page size

Formatint64
Range0 <= value
sort_by?string

Sort field (created_at, name, state_count)

sort_order?string

Sort order (asc or desc)

Value in

  • "asc"
  • "desc"
filter?array<string>

Additional filter expressions in the form field:operator:value

Response Body

application/json

curl -X GET "https://example.com/api/v1/fsm/definitions"
{  "definitions": [    {      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "initial_state": "string",      "name": "string",      "state_count": 0,      "updated_at": "2019-08-24T14:15:22Z",      "version": 0    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}
GET/api/v1/fsm/definitions/{fsm_name}

Get_definition

GET
/api/v1/fsm/definitions/{fsm_name}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

Query Parameters

format?string

Output format. Use mermaid to render the definition as a Mermaid diagram.

Response Body

application/json

curl -X GET "https://example.com/api/v1/fsm/definitions/string"
{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "initial_state": "string",  "name": "string",  "states": {    "property1": {      "allows": [        "string"      ],      "metadata": null,      "timeout": null    },    "property2": {      "allows": [        "string"      ],      "metadata": null,      "timeout": null    }  },  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}
POST/api/v1/fsm/definitions/{fsm_name}

Create_definition

POST
/api/v1/fsm/definitions/{fsm_name}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/fsm/definitions/string" \  -H "Content-Type: application/json" \  -d '{    "initial_state": "string",    "states": {      "property1": {        "allows": [          "string"        ]      },      "property2": {        "allows": [          "string"        ]      }    }  }'
{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "initial_state": "string",  "name": "string",  "states": {    "property1": {      "allows": [        "string"      ],      "metadata": null,      "timeout": null    },    "property2": {      "allows": [        "string"      ],      "metadata": null,      "timeout": null    }  },  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}
DELETE/api/v1/fsm/definitions/{fsm_name}

Delete_definition

DELETE
/api/v1/fsm/definitions/{fsm_name}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

Response Body

curl -X DELETE "https://example.com/api/v1/fsm/definitions/string"
Empty
POST/api/v1/fsm/definitions/{fsm_name}/bulk-transition

Bulk_transition

POST
/api/v1/fsm/definitions/{fsm_name}/bulk-transition

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/fsm/definitions/string/bulk-transition" \  -H "Content-Type: application/json" \  -d '{    "entity_ids": [      "string"    ],    "to": "string"  }'
{  "failed": 0,  "results": [    {      "entity_id": "string",      "error": "string",      "from": "string",      "success": true,      "to": "string"    }  ],  "successful": 0,  "total": 0}
POST/api/v1/fsm/definitions/{fsm_name}/bulk-transition-items

Bulk_transition_items

POST
/api/v1/fsm/definitions/{fsm_name}/bulk-transition-items

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/fsm/definitions/string/bulk-transition-items" \  -H "Content-Type: application/json" \  -d '{    "transitions": [      {        "entity_id": "string",        "to": "string"      }    ]  }'
{  "failed": 0,  "results": [    {      "entity_id": "string",      "error": "string",      "from": "string",      "success": true,      "to": "string"    }  ],  "successful": 0,  "total": 0}
GET/api/v1/fsm/definitions/{fsm_name}/dead-letter

Get_dead_letter

GET
/api/v1/fsm/definitions/{fsm_name}/dead-letter

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

Query Parameters

limit?integer

Maximum number of dead-letter entries to return

Range0 <= value

Response Body

application/json

curl -X GET "https://example.com/api/v1/fsm/definitions/string/dead-letter"
{  "entries": [    {      "entity_id": "string",      "error": "string",      "failed_at": 0,      "from_state": "string",      "fsm_name": "string",      "retries": 0,      "to_state": "string",      "version": 0    }  ],  "total": 0}
GET/api/v1/fsm/definitions/{fsm_name}/entities

List_entities

GET
/api/v1/fsm/definitions/{fsm_name}/entities

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

Query Parameters

state?string

Filter by current state name

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64
Range0 <= value
page_size?integer

Page size

Formatint64
Range0 <= value
sort_by?string

Sort field (created_at, updated_at, version, transition_count)

sort_order?string

Sort order (asc or desc)

Value in

  • "asc"
  • "desc"

Response Body

application/json

curl -X GET "https://example.com/api/v1/fsm/definitions/string/entities"
{  "entities": [    {      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "current_state": "string",      "entity_id": "string",      "transition_count": 0,      "updated_at": "2019-08-24T14:15:22Z",      "version": 0    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}
GET/api/v1/fsm/definitions/{fsm_name}/entities/{entity_id}

Get_entity_state

GET
/api/v1/fsm/definitions/{fsm_name}/entities/{entity_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

entity_id*string

Entity ID

Response Body

application/json

curl -X GET "https://example.com/api/v1/fsm/definitions/string/entities/string"
{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "current_state": "string",  "entity_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}
POST/api/v1/fsm/definitions/{fsm_name}/entities/{entity_id}

Transition

POST
/api/v1/fsm/definitions/{fsm_name}/entities/{entity_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

entity_id*string

Entity ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/fsm/definitions/string/entities/string" \  -H "Content-Type: application/json" \  -d '{    "to": "string"  }'
{  "entity_id": "string",  "error": "string",  "from": "string",  "fsm_name": "string",  "message": "string",  "success": true,  "to": "string",  "transition_id": "string"}
DELETE/api/v1/fsm/definitions/{fsm_name}/entities/{entity_id}

Delete_entity

DELETE
/api/v1/fsm/definitions/{fsm_name}/entities/{entity_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

entity_id*string

Entity ID

Response Body

curl -X DELETE "https://example.com/api/v1/fsm/definitions/string/entities/string"
Empty
GET/api/v1/fsm/definitions/{fsm_name}/entities/{entity_id}/history

Get_entity_history

GET
/api/v1/fsm/definitions/{fsm_name}/entities/{entity_id}/history

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

entity_id*string

Entity ID

Query Parameters

limit?integer
Range0 <= value

Response Body

application/json

curl -X GET "https://example.com/api/v1/fsm/definitions/string/entities/string/history"
{  "events": [    {      "actor": "string",      "context": null,      "entity_id": "string",      "from": "string",      "timestamp": "2019-08-24T14:15:22Z",      "to": "string",      "transition_id": "string",      "version": 0    }  ]}
GET/api/v1/fsm/definitions/{fsm_name}/metrics

Get_metrics

GET
/api/v1/fsm/definitions/{fsm_name}/metrics

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

fsm_name*string

FSM definition name

Response Body

application/json

curl -X GET "https://example.com/api/v1/fsm/definitions/string/metrics"
{  "dead_letter_count": 0,  "entities_by_state": {    "property1": 0,    "property2": 0  },  "total_entities": 0,  "transitions_last_24h": 0,  "transitions_last_hour": 0}

Form

Schema-backed form intake and submissions

Geo

Geospatial location and proximity queries

On this page

List_definitionsGet_definitionCreate_definitionDelete_definitionBulk_transitionBulk_transition_itemsGet_dead_letterList_entitiesGet_entity_stateTransitionDelete_entityGet_entity_historyGet_metrics