Start Video Process Workflow

Last update:2023-02-27 15:18:39

Description

This API allows you to process specified videos according to the defined workflow.

Request Description

Request method POST
API URL https://api.cloudv.haplat.net/workflow/startWorkflow
Require Authentication Yes

Request Parameter

Parameter Type Required Description
targetId string Yes Video ID
transNo string Yes This is a globally unique transaction ID and it is used to identify a workflow. It is recommended to use UUID as the transNO.
workflowId string Yes Workflow ID

Response

Parameter Type Required Description
id string Yes Workflow ID

Example

Input Example

curl -X POST 
 http://api.cloudv.haplat.net/workflow/startWorkflow 
 -H 'content-type: application/json; charset=utf-8' 
 -H "Host: api.cloudv.haplat.net" 
 -H "Authorization: your token" 
 -H "X-WS-Timestamp: current timestamp" 
 -H "X-WS-AccessKey: your AccessKey ID"
 -d '{"targetId":"1","transNo":"2","workflowId":"3"}'

For common responses, please refer to Common Parameters.

Output Example

Success:

{"id":"123"}

Fail:

{"code":1000,"message":"Parameter error"}

Error Code

The following error codes are specific to Start Video Process Worklow request. For common errors, see Common Responses.

Error code Description
300 Operation failed
1000 Invalid Parameter
1301 No permission
1630 transNo repeat
Is the content of this document helpful to you?
Yes
I have suggestion
Submitted successfully! Thank you very much for your feedback, we will continue to strive to do better!