Starting or Stopping Tasks in Batches

This API is used to start or stop tasks in batches.

POST /v2/{project_id}/fdi/instances/{instance_id}/batch-operation/tasks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.
instance_id	Yes	String	Instance ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action_id	Yes	String	Operation type. start stop
list	No	Array of TaskBean objects	IDs of tasks to be started or stopped. The maximum length of the list array is 10.

**Table 4** TaskBean
Parameter	Mandatory	Type	Description
task_id	No	String	Task ID. This parameter can be left empty.

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
success_count	Integer	Success count.
failure_count	Integer	Failure count.
failure	Array of TaskBeanFacade objects	Failure details.
success	Array of TaskBeanFacade objects	Information about successful tasks.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Start data integration tasks in batches.

{
  "action_id" : "start",
  "list" : [ {
    "task_id" : "49460e99d597464d885f871dd6acc894"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "FDI.3150",
  "error_msg" : "The task list is empty."
}

Status code: 404

Not Found

{
  "error_code" : "FDI.3083",
  "error_msg" : "One or more scheduled tasks are not configured with scheduled plans."
}

Parent topic: Task Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.