Hitachi

Job Management Partner 1 Version 10 Job Management Partner 1/Automatic Operation GUI, Command, and API Reference


9.6.3 Acquisition of a list of task operations

Function

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

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

Request format

GET http://host:port/Automation/version/objects/Tasks/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.

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" : "stop",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/stop/invoke",
    "method" : "POST",
    "parameters" : null
  }, {
    "name" : "resubmit",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/resubmit/invoke",
    "method" : "POST",
    "parameters" : null
  }, {
    "name" : "rerunStart",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/rerunStart/invoke",
    "method" : "POST",
    "parameters" : null
  }, {
    "name" : "rerunStepStart",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/rerunStepStart/invoke",
    "method" : "POST",
    "parameters" : null
  } ],
  "count" : count
}

Usage example

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

Request header:

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

Response header:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 11:50:49 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO ef25841e55e5ca35748991fa926afd0852d24f6_V0300
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" : "stop",
    "href" : "http://10.196.184.238:22015/Automation/v1/objects/Tasks/2026/actions/stop/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "resubmit",
    "href" : "http://10.196.184.238:22015/Automation/v1/objects/Tasks/2026/actions/resubmit/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "rerunStart",
    "href" : "http://10.196.184.238:22015/Automation/v1/objects/Tasks/2026/actions/rerunStart/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "rerunStepStart",
    "href" : "http://10.196.184.238:22015/Automation/v1/objects/Tasks/2026/actions/rerunStepStart/invoke",
    "method" : "POST",
    "parameters" : [ ]
  } ],
  "count" : 4
}