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

Creating Combined Task Mappings

Function

Create combined task mappings.

URI

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

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

task_id

Yes

String

Task ID, the unique identifier of a task.

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, only server_id is supported.

source_datasource_id

Yes

String

Source data source ID. This parameter cannot be left empty.

Minimum: 1

Maximum: 64

target_datasource_id

Yes

String

Destination data source ID. This parameter cannot be left empty.

Minimum: 1

Maximum: 64

source_columns

No

Array of MultiTaskColumnInfo objects

Source field list.

target_columns

No

Array of MultiTaskColumnInfo objects

Destination field list.

source_table

No

String

Source table name.

Minimum: 1

Maximum: 64

target_table

No

String

Destination table name.

Minimum: 1

Maximum: 64

mapping_columns

No

Array of MappingInfo objects

Field mapping list.
Table 4 ext_info

Parameter

Mandatory

Type

Description

server_id

No

String

MySQL server ID. This parameter is mandatory when the data source is MySQL.

Minimum: 1

Maximum: 20
Table 5 MultiTaskColumnInfo

Parameter

Mandatory

Type

Description

field_name

No

String

Field name.

Minimum: 1

Maximum: 256

field_type

No

String

Field type.

Minimum: 1

Maximum: 256

field_length

No

String

Field length.

Minimum: 0

Maximum: 10000000
Table 6 MappingInfo

Parameter

Mandatory

Type

Description

source_column

No

String

Source field.

Minimum: 1

Maximum: 256

source_column_type

No

String

Source field type.

Minimum: 1

Maximum: 256

source_column_length

No

String

Source field length.

Minimum: 0

Maximum: 10000000

target_column

No

String

Destination field.

Minimum: 1

Maximum: 256

target_column_type

No

String

Destination field type.

Minimum: 1

Maximum: 256

target_column_length

No

String

Destination field length.

Minimum: 0

Maximum: 10000000

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

mapping_id

String

Unique ID of a mapping.

Minimum: 1

Maximum: 64

Status code: 400

Table 8 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 9 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 10 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

None

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