9.4.1 Acquisition of a list of services
Function
Acquires a list of services registered in JP1/AO.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/Services
This API acquires a list of all services for which the user who executed the API has permissions.
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. |
|
400 |
Bad Request |
A query parameter is invalid. |
|
401 |
Unauthorized |
The user does not have login permission. |
|
412 |
Precondition failed |
The server is not available. |
|
500 |
Server-side error |
A server processing error occurred. |
Response schema
Data that matches the conditions specified by query parameters in a request is returned in the response body. The following shows the schema of the response body.
{
"data" : [ {"member-of-the-resources-for-service-functionality(Services)" : value ... }, ... ],
"count" : number-of-data-items-that-match-the-conditions-specified-by-query-parameters(0-to-n)
}Usage example
In the following example, the API acquires a list of all services.
Request header:
GET /Automation/v1/objects/Services 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:36:42 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO ed355b6e59f72c675dca1498e951439e8aa0d8_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:
{
"data" : [ {
"instanceID" : 2015,
"name" : "testService1",
"description" : "description",
"tags" : "",
"serviceTemplateName" : "testService",
"createTime" : "2014-07-14T01:16:11.000-0700",
"modifyTime" : "2014-07-14T04:36:30.000-0700",
"serviceState" : "release",
"serviceGroupName" : "Default Service Group",
"serviceGroupID" : 3
}, {
"instanceID" : 2020,
"name" : "testService2",
"description" : "description",
"tags" : "",
"serviceTemplateName" : "testService",
"createTime" : "2014-07-14T01:16:39.000-0700",
"modifyTime" : "2014-07-14T04:36:33.000-0700",
"serviceState" : "release",
"serviceGroupName" : "Default Service Group",
"serviceTemplateID" : 2008,
"serviceGroupID" : 3
} ],
"count" : 2
}Related topic