Modifying Combined Task Mappings
Function
Modify combined task mappings.
URI
PUT /v2/{project_id}/fdi/instances/{instance_id}/multi-tasks/{task_id}/mappings/{mapping_id}
| 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. |
| mapping_id | Yes | String | Unique ID of a composite task mapping. |
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). |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| ext_info | No | ext_info object | Extended attribute. Only server_id is supported. |
| source_datasource_id | Yes | String | Source data source ID (mandatory). |
| target_datasource_id | Yes | String | Destination data source ID (mandatory). |
| source_columns | No | Array of MultiTaskColumnInfo objects | Source fields. |
| target_columns | No | Array of MultiTaskColumnInfo objects | Destination fields. |
| source_table | No | String | Source table name. |
| target_table | No | String | Destination table name. |
| mapping_columns | No | Array of MappingInfo objects | Field mappings. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| server_id | No | String | MySQL server ID. This parameter is mandatory for a MySQL data source. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| field_name | No | String | Field name. |
| field_type | No | String | Field type. |
| field_length | No | String | Field length. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| source_column | No | String | Source field. |
| source_column_type | No | String | Source field type. |
| source_column_length | No | String | Source field length. |
| target_column | No | String | Destination field. |
| target_column_type | No | String | Destination field type. |
| target_column_length | No | String | Destination field length. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| mapping_id | String | Unique ID of a mapping. |
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
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.