com.vmware.cis.tagging.category

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

update

PATCH /com/vmware/cis/tagging/category/id:{category_id}
POST /com/vmware/cis/tagging/category/id:{category_id}?~action=update
POST /com/vmware/cis/tagging/category?~action=update

Updates an existing category. To invoke this operation, you need the edit privilege on the category.
Request:
Representations:
{
    "category_id": "obj-103",
    "update_spec": {
        "associable_types": [
            "string",
            "string"
        ],
        "cardinality": "SINGLE",
        "description": "string",
        "name": "string"
    }
}
<?xml version="1.0" ?>
<ns0:Update-Input xmlns:ns0="http://vmware.com/cis/tagging/category" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <update_spec>
    <associable_types-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </associable_types-array>
    <description>string</description>
    <name>string</name>
    <cardinality>SINGLE</cardinality>
  </update_spec>
  <category_id>obj-103</category_id>
</ns0:Update-Input>
POST /com/vmware/cis/tagging/category?~action=update
&update_spec.associable_types.1=string
&update_spec.associable_types.2=string
&update_spec.description=string
&update_spec.name=string
&update_spec.cardinality=SINGLE
&category_id=obj-103

Parameters:
Name Type Required Description
category_id
 *
 ID Yes The identifier of the category to be updated. Id of type com.vmware.cis.tagging.Category.
update_spec
 *
 update_spec Yes Specification to update the category.

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
already_exists if the com.vmware.cis.tagging.category.update_spec.name provided in the update_spec is the name of an already existing category. 400
invalid_argument if any of the information in the update_spec is invalid. 400
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 update the category. 403

Copyright © 2014. All Rights Reserved.