Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Creating a Composite Task
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Composite Task

Function

Create a composite task.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/multi-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 API Reference.

instance_id

Yes

String

Instance ID.

Request Parameters

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

task_name

Yes

String

Task name. The value contains 3 to 100 characters, consisting of only letters, digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter or digit.

task_id

No

String

Task ID. This parameter can be left empty.

task_type

No

String

Task type. Currently, composite tasks support only real-time tasks.

  • REALTIME (real-time)

  • TIMING (scheduled)

description

No

String

Description.

task_tag

No

String

Task tag, which can contain only letters, digits, hyphens (-), and underscores (_).

operation_types

Yes

Array of strings

Operation type to be supported. You can select multiple operation types. At least one of the following operation types must be selected:

  • INSERT

  • UPDATE

  • DELETE

source_app_id

No

String

ID of the integration application to which the source data source belongs.

target_app_id

No

String

ID of the integration application to which the destination data source belongs.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_id

String

Task ID. This parameter can be left empty.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Create a real-time composite data integration task with the insert, update, and delete operations.

{
  "task_name" : "cdctest1",
  "task_id" : "a9fe65f41****6a5d646477c52",
  "task_type" : "REALTIME",
  "description" : "create",
  "task_tag" : "combination",
  "operation_types" : [ "INSERT", "UPDATE", "DELETE" ],
  "source_app_id" : "d5afd9af-a8fe-47f6-a98c-edbcba11a0da",
  "target_app_id" : "d5afd9af-a8fe-47f6-a98c-edbcba11a0da"
}

Example Responses

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."
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Task Management