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 new workflow.
start_time_tolerance_yellow required	integer [ 0 .. 365 ] The start time tolerance for a yellow traffic light of the new 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 new 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 new workflow.

Responses

201

Successful operation

422

Unprocessable Content

post/workflow

Request samples

Payload
curl

application/json

{"name": "Workflow",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7
}

Response samples

application/json

{"success": true,
"hash": "f140676b990eaa35bfa144a106dd71ce8db5b092",
"data": {"id": 72,
"hash": "d016f0cee35b7dddc5b6691de4c4c083a96e6beb",
"name": "Workflow",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7,
"start_time_tolerance_started": 7,
"created_time": "2022-07-18T13:16:31.000000Z",
"modified_time": "2022-07-18T13:16:31.000000Z",
"modified_user_time": "2022-07-18T13:16:31.000000Z",
"model": "Workflow",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1658150191119
}

Get all workflows

Get all workflows of the authenticated hub.

SecurityJWT

Responses

200

Successful operation

401

Unauthorized

get/workflow

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "d735a4320167032e5609b5fdd4d9d2b8a0319f44",
"data": [{"id": 1,
"hash": "36324e5b988caef7338b14f841f922956d433c17",
"name": "Airborne (Default)",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7,
"start_time_tolerance_started": 7,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"programs_count": 1,
"model": "Workflow",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
{"id": 72,
"hash": "d016f0cee35b7dddc5b6691de4c4c083a96e6beb",
"name": "Workflow",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7,
"start_time_tolerance_started": 7,
"created_time": "2022-07-18T13:16:31.000000Z",
"modified_time": "2022-07-18T13:16:31.000000Z",
"modified_user_time": "2022-07-18T13:16:31.000000Z",
"programs_count": 0,
"model": "Workflow",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
}
],
"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

curl

Response samples

application/json

{"success": true,
"hash": "f140676b990eaa35bfa144a106dd71ce8db5b092",
"data": {"id": 72,
"hash": "d016f0cee35b7dddc5b6691de4c4c083a96e6beb",
"name": "Workflow",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7,
"start_time_tolerance_started": 7,
"created_time": "2022-07-18T13:16:31.000000Z",
"modified_time": "2022-07-18T13:16:31.000000Z",
"modified_user_time": "2022-07-18T13:16:31.000000Z",
"model": "Workflow",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1658151064975
}

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

Payload
curl

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": {"id": 72,
"hash": "d016f0cee35b7dddc5b6691de4c4c083a96e6beb",
"name": "Workflow for Airborne",
"start_time_tolerance_yellow": 2,
"start_time_tolerance_red": 5,
"start_time_tolerance_started": 5,
"created_time": "2022-07-18T13:16:31.000000Z",
"modified_time": "2022-07-18T13:37:22.000000Z",
"modified_user_time": "2022-07-18T13:37:22.000000Z",
"model": "Workflow",
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1658151442035
}

Delete a workflow

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

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1658151867173
}

Copy a workflow

Copy a workflow.

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

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1658152791402
}

Restore a workflow

Restore a 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

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1658152742436
}

➔ Next to Workflow phase