ioio.tv APIs

# channels Runs List

API call format

GET /channels/{id}/runs

Description

Get a list of all channels running. We should pass corresponding <workflow_id> mandatory parameter. The returned JSON gives information when a channel is created and get running.

Precondition

  • Authorization token is needed.
  • Mandatory elements (should be specified):
    • <workflow_id> - valid workflow id. Take a workflow id using Workflow List API call.
    • We have existing workflow channels.
    • We have existing 1 or more workflow channels with status RUNNING..

Postcondition

  1. On success response code should be 200
  2. On success all RUNNING workflow channels with details will be returned.
  3. On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/channels/<workflow_id>/runs
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"}
[Response]200
[Request Cookies] []
[Response Headers] {"Content-Type":["application/json"],"Connection":["keep-alive"],....} 
[Response] 
{
  "items": [
    {
      "requested": "2019-08-28T13:45:07.394Z", //channel creation time
      "started": "2019-08-28T13:46:46.59Z",    //channel running time
      "failed": false,                         //failure status 
      "fileSize": 0                            //Arhive file size    
    }
  ]
}

← Channel Delete →