1. Operations
  2. cis
  3. tagging
  4. category

cis tagging category: get

Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.

Request:

HTTP request

GET https://{server}/rest/com/vmware/cis/tagging/category/id:{category_id}

Path Parameters

Name Type Description
Required
category_id string The identifier of the input category.

Response:

HTTP Status Code: 200

Representations:

{
    "value": {
        "associable_types": [
            "string",
            "string"
        ],
        "cardinality": "SINGLE",
        "description": "string",
        "id": "obj-103",
        "name": "string",
        "used_by": [
            "string",
            "string"
        ]
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/cis/tagging/category" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <id>obj-103</id>
    <associable_types-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </associable_types-array>
    <description>string</description>
    <name>string</name>
    <used_by-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </used_by-array>
    <cardinality>SINGLE</cardinality>
  </value>
</ns0:Get-Result>

Response Type:

Name Type Description
bold = required
value category_model The cis.tagging.category_model that corresponds to category_id.
value.id string The unique identifier of the category.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Category. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Category.
value.name string The display name of the category.
value.description string The description of the category.
value.cardinality string The associated cardinality (SINGLE, MULTIPLE) of the category.

Defines the number of tags in a category that can be assigned to an object. Value is one of:
SINGLE: An object can only be assigned one of the tags in this category. For example, if a category is "Operating System", then different tags of this category would be "Windows", "Linux", and so on. In this case a VM object can be assigned only one of these tags and hence the cardinality of the associated category here is single.
MULTIPLE: An object can be assigned several of the tags in this category. For example, if a category is "Server", then different tags of this category would be "AppServer", "DatabaseServer" and so on. In this case a VM object can be assigned more than one of the above tags and hence the cardinality of the associated category here is multiple.
value.associable_types string[] The types of objects that the tags in this category can be attached to. If the set is empty, then tags can be attached to all types of objects. This field works only for objects that reside in Inventory Service (IS). For non IS objects, this check is not performed today and hence a tag can be attached to any non IS object.
value.used_by string[] The set of users that can use this category. To add users to this, you need to have the edit privilege on the category. Similarly, to unsubscribe from this category, you need the edit privilege on the category. You should not modify other users subscription from this set.

Errors:

HTTP Status Code Type Description
404 not_found if the category for the given category_id does not exist in the system.
403 unauthorized if you do not have the privilege to read the category.