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
| 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. |
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 |
|---|---|---|---|
| date_from | No | Long | Start time of task resetting. The value is a UTC timestamp and can be left empty. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| message | String | Task resetting result. |
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
Reset the progress of a specified composite data integration task to a specified time.
https://{{ServerHost}}/v2/c53626012ba84727b938ca8bf03108ef/fdi/instances/fae7ff6c-8e07-4cf8-9e67-589cab2f017c/multi-tasks/15366328208d4d77b76532fe9f4006a6/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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.