Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Initializing the Combined Task
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Initializing the Combined Task

Function

Initialize the combined task, assign task IDs, and initialize mappings.

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/multi-tasks/init

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.

Minimum: 1

Maximum: 64

instance_id

Yes

String

Instance ID.

Minimum: 1

Maximum: 64

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

ext_info

No

ext_info object

Extended attribute. Currently, server_id is supported and can be left empty.

source_datasource_id

No

String

Data source ID at the source.

Minimum: 1

Maximum: 64

target_datasource_id

No

String

Data source ID at the destination.

Minimum: 1

Maximum: 64

task_id

No

String

Task ID. This parameter can be left empty. If it is left empty, a task ID is automatically assigned.

Minimum: 3

Maximum: 50

auto_mapping

No

Boolean

Whether to automatically create a mapping from the source to the destination.
Table 4 ext_info

Parameter

Mandatory

Type

Description

server_id

No

String

MySQL server ID.

Minimum: 1

Maximum: 20

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of MultiTaskInitElement objects

OK
Table 6 MultiTaskInitElement

Parameter

Type

Description

ext_info

ext_info object

Extended attribute. Currently, only server_id is supported.

task_id

String

Task ID.

Minimum: 1

Maximum: 64

source_datasource_id

String

Data source ID at the source.

Minimum: 1

Maximum: 64

target_datasource_id

String

Data source ID at the destination.

Minimum: 1

Maximum: 64

source_group

String

Source group.

Minimum: 1

Maximum: 64

target_group

String

Target group.

Minimum: 1

Maximum: 64

source_ds_id

String

Data source ID at the source.

Minimum: 1

Maximum: 64

target_ds_id

String

Data source ID at the destination.

Minimum: 1

Maximum: 64

source_instance_id

String

ID of the source instance.

Minimum: 1

Maximum: 64

target_instance_id

String

ID of the destination instance.

Minimum: 1

Maximum: 64

source_app_id

String

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

Minimum: 1

Maximum: 64

target_app_id

String

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

Minimum: 1

Maximum: 64

source_datasource_name

String

Name of the source data source.

Minimum: 1

Maximum: 64

target_datasource_name

String

Name of the destination data source.

Minimum: 1

Maximum: 64

source_datasource_type

String

Source data source type.

Minimum: 1

Maximum: 64

target_datasource_type

String

Destination data source type.

Minimum: 1

Maximum: 64

mappings

Array of MultiTaskMappingElement objects

Mapping list. Only the first 10 records are returned.

mappings_total_count

Integer

Total number of mappings.

Minimum: 0

Maximum: 1000000
Table 7 ext_info

Parameter

Type

Description

server_id

String

MySQL server ID.

Minimum: 1

Maximum: 20
Table 8 MultiTaskMappingElement

Parameter

Type

Description

id

String

Unique ID of a mapping.

Minimum: 1

Maximum: 64

source_table

String

Source table name.

Minimum: 1

Maximum: 256

target_table

String

Destination table name.

Minimum: 1

Maximum: 256

updated_time

Long

Time of last update.

Minimum: 1

Maximum: 9999999999999999999

mapping_percent

Integer

Matching percentage.

Minimum: 0

Maximum: 100

status

String

Mapping status.

  • AUTO

  • MANUAL

  • ADD

  • UPDATE

  • DELETE

  • USING

Minimum: 1

Maximum: 10

source_columns

Array of MultiTaskColumnInfo objects

Source field list.

target_columns

Array of MultiTaskColumnInfo objects

Destination field list.

mapping

Array of MappingInfo objects

Field mapping list.
Table 9 MultiTaskColumnInfo

Parameter

Type

Description

field_name

String

Field name.

Minimum: 1

Maximum: 256

field_type

String

Field type.

Minimum: 1

Maximum: 256

field_length

String

Field length.

Minimum: 0

Maximum: 10000000
Table 10 MappingInfo

Parameter

Type

Description

source_column

String

Source field.

Minimum: 1

Maximum: 256

source_column_type

String

Source field type.

Minimum: 1

Maximum: 256

source_column_length

String

Source field length.

Minimum: 0

Maximum: 10000000

target_column

String

Destination field.

Minimum: 1

Maximum: 256

target_column_type

String

Destination field type.

Minimum: 1

Maximum: 256

target_column_length

String

Destination field length.

Minimum: 0

Maximum: 10000000

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 404

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Example Requests

{
  "ext_info" : null,
  "source_datasource_id" : "30969b205e8f4392a25fb321112d1753",
  "target_datasource_id" : "30969b205e8f4392a25fb321112d1753",
  "task_id" : null,
  "auto_mapping" : false
}

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