Update And Trigger Flow¶
Trigger workflow scheduling with updated parameters (the information of the original workflow is not changed; the updated parameters are only used to generate a workflow instance).
Prerequisites¶
The user must be the owner of the workflow.
Both the user and the workflow are not locked.
Request Format¶
POST https://{apigw-address}/batch-processing-service/v2.1/flows
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|---|
userId |
Query |
Mandatory |
String |
The user ID. How to get userId>> |
orgId |
Query |
Mandatory |
String |
The organization ID which the user belongs to. How to get orgId>> |
action |
Query |
Mandatory |
String |
Fixed value: updateAndTrigger |
Request Parameters (Body)¶
Name |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
flowId |
Mandatory |
Integer |
The workflow ID. |
triggerTime |
Mandatory |
Long |
Specify the trigger time of the workflow, keeping in mind the following rules:
|
parameters |
Mandatory |
Map |
The global parameters that are configured for the workflow to dynamically adapt to the environment changes (in the format of key=value). For more information, see Setting Parameters for a Workflow or SHELL-type of Task>> |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
FlowInstanceId Struct |
The details of a workflow instance. For more information, see FlowInstanceId Struct |
Error Code¶
Code |
Message |
Description |
---|---|---|
62104 |
This workflow has no task. You cannot trigger it. |
The workflow does not have any task for you to trigger. |
62109 |
Internal server exception |
Internal server exception. |
For other error codes, see Common Error Codes.
Samples¶
Request Sample¶
url: https://{apigw-address}/batch-processing-service/v2.1/ flows?action=updateAndTrigger&userId=yourUserId&orgId=yourOrgId
method: POST
{
"flowId":3377,
"triggerTime":1574385824000,
"parameters":[{"key":"REPLACE","value":"ddee"}]
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"data": {
"flowInstanceId": "2791-19700101000000"
}
}
SDK Samples¶
You can access the SDK samples for batch data processing service on GitHub: