Category

The Category object represents a software category or sub-category. It is used to classify software in the Public Catalog.

This object contains the following attributes:

Field Name	Data Type	Description
id	string	An identifier for the category. Example: CAT-1671-3887
externalId	string	Identifier in the external system. Example: arK9uX45
parentCategory	category	A reference to the parent category. If null, then this is a top-level category. Example: { "id": "CAT-1670-0003", "name": "Productivity" }
name	string	A user-friendly name of the category. Example: Development
icon	string	Icon to be shown on grids and info cards Example: /v1/public-catalog/product-profiles/PRP-1671-3887/icon
description	string	A short description of the category Example: Software development tools
longDescription	string	A long description of the category Example: Tools used to build and test software
featured	bool	Indicates whether this product should be featured on the UI. Example: false
status	string	Indicates the status of the category. Allowed values: draft, published, unpublished, or deleted.
audit	object	A reference to the audit object.
revision	integer	The entity's revision number. Example: 3

Example response

{
  "id": "CAT-1671-3887",
  "externalId": "arK9uX45", -- ??
  "name": "Development",
  "parentCategory": {
    "id": "CAT-1671-3886",
    "name": "Productivity"
  },
  "description": "Software development tools",
  "longDescription": "Used to build and test software", --TO remove
  "featured": false, --TO remove
  "icon": "/v1/public-catalog/categories/CAT-1671-3887/icon", --TO remove
  "status": "Draft",
  "revision": 2,
  "audit": {
    "created": {
      "at": "2024-04-08T06:30:05.807Z",
      "by": {
        "id": "USR-2172-2499",
        "revision": 1,
        "name": "John User"
      }
    },
    "updated": {
      "at": "2024-05-16T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 2,
        "name": "My token"
      },
    "deleted": {
      "at": "2024-05-17T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 3,
        "name": "My token"
      }
    }
  }
}