# channel Details

API call format

GET /channels/{<workflow_id>}/

Description

Gets the state of a channel bound to an existing workflow (<workflow_id>). The intermediate states we may get during a poll to the state of a channel are:

  • CREATING
  • CREATED
  • RUNNING

Precondition

  • Authorization token is needed.
  • Mandatory elements (should be specified):

Postcondition

  • On success response code should be 200
  • On success the current channel status will be returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/channels/<workflow_id>
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"}
[Page] https://<base_api_url>/channels
[Response] 200
[Request Cookies] []
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["28"],"Connection":["keep-alive"],....} 
[Response] 
{
    "channelStatus":"CREATED"
}

Hints:
To poll a state of a channel we have to use GET /channels/{<workflow_id>}.