REST API - category

category_model

The category_model structure defines a category that is used to group one or more tags.

Representations:

JSON
XML

{
    "associable_types": [
        "string",
        "string"
    ],
    "cardinality": "SINGLE",
    "description": "string",
    "id": "obj-103",
    "name": "string",
    "used_by": [
        "string",
        "string"
    ]
}

<?xml version="1.0" ?>
<ns0:CategoryModel xmlns:ns0="http://vmware.com/cis/tagging" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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>
</ns0:CategoryModel>

Attributes:

Name	Type	Required	Description
id *	ID	Yes	The unique identifier of the category. Id of type com.vmware.cis.tagging.Category.
name *	string	Yes	The display name of the category.
description *	string	Yes	The description of the category.
cardinality *	com.vmware.cis.tagging.category_model.cardinality	Yes	The associated cardinality (`SINGLE`, `MULTIPLE`) of the category. The `cardinality` enumerated type defines the number of tags in a category that can be assigned to an object. Values 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.
associable_types *	Set<string>	Yes	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.
used_by *	Set<string>	Yes	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.

com.vmware.cis.tagging

category_model