Get Service Workflows
This API endpoint allows you to retrieve a list of service workflows within your organisation, providing an overview of workflows and their associated details such as names, descriptions, and connections. By accessing this information, organisations can efficiently track, manage, and review workflows to ensure they align with operational needs. leveraging this feature supports improved oversight, fosters consistency across teams, and simplifies workflow management, making it a valuable tool for optimising processes.
Syntax: see 'CCall Structure
Type = 'GET'
|
'https://connect.cambrionix.com/api/workflows/v1/services/workflow-service-id/workflows' |
| Output | Description |
|---|---|
| workflow-service-id | This is the id of the workflow service as a unique 128-bit number |
Returns:
|
{ "id": "workflow-id", "name": "workflow-name", "description": "workflow-description", "events": "string", "connections": [ { "id": "unique-connection-id", "type": "connection-type", "from": { "id": "unique-event-id" }, "to": { "id": "unique-event-id" } } ], "enabled": option-status, "published": option-status, "organization": { "id": "organisation-id", "name": "organisation-name" } } |
| Output | Description |
|---|---|
| workflow-id | This is the id of the workflow as a unique 128-bit number |
| workflow-name | This is the name of the workflow |
| workflow-description | This is a description of the workflow |
| unique-connection-id | This is the id of a unique connection as a unique 128-bit number |
| connection-type | This is the type of connection e.g. success |
| unique-event-id | This is the id of a unique event as a unique 128-bit number |
| option-status | The status of the option (true/false) |
| organisation-id | This is the id of the organisation as a unique 128-bit number |
| organisation-name | This is the name of the organisation |
Example
curl -X 'GET' \
'https://connect.cambrionix.com/api/workflows/v1/services/00000000-0000-0000-0000-000000000000/workflows' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NijQ2MCIsInN1YTg'Returns
{
"result": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Turn ports off",
"description": "turn all ports to off mode",
"events": "string",
"connections": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "success",
"from": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"to": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
],
"enabled": true,
"published": true,
"organization": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Cambrionix Organisation"
}
}
]
}Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned