2.4.2 Acquisition of information about a service template

Function

Acquires information about the specified service template.

Execution permissions

Admin role, Develop role, Modify role

API version

v1

Request format

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

Status code

The following table describes the various status codes that can be returned as the response to a request.

Response schema

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

{
  "instanceID" : instance-id,
  "keyName" : "key-name",
  "displayName" : "display-name",
  "iconURL" : "icon-URL",
  "vendorID" : "vendor-ID",
  "version" : " version ",
  "vendorName" : "vendor-name",
  "tags" : "tag",
  "createTime" : "created-date-and-time",
  "modifyTime" : "updated-date-and-time",
  "description" : "description",
  "releaseState" : "release-state",
  "latest" : {true|false},
  "imageURL" : "imageURL",
  "supportedScheduleType" : "supported-schedule-type",
  "needVUP" : {true|false},
  "componentOutdated" : {true|false},
  "usedServices" : used-services,
  "usedTemplates" : used-Templates,
  "disableFeatures" : "disable-features",
  "supportedActionType" : "supported-action-type"
}

Usage example

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

Request header:

GET /Automation/v1/objects/ServiceTemplates/1116 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:36:51 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO a9a6768131e2eff3ecbd5e4457f49e82e0506c_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:

{
  "instanceID" : 1116,
  "keyName" : "SP_GenericApplication",
  "displayName" : "Allocate Volumes for Generic Application",
  "iconURL" : "http://10.196.184.182:22015/Automation/icon/services/com.hitachi.software.dna.cts/SP_GenericApplication/01.20.00",
  "vendorID" : "com.hitachi.software.dna.cts",
  "version" : "01.20.00",
  "vendorName" : "Hitachi, Ltd.",
  "tags" : "Add New Storage",
  "createTime" : "2015-07-29T16:48:25.000+09:00",
  "modifyTime" : "2015-07-29T16:48:25.000+09:00",
  "description" : "Intelligent allocation service that uses sets of volumes from the associated infrastructure group to be consumed by server(s) running a generic application",
  "releaseState" : "release",
  "latest" : true,
  "imageURL" : "http://10.196.184.182:22015/Automation/services/custom/000000000001116/SP_GenericApplication_overview.png",
  "supportedScheduleType" : "immediate,schedule",
  "needVUP" : false,
  "componentOutdated" : false,
  "usedServices" : 0,
  "usedTemplates" : 0,
  "supportedActionType" : "forciblyStop,retry"
}