LabelCategories

Type	Base Path	Trigger Name
REST resource	~{realm}/label-categories/	label-categories

Labels are grouped into label categories and this resource describes those categories. In some other systems, a label or tag might be represented as a key/value pair; here, the label category can be thought of as the key while the actual label is the value.

See Labels & Extended Properties for more information about labels and how they can be used.

Endpoints

Name	Method	Relative Path	Payload	Response	Description
addLabelCategory	POST	~{realm}/label-categories/	LabelCategory	Stored_LabelCategory	Adds a new label category to the list.
listLabelCategories	GET	~{realm}/label-categories/	N/A	Stored_LabelCategory[]	Retrieves a list of label categories.
getLabelCategory	GET	~{realm}/label-categories/{id}	N/A	Stored_LabelCategory	Retrieves a label category.
putLabelCategory	PUT	~{realm}/label-categories/{id}	LabelCategory	Stored_LabelCategory	Replaces a label category.
updateLabelCategory	PATCH	~{realm}/label-categories/{id}	Partial_LabelCategory	Stored_LabelCategory	Updates specified label category fields.
removeLabelCategory	DELETE	~{realm}/label-categories/{id}	N/A	N/A	Deletes a label category.

Permissions

Permission	Description
edit-labels	Client is allowed to add new label categories and to modify or delete existing label categories.
show-labels	Client is allowed to query the label category list and to fetch individual label categories.

Entities

Interface LabelCategory

interface LabelCategory {
    'name': string;
    'resources'?: string[];
    'id'?: number;
    'created'?: DateTime;
    'updated'?: DateTime;
    'deleted'?: DateTime;
    'updated-by'?: number;
    'updated-from'?: number;
    'tags'?: string[];
    'labels'?: number[];
}

Property	Data Type	Description
name	String	The label category name. Must be unique.
resources	String[]?	An optional list of resources where this label category is applicable. Resource identifiers are the same as used by queries in Triggers and EventStreams.
id	Int64?	The resource ID of this entity.
created	DateTime?	Date and time when this entity was first created.
updated	DateTime?	Date and time when this entity was last modified.
deleted	DateTime?	Date and time when this entity was deleted.
updated-by	Int64?	ID of User who last modified this entity.
updated-from	Int64?	ID of Till (trusted device) which last modified this entity.
labels	Int64[]?	A list of Label IDs associated with this entity—yes, label categories can be labelled too.