Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.6.3 Acquisition of a list of operations for a schedule

Function

Acquires a list of operations that can be executed for the specified schedule.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

Request format

GET http://host:port/Automation/version/objects/Schedules/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" : "cancel",
    "href" : "http://host:/Automation/version/objects/Schedules/id/actions/cancel/invoke",
    "method" : "POST",
    "parameters" : []
  }, {
    "name" : "suspend",
    "href" : " http://host:port/Automation/version/objects/Schedules/id/actions/suspend/invoke",
    "method" : "POST",
    "parameters" : []
  }, {
    "name" : "resume",
    "href" : " http://host:port/Automation/version/objects/Schedules/id/actions/resume/invoke",
    "method" : "POST",
    "parameters" : []
  } ],
  "count" : 3
}

Usage example

In the following example, the API acquires a list of operations that can be executed for the schedule whose instanceID is 2193.

Request header:

GET /Automation/v1/objects/Schedules/2193/actions HTTP/1.1
Host: 10.196.184.238:22015
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:29:28 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO f214b39fba479af17375f1ad0e052124041ea60_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_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" : "cancel",
    "href" : "http://10.196.184.238:22015/Automation/v1/objects/Schedules/2193/actions/cancel/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "suspend",
    "href" : "http://10.196.184.238:22015/Automation/v1/objects/Schedules/2193/actions/suspend/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "resume",
    "href" : "http://10.196.184.238:22015/Automation/v1/objects/Schedules/2193/actions/resume/invoke",
    "method" : "POST",
    "parameters" : [ ]
  } ],
  "count" : 3
}