Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.4.7 Acquisition of information necessary for exporting a service template

Function

Acquires information necessary for exporting the specified service template.

Execution permissions

Admin role, Develop role

API version

v1

Request format

GET http://host:port/Automation/version/objects/ServiceTemplates/id/actions/export

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 user does not have permission to acquire service templates, or the service template 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" : "export",
   "href" : "http://host:port/Automation/version/objects/ServiceTemplates/id/actions/export/invoke",
   "method" : "POST",
   "parameters" : []
 }

Usage example

In the following example, the API function acquires information necessary for exporting the service template whose instanceID is 1116.

Request header:

GET /Automation/v1/objects/ServiceTemplates/1116/actions/export 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 00:42:05 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO c21cd879a4c62f90d8f7c5775ec1194e88a92b_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" : "export",
  "href" : "http://10.196.184.182:22015/Automation/v1/objects/ServiceTemplates/1116/actions/export/invoke",
  "method" : "POST",
  "parameters" : [ ]
}