2.10.1 Acquisition of a list of service groups
Function
Acquires a list of service groups.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/ServiceGroups
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-group-functionality(ServiceGroups)" : 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 function acquires a list of service groups.
Request header: GET /Automation/v1/objects/ServiceGroups HTTP/1.1 Host: 192.168.146.132:22015 User-Agent: curl/7.36.0 Accept: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= Accept-Language: ja Response header: HTTP/1.1 200 OK Date: Fri, 07 Aug 2015 07:09:41 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 75f7726f932537efbc38f15ea81c31a8797bab1e_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: { "data" : [ { "instanceID" : 3, "objectID" : "Automation_RG_DEFAULT", "name" : "DefaultServiceGroup", "description" : "default service group" }, { "instanceID" : 2, "objectID" : "Automation_RG_ALL", "name" : "All Service Groups", "description" : "default service groups which contains all services" } ], "count" : 2 }