Trigger Flow¶
Manually trigger a workflow schedule.
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}/dataflow-batch-service/v2.0/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: trigger |
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:
|
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 | Server internal exception | Internal server exception. |
For other error codes, see Common Error Codes.