Enable Flow

Start the scheduling of a specified workflow.

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: enable

Request Parameters (Body)

Name Mandatory/Optional Data Type Description
flowId Mandatory Integer The workflow ID.

Response Parameters

Name Data Type Description
data String No results will be returned if the request is successful.

Error Code

See Common Error Codes.

Samples

Request Sample

url: https://{apigw-address}/dataflow-batch-service/v2.0/flows?action=enable&userId=yourUserId&orgId=yourOrgId
method: POST
requestBody:
{
  "flowId": 3377
}

Return Sample

{
  "status": 0,
  "msg": " Success",
  "data": ""
}

SDK Samples


You can access the SDK samples for batch processing service on GitHub: