Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 1.51 KB

category_update.rst

File metadata and controls

67 lines (44 loc) · 1.51 KB
Raw

category_update

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 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 org-object
  • cid (required): the id of the category-object

HTTP Request Body Parameters

A 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>
  • category-object
  • categoryChild-create
  • category-create
  • category-delete
  • category-deleteAll
  • category-get
  • category-getAll
  • org-object