Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.8.5 Acquisition of a list of operations for a history record

Function

Acquires a list of operations that can be executed for the history record that has the specified ID.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

Request format

GET http://host:port/Automation/version/objects/TaskHistories/id/actions

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.

401

Unauthorized

The user does not have login permission.

404

Not found

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

412

Precondition failed

The server is not available.

500

Server-side error

A server processing error occurred.

Response schema

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

{
  "data" : [ {
    "name" : "delete",
    "href" : "http://host:port/Automation/version/objects/TaskHistories/id",
    "method" : "DELETE",
    "parameters" : []
  } ],
  "count" : 1
}

Usage example

In the following example, the API function acquires a list of operations that can be performed for the history record whose instanceID is 5237.

Request header:

GET /Automation/v1/objects/TaskHistories/5237/actions HTTP/1.1
Host: 192.168.146.132:22015
User-Agent: curl/7.36.0
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 11:12:20 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO a754baf585ff2447abf34a09fb93ea3b953cfe_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:

{
  "data" : [ {
    "name" : "delete",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/TaskHistories/5237",
    "method" : "DELETE",
    "parameters" : [ ]
  } ],
  "count" : 1
}