API ReferenceGuides
API Reference

Submit Workflow Job

post
https://api.cloud.telestream.net/vantage-cloud-port/v2.0/workflows//workflow-jobs

"Creates new Workflow Job. When Submitting job required are:"

  • sources within the input section; Endpoint will respond with 422 if that section is not defined
  • variables - Variables must be provided in order for a workflow to make use of them. Cloud workflows have no ability to obtain default values for variables after submission. Please ensure all variables that are provided in the REST request: /workflows/{workflow_id} are included in this POST request inorder for proper job processing.
  • storage_references - if default storage references are set on the workflow level and no storage references are provided in the request the default from workflow settings will be used. IMPORTANT: all of the storage references passed have to be within same provider and region.
Path Params
string
required

Unique identifier of a Workflow

Query Params
integer
Defaults to 1
Body Params
string

Workflow Job Name

inputs
object

Workflow Job Inputs

storage_references
object

Defines stores for all of the actions within the workflow; All of the stores are required to be selected from one provider & region; If otherwise the job would not be created as we are validating if all underlying store references are from the same region and cloud provider.

string
string
string

Arbitrary string stored along the workflow job - may serve as external reference

integer | null

Workflow Revision to process this job, if empty will use default one.

Responses

Updated 11 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago