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
`id`	String	Immutable	Identifies the category, generated by HMP.
`label`	String	Required	The name used to identify the category. Category labels must be unique.
`values`	Array of strings	Optional	Pre-defined values for the category. Note This list is not updated with user-defined dynamic values.
`multipleValues`	Boolean	Required	`false`: Only one value can be set on a video for that category. `true`: One or more values can be assigned.
`allowCustomValues`	Boolean	Required	`false`: Only predefined values may be assigned. `true`: Predefined or custom values may be assigned.
`customValues`	Array of strings	Optional	List of the predefined values currently assigned to sessions and videos. Note Contains the user-defined "dynamic" values.
`index`	number	Optional	Order in which categories are returned and displayed.
`group`	string	Optional	Used to assign a group to a category. The categories are grouped when displayed.