Tagging_Category_CreateSpec

The Category.CreateSpec structure is used to create a category. Use the Category.create operation to create a category defined by the create specification.

JSON Example

{
    "name": "string",
    "description": "string",
    "cardinality": "string",
    "associable_types": [
        "string"
    ],
    "category_id": "string"
}

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

Object types to which this category's tags can be attached.

string

category_id

Optional

If unset an identifier will be generated by the server 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.

Parameter To

Create Category