Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.46 KB

category_create.rst

File metadata and controls

66 lines (43 loc) · 1.46 KB
Raw

category_create

.. function:: POST /orgs/{oid}/categories

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Creates a new category in an organization.

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

HTTP Request Body Parameters

A :ref:`category-object` object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories" -X POST \
-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>Category Example</name>
        <type>PROJECT</type>
</ns0:category>
.. seealso::

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