Help Center> ROMA Connect> API Reference> FDI APIs> Task Management> Querying Mappings of Combined Tasks

Querying Mappings of Combined Tasks

Function

Query mappings of combined tasks.

URI

GET /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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records displayed on each page in pagination query. The maximum value is 1000.

Minimum: 0

Maximum: 1000

offset

No

Integer

Offset of pagination in pagination query. The query starts from this offset. If the offset is less than 0, the value is automatically converted to 0.

Minimum: 0

Maximum: 20000

source_datasource_id

No

String

Source data source ID.

Minimum: 1

Maximum: 64

target_datasource_id

No

String

Destination data source ID.

Minimum: 1

Maximum: 64

source_table

No

String

Source table name.

Minimum: 1

Maximum: 64

target_table

No

String

Destination table name.

Minimum: 1

Maximum: 64

table_name

No

String

Source or destination table name.

Minimum: 1

Maximum: 64

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

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_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 4 ext_info

Parameter

Type

Description

server_id

String

MySQL server ID.

Minimum: 1

Maximum: 20

Table 5 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 ColumnInfo objects

Source field list.

target_columns

Array of ColumnInfo objects

Destination field list.

mapping

Array of MappingInfo objects

Field mapping list.

Table 6 ColumnInfo

Parameter

Type

Description

field_name

String

Field name.

Minimum: 1

Maximum: 256

field_type

String

Field type.

Minimum: 1

Maximum: 256

field_length

Integer

Field length.

Minimum: 0

Maximum: 10000000

Table 7 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

Integer

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

Integer

Destination field length.

Minimum: 0

Maximum: 10000000

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

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.