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
| 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. |
| task_id | Yes | String | Task ID, the unique identifier of a task. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | Integer | Number of records displayed on each page in pagination query. The maximum value is 1000 and the minimum value is 1. |
| offset | No | Integer | Offset of pagination in pagination query. The query starts from this offset. |
| source_datasource_id | No | String | Source data source ID. |
| target_datasource_id | No | String | Destination data source ID. |
| source_table | No | String | Source table name. |
| target_table | No | String | Destination table name. |
| table_name | No | String | Source or destination table name. |
Request 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). |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| ext_info | ext_info object | Extended attribute. Currently, only server_id is supported. |
| task_id | String | Task ID. |
| source_datasource_id | String | Data source ID at the source. |
| target_datasource_id | String | Data source ID at the destination. |
| source_group | String | Source group. |
| target_group | String | Target group. |
| source_ds_id | String | Data source ID at the source. |
| target_ds_id | String | Data source ID at the destination. |
| source_instance_id | String | ID of the source instance. |
| target_instance_id | String | ID of the destination instance. |
| source_app_id | String | ID of the integration application to which the source data source belongs. |
| target_app_id | String | ID of the integration application to which the destination data source belongs. |
| source_datasource_name | String | Name of the source data source. |
| target_datasource_name | String | Name of the destination data source. |
| source_datasource_type | String | Source data source type. |
| target_datasource_type | String | Destination data source type. |
| mappings | Array of MultiTaskMappingElement objects | Mapping list. Only the first 10 records are returned. |
| schema_mappings | Array of MultiTaskSchemaMappingElement objects | Schema mappings. The first 10 records are returned. |
| mappings_total_count | Integer | Total number of mappings. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique ID of a mapping. |
| source_table | String | Source table name. |
| target_table | String | Destination table name. |
| updated_time | Long | Time of last update. |
| mapping_percent | Integer | Matching percentage. |
| status | String | Mapping status. |
| 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. |
| Parameter | Type | Description |
|---|---|---|
| field_name | String | Field name. |
| field_type | String | Field type. |
| field_length | String | Field length. |
| Parameter | Type | Description |
|---|---|---|
| source_column | String | Source field. |
| source_column_type | String | Source field type. |
| source_column_length | String | Source field length. |
| target_column | String | Destination field. |
| target_column_type | String | Destination field type. |
| target_column_length | String | Destination field length. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique mapping ID. |
| source_schema | String | Source schema name. |
| target_schema | String | Destination schema name. |
| updated_time | Long | Last modification time. |
| status | String | Mapping status. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.