2.11.1 Acquisition of a list of tag groups

Function

Acquires a list of tag groups. In addition, this API function acquires a list of tags that belong to each tag group.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

Request format

GET http://host:port/Automation/version/objects/TagGroups

Status code

The following table describes the various status codes that can be returned as the response to a request.

Response schema

The following shows the structure of the response body for a request.

{
  "data" : [ {"member-of-the-resources-for-tag-group-functionality(TagGroups)" : 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 tag groups.

Request header:

GET /Automation/v1/objects/TagGroups 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: Fri, 07 Aug 2015 03:37:17 GMT
Server Cosminexus HTTP Server is not blacklisted
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO d72a9887e1aef533d4763b1adf0a391d6cfa6cb_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" : [ {
    "instanceID" : 34,
    "name" : "Applications",
    "tags" : "SQL Server,XenDesktop,Oracle Database,Cluster,Exchange"
  }, {
    "instanceID" : 42,
    "name" : "Hypervisors",
    "tags" : "VMware vSphere,Hyper-V"
  }, {
    "instanceID" : 45,
    "name" : "Storage Services",
    "tags" : "Replicate Storage,Add Like Storage,Snapshot,Add New Storage"
  }, {
    "instanceID" : 54,
    "name" : "Uncategorized",
    "tags" : "Basic,Hitachi,Windows,Linux"
  } ],
  "count" : 4
}