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	Type	Description
id	string, core	(Read-only) An identifier for the category.
externalId	string	Identifier in the external system.
parentCategory	object	Represents the parent category. If null, then this is a top-level category.
name	string, core	A user-friendly name of the category.
icon	string, core	Icon to be shown on grids and info cards
description	string	A short description of the category
longDescription	string	A long description of the category
featured	bool	Indicates whether this product should be featured on the UI.
status	string, core	Indicates the status of the category. Allowed values are: Draft Published Unpublished Deleted
audit	object	(Read-only) Represents the audit object.
revision	integer, core	The entity's revision number.

Example

CATEGORY OBJECT

{
  "id": "CAT-1671-3887",
  "externalId": "arK9uX45",
  "name": "Development",
  "parentCategory": {
    "id": "CAT-1671-3886",
    "name": "Productivity"
  },
  "description": "Software development tools",
  "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"
      }
    }
  }
}