Category Resources
Synopsis
HMP administrators can define metadata "categories" with default values to identify and store custom metadata for sessions and videos.
Note
Category setup and administration must be done from the Administration Web interface.
The categories
API may be used to get a list of categories. Category values are stored in sessions and videos using their metadata
APIs.
Category Parameters
Property | JSON Type | Property Type | Description |
---|---|---|---|
| String | Immutable | Identifies the category, generated by HMP. |
| String | Required | The name used to identify the category. Category labels must be unique. |
| Array of strings | Optional | Pre-defined values for the category. Note This list is not updated with user-defined dynamic values. |
| Boolean | Required |
|
| Boolean | Required |
|
| Array of strings | Optional | List of the predefined values currently assigned to sessions and videos. Note Contains the user-defined "dynamic" values. |
| number | Optional | Order in which categories are returned and displayed. |
| string | Optional | Used to assign a group to a category. The categories are grouped when displayed. |