2.10.2 Acquisition of information about a service group

Function

Acquires information about the specified service group.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

Request format

GET http://host:port/Automation/version/objects/ServiceGroups/id

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.

{
  "instanceID" : instance-id,
  "objectID" : "object-id"
  "name" : "name",
  "description" : "description"
}

Usage example

In the following example, the API function acquires information about the service group whose instanceID is 3.

Request header:

GET /Automation/v1/objects/ServiceGroups/3 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:11:12 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 1f2d33f62adb5df5ca712acb2a0a430cb986e_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:

{
  "instanceID" : 3,
  "objectID" : "Automation_RG_DEFAULT",
  "name" : "DefaultServiceGroup",
  "description" : "default service group"
}