2.5.5 Acquisition of a list of operations for a service
Function
Acquires a list of operations that can be executed for 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
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.
{ "data" : [ { "name" : "update", "href" : "http://host:port/Automation/version/objects/Services/id", "method" : "PUT", "parameters" : [] }, { "name" : "submit", "href" : " http://host:port/Automation/version/objects/Services/id/actions/submit/invoke", "method" : "POST", "parameters" : [] }, { "name" : "detailhelp", "href" : " http://host:port/Automation/version/objects/Services/id/actions/detailhelp", "method" : "GET", "parameters" : [] }, { "name" : "delete", "href" : "http://host:port/Automation/version/objects/Services/id", "method" : "DELETE", "parameters" : [] }, { "name" : "reset", "href" : " http://host:port/Automation/version/objects/Services/id/actions/reset/invoke", "method" : "POST", "parameters" : [] }, { "name" : "release", "href" : " http://host:port/Automation/version/objects/Services/id/actions/release/invoke", "method" : "POST", "parameters" : [] }, { "name" : "maintenance", "href" : " http://host:port/Automation/version/objects/Services/id/actions/maintenance/invoke", "method" : "POST", "parameters" : [] }, { "name" : "disable", "href" : " http://host:port/Automation/version/objects/Services/id/actions/disable/invoke", "method" : "POST", "parameters" : [] }, { "name" : "applyTemplate", "href" : " http://host:port/Automation/version/objects/Services/id/actions applyTemplate/invoke", "method" : "POST", "parameters" : [] } ], "count" : 9 }
Usage example
In the following example, the API function acquires a list of operations that can be executed for the service whose instanceID is 2004.
Request header: GET /Automation/v1/objects/Services/2004/actions 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 04:40:59 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 72fe74c462e2a50793542df0c0589289ce3f3_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: { "data" : [ { "name" : "update", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004", "method" : "PUT", "parameters" : [ ] }, { "name" : "submit", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/submit/invoke", "method" : "POST", "parameters" : [ ] }, { "name" : "detailhelp", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/detailhelp", "method" : "GET", "parameters" : [ ] }, { "name" : "delete", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004", "method" : "DELETE", "parameters" : [ ] }, { "name" : "reset", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/reset/invoke", "method" : "POST", "parameters" : [ ] }, { "name" : "release", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/release/invoke", "method" : "POST", "parameters" : [ ] }, { "name" : "maintenance", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/maintenance/invoke", "method" : "POST", "parameters" : [ ] }, { "name" : "disable", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/disable/invoke", "method" : "POST", "parameters" : [ ] }, { "name" : "applyTemplate", "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/applyTemplate/invoke", "method" : "POST", "parameters" : [ ] } ], "count" : 9 }