Help Center> ROMA Connect> API Reference> FDI APIs> Task Management> Modifying a Combined Task
View PDF

Modifying a Combined Task

Function

Modify a combined task.

URI

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

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 body parameters

Parameter

Mandatory

Type

Description

description

No

String

Description.

Minimum: 1

Maximum: 1024

task_tag

No

String

Task tag, which can contain only letters, digits, hyphens (-), and underscores (_).

Minimum: 4

Maximum: 64

operation_types

No

Array of strings

Operation type to be supported. You can select multiple operation types. At least one of the following operation types must be selected:

  • INSERT

  • UPDATE

  • DELETE

repulling_snapshot

No

Boolean

Whether to synchronize existing data. This parameter is valid only when you edit a task.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

task_id

String

Task ID. This parameter can be left empty.

Minimum: 1

Maximum: 64

Status code: 400

Table 4 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 5 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 6 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

{
  "description" : "test",
  "task_tag" : "combinationaa",
  "operation_types" : [ "INSERT", "UPDATE" ],
  "repulling_snapshot" : true
}

Example Responses

Status code: 400

Bad Request

{
  "error_code" : "FDI.3021",
  "error_msg" : "One or more tasks do not exist."
}

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