Create catalog categories

Details

URI /catalog/<catalog_id>/category
Method POST
Parameters

userIdentifier=<user_id>
    Required; the user ID you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

Returns 200 - Ok
401 - Not authorized
404 - Object not found
500 - Server exception

In the request body:

  • Any category specified in the request body that already exists will be left unchanged.
  • displayName is required.
  • iconUrl and description are optional, and will be set to null if not specified.

Example

The following URL was sent to create an approval policy with two named approvers:

https://<host>:<port>/csa/rest/catalog/90e72e323c88421f013c8d7fad120076/category ?userIdentifier=90d96588360da0c701360da0f1d5f483

The following XML was sent in the request:


<Catalog>
  <catalogCategory>
    <displayName>Example first Catalog Category</displayName>
    <iconUrl>/catalog/category/x.png</iconUrl>
    <description>description for catalog category</description>
  </catalogCategory>
  <catalogCategory>
      <displayName>Example second category</displayName>
  </catalogCategory>
</Catalog>

The following XML was returned:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Catalog>
  <id>8a81818f3d02fb7e013d0308894a0004</id>
  <isCriticalSystemObject>false</isCriticalSystemObject>
  <description>Default catalog for the organization.</description>
  <iconUrl>
    /csa/images/library/briefcase-consumer_default_img-60.png
  </iconUrl>
  <name>Catalog_QA_ORG</name>
  <displayName>QA Org Catalog</displayName>
  ...
  <catalogCategory> ... </catalogCategory>
  ...
  <catalogCategory>
    <id>8a81818f3d128500013d1341a5d3000e</id>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <name>EXAMPLE_SECOND_CATEGORY</name>
    <displayName>Example second category</displayName>
    <disabled>false</disabled>
  </catalogCategory>
  <catalogCategory> ... </catalogCategory>
  ...
  <catalogCategory>
    <id>8a81818f3d128500013d1341a5c6000d</id>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <description>description for catalog category</description>
    <iconUrl>/catalog/category/x.png</iconUrl>
    <name>EXAMPLE_FIRST_CATALOG_CATEGORY</name>
    <displayName>Example first Catalog Category</displayName>
    <disabled>false</disabled>
  </catalogCategory>
  <catalogCategory> ... </catalogCategory>
  ...
</Catalog>