2.4.10 Acquisition of information necessary for creating a service based on a service template

Function

Acquires information necessary for creating a service based on 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/actions/bind

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.

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

Usage example

In the following example, the API function acquires information necessary for creating a service based on the service template whose instanceID is 560.

Request header:

GET /Automation/v1/objects/ServiceTemplates/560/actions/bind HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json

Response header:

HTTP/1.1 200 OK
Date: Thu, 30 Jul 2015 02:08:29 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 77efd47709df8b7f65468cb4778e804db1e6c_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" : "bind",
  "href" : "http://10.196.184.182:22015/Automation/v1/objects/ServiceTemplates/560/actions/bind/invoke",
  "method" : "POST",
  "parameters" : [ {
    "name" : "Execute Remote Command",
    "description" : "Executes a command on the remote execution target server.",
    "tags" : "Execute Script,Linux,Windows",
    "serviceTemplateName" : "remoteCommandExe",
    "serviceState" : "test",
    "serviceGroupName" : "DefaultServiceGroup",
    "supportedScheduleType" : "immediate,schedule,recurrence",
    "serviceTemplateID" : 560
  }, {
    "type" : "string",
    "keyName" : "common.targetHost",
    "value" : "",
    "readOnly" : false,
    "hidden" : false
  }, {
    "type" : "string",
    "keyName" : "common.remoteCommand",
    "value" : "",
    "readOnly" : false,
    "hidden" : false
  }, {
    "type" : "string",
    "keyName" : "common.remoteCommandParameter",
    "value" : "",
    "readOnly" : false,
    "hidden" : false
  } ]
}