Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.7.15 Retry from the failed step

Function

Specifies a task, and retries the task from the failed step.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

Request format

POST http://host:port/Automation/version/objects/Tasks/id/actions/rerunStart/invoke

The following shows the structure of the request body.

{
  "name" : "rerunStart",
  "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/rerunStart/invoke",
  "method" : "POST",
  "parameters" : [ ]
}

Status code

The following table describes the various status codes that can be returned as the response to a request.

Status code

Message

Description

200

OK

Processing has been successfully completed.

400

Bad Request

The argument is invalid.

401

Unauthorized

The user does not have login permission.

404

Not found

The permission is invalid, or the resource does not exist.

409

Conflict

The status of the task is not Failed.

412

Precondition failed

The server is not running.

500

Server-side error

A server processing error occurred.

Response schema

The following shows the structure of the response body for a request.

{
  "instanceId" : "instance-id",
  "created" : "created-date-and-time",
  "updated" : "updated-date-and-time",
  "completed" : "completed-date-and-time",
  "state" : "state",
  "affectedResources" : [ {...} ]
  "result" : [ {...} ],
  "resultType" : "result-type"
}

The following table describes an object that can be output as affectedResources (member).

Table 2‒68: Object that can be output as affectedResources (member) (Retry from the failed step)

Output

Resource name

Number

Description

Link to the affected task

String

1

Link to the updated resource for task functionality (Tasks)

Usage example

In the following example, the API retries the task whose instanceID is 5381 from the failed step.

Request header:

POST /Automation/v1/objects/Tasks/5381/actions/rerunStart/invoke HTTP/1.1
Host: 192.168.146.132:22015
User-Agent: curl/7.36.0
Accept: application/json
Content-Type: application/json
Content-Length: 177
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 10:19:44 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO dfd342179388629104cd0bb13d288884bed541b_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_V0810
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS
Access-Control-Allow-Credentials: true
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: application/json

Response body:

{
  "instanceID" : "17356cf0-f709-4561-a56b-17a6fbc321e3",
  "created" : "2015-08-07T19:19:44.552+09:00",
  "updated" : "2015-08-07T19:19:44.552+09:00",
  "completed" : "2015-08-07T19:19:44.552+09:00",
  "state" : "success",
  "affectedResource" : [ "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5381" ],
  "result" : [ ]
}