category_update.rst

category_update

.. function:: PUT /orgs/{oid}/categories/{cid}

Summary

• Method: PUT
• Response Code: 200
• Response Formats: application/xml application/json
• Since: UForge 3.0

Update an existing category.

Refer to :ref:`category-object` for all the mandatory and optional attributes.

Warning

Only administrators have the ability to create and manage categories

Security Summary

• Requires Authentication: true
• Entitlements Required: categories_administrate

URI Parameters

• oid (required): the id of the :ref:`org-object`
• cid (required): the id of the :ref:`category-object`

HTTP Request Body Parameters

A :ref:`category-object` object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories/{cid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:category xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>New name</name>
        <type>PROJECT</type>
</ns0:category>

.. seealso::

         * :ref:`category-object`
         * :ref:`categoryChild-create`
         * :ref:`category-create`
         * :ref:`category-delete`
         * :ref:`category-deleteAll`
         * :ref:`category-get`
         * :ref:`category-getAll`
         * :ref:`org-object`