Returns information about the workflow with the specified identifier, including its name, description, current status and timestamps for when it was created and last updated.

curl --request GET \
  --url https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "IPTV&Multiscreen",
  "description": "This workflow is producing multiple outputs - one CableLabs compliant and MP4 proxy",
  "id": "e3c908ad-dc8f-4edb-88f7-c84dec0aef99",
  "created_at": "2020-01-21T15:53:12.388317Z",
  "updated_at": "2020-01-22T15:53:12.182617Z",
  "status": "idle"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "pointer": "/max_results",
      "type": "invalid_value",
      "detail": "max_results must be between 1 and 100."
    }
  ],
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

GET

{space_id}

workflows

{workflow_id}

Returns information about the workflow with the specified identifier, including its name, description, current status and timestamps for when it was created and last updated.

curl --request GET \
  --url https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "IPTV&Multiscreen",
  "description": "This workflow is producing multiple outputs - one CableLabs compliant and MP4 proxy",
  "id": "e3c908ad-dc8f-4edb-88f7-c84dec0aef99",
  "created_at": "2020-01-21T15:53:12.388317Z",
  "updated_at": "2020-01-22T15:53:12.182617Z",
  "status": "idle"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "pointer": "/max_results",
      "type": "invalid_value",
      "detail": "max_results must be between 1 and 100."
    }
  ],
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

{
  "title": "Not Found",
  "status": 404,
  "trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "type": "about:blank",
  "detail": "An unexpected error occurred",
  "instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}

Authorizations

Authorization

string

header

required

Static API key passed as a Bearer token in the Authorization header. Each operation requires one of the scopes workflow:access, workflow:workflow-management or workflow:admin (a hierarchy — admin implies management implies access), declared per operation via the x-required-scope extension. A key lacking the required scope receives 401 Unauthorized; 403 Forbidden indicates the organization's subscription is inactive.

Path Parameters

workflow_id

string<uuid>

required

Unique identifier of a Workflow

Example:

"e3c908ad-dc8f-4edb-88f7-c84dec0aef99"

space_id

string<uuid>

required

UP Space Id

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

Response

Get particular Workflow Details

name

string

Workflow name

Example:

"IPTV&Multiscreen"

description

string

read-only

Describes the Workflow purpose

Example:

"This workflow is producing multiple outputs - one CableLabs compliant and MP4 proxy"

string

read-only

This is the GUID for the Workflow

Example:

"e3c908ad-dc8f-4edb-88f7-c84dec0aef99"

created_at

string<date-time>

read-only

Timestamp when Workflow was created in the Cloud service UTC time in iso8601 format

Example:

"2020-01-21T15:53:12.388317Z"

updated_at

string<date-time>

read-only

Timestamp when Workflow was updated in the Cloud service UTC time in iso8601 format

Example:

"2020-01-22T15:53:12.182617Z"

status

enum<string> | null

read-only

Available options:

idle,

active,

archived,

deleted,

invalid

AccessCheck

workflow

job

Returns information about the workflow with the specified identifier, including its name, description, current status and timestamps for when it was created and last updated.

Authorizations

Path Parameters

Response