# Workflow list

API call format

GET /workflows

Description

Get all available workflows. We may check all available for the current users workflows with no parameters.

Precondition:

  • Authorization token is needed.
  • Mandatory elements (should be specified):
    • We have existing workflows.

Postcondition:

  • On success response code should be 200
  • On success all workflows with their details will be returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/workflows
[Request Headers] {"Content-Type":"application/json","Accept":"application/json",...}
[Page] https://<base_api_url>/workflows
[Response] 200
[Request Cookies] []
[Response Headers] {"Content-Type":["application/json"],...]}
[Response] 
{
  "items": [
    {
      "id": "<workflow_id1>",
      "name": "RTMP push input with Youtube/Facebook/Twitch RTMP output",
      "description": "RTMP push input with Youtube/Facebook/Twitch RTMP output",
      "channelStatus": "NOT_CREATED",
      "blueprintId": "<blueprint_id1>",
      "created": "2019-08-29T16:00:07Z",
      "everStarted": false //Flag indicating if a channel(workflow) is started in the past at least once
    },
    {
      "id": "<workflow_id2>",
      "name": "RTMP push input with Youtube/Facebook/Twitch RTMP output",
      "description": "RTMP push input with Youtube/Facebook/Twitch RTMP output",
      "blueprintId": "<blueprint_id2>",
      "channelStatus": "Running",
      "created": "2019-08-29T17:38:22Z",
      "everStarted": true //Flag indicating if a channel(workflow) is started in the past at least once
    },
    .......
  ]
}

We get a list with all available workflows and corresponding channel status.