Tagging_CategoryModel

Tagging_CategoryModel
Tagging_CategoryModel

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

JSON Example 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "cardinality": "string",
    "associable_types": [
        "string"
    ],
    "used_by": [
        "string"
    ]
}
string
id
Required

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.

string
name
Required

The display name of the category.

string
description
Required

The description of the category.

Tagging_CategoryModel_Cardinality
cardinality
Required

The CategoryModel.Cardinality enumerated type defines the number of tags in a category that can be assigned to an object.
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.

array of string
associable_types
Required

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.

array of string
used_by
Required

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.

Returned By