2.5.6 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
v1
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).
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 function acquires necessary information as a preparation for executing the service whose instanceID is 2015.
Request header: GET /Automation/v1/objects/Services/2015/actions/submit 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 04:40:59 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 75cdef77cf941edbf5b2934f6afe1e8e18fdba8a_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_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" : "submit", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2015/actions/submit/invoke", "method" : "POST", "parameters" : [ { "name" : "Execute Remote Command", "submitter" : "", "scheduleType" : "immediate", "description" : "", "scheduledStartTime" : "2015-07-30T14:51:23.342+09:00", "recurrenceInterval" : "daily", "recurrenceDayOfWeek" : "", "recurrenceDayOfMonth" : "", "recurrenceLastDayOfMonth" : false, "recurrenceStartDate" : "2015-07-30", "recurrenceTime" : "00:00:00", "serviceID" : 5137 }, { "instanceID" : 5112, "type" : "string", "keyName" : "common.targetHost", "value" : "", "readOnly" : false, "hidden" : false, "serviceID" : 5137 }, { "instanceID" : 5135, "type" : "string", "keyName" : "common.remoteCommand", "value" : "", "readOnly" : false, "hidden" : false, "serviceID" : 5137 }, { "instanceID" : 5128, "type" : "string", "keyName" : "common.remoteCommandParameter", "value" : "", "readOnly" : false, "hidden" : false, "serviceID" : 5137 } ] }