Workflow

A workflow.

Create a workflow

Create a new workflow.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing workflow information.

name
required
string <= 1000 characters

The name of the workflow.

start_time_tolerance_yellow
required
integer [ 0 .. 365 ]

The start time tolerance for a yellow traffic light of the workflow.

The value must be smaller or equal to the start time tolerance for a red traffic light.

start_time_tolerance_red
required
integer [ 0 .. 365 ]

The start time tolerance for a red traffic light of the workflow.

The value must be greater or equal to the start time tolerance for a yellow traffic light.

start_time_tolerance_started
integer or null [ 0 .. 365 ]
Default: 7

The start time tolerance for a started traffic light of the workflow.

Responses
201

Successful operation

422

Unprocessable Content

post/workflow
Request samples
application/json
{
  • "name": "Workflow",
  • "start_time_tolerance_yellow": 3,
  • "start_time_tolerance_red": 7
}
Response samples
application/json
{
  • "success": true,
  • "hash": "f140676b990eaa35bfa144a106dd71ce8db5b092",
  • "data": {
    },
  • "timestamp": 1658150191119
}

Get all workflows

Get all workflows of the authenticated hub.

SecurityJWT
Request
query Parameters
page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

get/workflow
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "d735a4320167032e5609b5fdd4d9d2b8a0319f44",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1658150593104
}
Get a workflow
Get a workflow.


SecurityJWT 
Request 
path Parameters
workflow
required
string or integer
The id/hash of the workflow.


 
Responses 
200
Successful operation


404
Not Found


get/workflow/{workflow}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "f140676b990eaa35bfa144a106dd71ce8db5b092",
  • "data": {
    },
  • "timestamp": 1658151064975
}
Update a workflow
Update a workflow.


SecurityJWT 
Request 
path Parameters
workflow
required
string or integer
The id/hash of the workflow.


 
Request Body schema: application/json
A JSON object containing workflow information.


name
string  <= 1000 characters 
The name of the workflow.


 
start_time_tolerance_yellow
integer  [ 0 .. 365 ] 
The start time tolerance for a yellow traffic light of the workflow.
The value must be smaller or equal to the start time tolerance for a red traffic light.
 
start_time_tolerance_red
integer  [ 0 .. 365 ] 
The start time tolerance for a red traffic light of the workflow.
The value must be greater or equal to the start time tolerance for a yellow traffic light.
 
start_time_tolerance_started
integer or null  [ 0 .. 365 ] 
The start time tolerance for a started traffic light of the workflow.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/workflow/{workflow}
Request samples 
application/json
{
  • "name": "Workflow for Airborne",
  • "start_time_tolerance_yellow": 2,
  • "start_time_tolerance_red": 5,
  • "start_time_tolerance_started": 5
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8f4ce1298420da1d0b0dc299b0a3ebd32810c583",
  • "data": {
    },
  • "timestamp": 1658151442035
}
Delete a workflow
Delete a workflow.
Only workflows without assigned programs can be deleted. You will get a 403 Forbidden response if you try to delete a workflow with assigned programs.
SecurityJWT 
Request 
path Parameters
workflow
required
string or integer
The id/hash of the workflow.


 
Responses 
200
Successful operation


404
Not Found


delete/workflow/{workflow}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658151867173
}
Copy a workflow
Copy a workflow within the authenticated hub.


SecurityJWT 
Request 
path Parameters
workflow
required
string or integer
The id/hash of the workflow.


 
Responses 
200
Successful operation


404
Not Found


post/workflow/{workflow}/copy
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658152791402
}
Restore a workflow
Restore a workflow and all elements that have been deleted with the workflow.


SecurityJWT 
Request 
path Parameters
workflow
required
string or integer
The id/hash of the workflow.


 
Responses 
200
Successful operation


404
Not Found


put/workflow/{workflow}/restore
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658152742436
}
➔ Next to Workflow phase