9.4.4 Acquisition of information necessary for executing a service

Function

Acquires information necessary for executing the specified service.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

Request format

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

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 a permission to acquire the service, or the service 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" : "submit",
  "href" : "http://host:port/Automation/version/objects/Services/id/actions/submit/invoke",
  "method" : "POST",
  "parameters" : [ {...} ]
}

The following table describes the objects that can be output as parameters (member).

Table 9‒31: Objects that can be output as parameters (member) (Acquisition of information necessary for executing a service)
Function	Resource name	Number	Description
Schedule	Schedule	1	Execution schedule for the service
List of property values	PropertyValue	0 to n	Input property for the service

Usage example

In the following example, the API acquires template information necessary for preparing execution of the service whose instanceID is 2015.

Request header:

GET /Automation/v1/objects/Services/2015/actions/submit HTTP/1.1
Host:10.196.184.238:22015
Accept:application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1

Response header:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 11:44:25 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 717c09f57f33957cd1e6f8d4207e6853b05eac_V0300
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" : "submit",
  "href" : "http://10.196.184.238:22015/Automation/v1/objects/Services/2015/actions/submit/invoke",
  "method" : "POST",
  "parameters" : [ {
    "name" : "testService1_20140714044426",
    "submitter" : "System",
    "scheduleType" : "immediate",
    "description" : "",
    "scheduledStartTime" : "2014-07-14T04:44:26.004-07:00",
    "recurrenceInterval" : "daily",
    "recurrenceDayOfWeek" : "",
    "recurrenceDayOfMonth" : "",
    "recurrenceLastDayOfMonth" : false,
    "recurrenceStartDate" : "2014-07-14",
    "recurrenceTime" : "00:00:00",
    "serviceID" : 2015
  }, {
    "instanceID" : 2012,
    "type" : "string",
    "keyName" : "testProp",
    "value" : "defaultValue",
    "serviceID" : 2015
  } ]
}

Related topics

To Page Top