Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.5.14 Acquisition of information necessary for the operation to change the status of a service to disabled

Function

Acquires information necessary for the operation to change the status of the specified service to disabled.

Execution permissions

Admin role, Develop role, Modify role

API version

v1

Request format

GET http://host:port/Automation/version/objects/Services/id/actions/disable

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.

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

Usage example

In the following example, the API function acquires information necessary for changing the status of the service whose instanceID is 2004 to disabled.

Request header:

GET /Automation/v1/objects/Services/2004/actions/disable HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Thu, 30 Jul 2015 05:05:53 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 4ceed74c19dfb6a6c289e561e1c23f5a9088f58_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:

{
  "name" : "disable",
  "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/disable/invoke",
  "method" : "POST",
  "parameters" : [ ]
}