Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Resetting the Progress of the Combined Task
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Resetting the Progress of the Combined Task

Function

Reset the progress of the combined task.

URI

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

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

date_from

No

Long

Start time of task resetting. The value is a UTC timestamp and can be left empty.

Minimum: 1

Maximum: 9999999999999999999

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

message

String

Task resetting result.

Minimum: 3

Maximum: 50

Status code: 400

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: 404

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

Status code: 500

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

https://{{ServerHost}}/v2/:project_id/fdi/instances/:instance_id/multi-tasks/:task_id/reset

{
  "date_from" : 1630052714000
}

Example Responses

Status code: 200

OK

{
  "message" : "Reset Success"
}

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