com.vmware.cis.tagging.category

The category service provides operations to create, read, update, delete, and enumerate categories.

get

GET /com/vmware/cis/tagging/category/id:{category_id}
POST /com/vmware/cis/tagging/category/id:{category_id}?~action=get
POST /com/vmware/cis/tagging/category?~action=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:
Representations:
{
    "category_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/cis/tagging/category" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <category_id>obj-103</category_id>
</ns0:Get-Input>
POST /com/vmware/cis/tagging/category?~action=get
&category_id=obj-103

Parameters:
Name Type Required Description
category_id
 *
 ID Yes The identifier of the input category. Id of type com.vmware.cis.tagging.Category.

Response:
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>

Parameters:
Name Type Required Description
result category_model Yes The com.vmware.cis.tagging.category_model that corresponds to category_id.

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

Copyright © 2014. All Rights Reserved.