2.4.9 Acquisition of the URL for displaying the details of a service template

Function

Acquires the URL for displaying the details of the specified service template.

Execution permissions

Admin role, Develop role, Modify role

API version

Request format

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

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" : "export",
   "href" : "Link-to-the-detail-help",
   "method" : "POST",
   "parameters" : []
 }

Usage example

In the following example, the API function acquires the URL for displaying the details of the service template whose instanceID is 1116.

Request header:

GET /Automation/v1/objects/ServiceTemplates/1116/actions/detailhelp 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 02:04:35 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 11baaddb4ff5c120d1cca95c75fab1417d2c921_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" : "detailhelp",
  "href" : "http://10.196.184.182:22015/Automation/services/custom/000000000001116/r_all_vol_details.html",
  "method" : "GET",
  "parameters" : [ ]
}