Matterial API Object - Category

com.matterial.mtr.api.object.Category

Zurück zur Übersicht

Category

The category class is used to manage document categories. Categories can be assigned to documents and persons can follow categories.
Implemented since version: 1.0

Json Schema
Json Example
Xml Example
Java

Properties

Id

The identifier of the object.

Data type Json property Updateable Required on create Version implemented
Number id No No 1.0

Name

The name of the category.

Data type Json property Min Max Updateable Required on create Version implemented
String name 1 255 Yes Yes 1.0

Description

The description of the category.

Data type Json property Max Updateable Required on create Version implemented
String description 4000 Yes No 1.0

TypeId

The id of the category type to which this category belongs to

Data type Json property Updateable Required on create Version implemented
String typeId Yes Yes 1.0

TypePersonal

True, if the category type, to which this category belongs to, is a personal category type.

Data type Json property Updateable Required on create Version implemented
Boolean typePersonal No No 1.0

Following

Indicates, if the current user follows the category in the specified language. Requires the parameter “loadFollowingLanguageKey” when loading the category.

Data type Json property Updateable Required on create Version implemented
Boolean following No No 1.0

UsageCount

Number, how many times the category is used. Requires the “loadUsage” parameter when loading the category.

Data type Json property Updateable Required on create Version implemented
Number usageCount No No 1.0

Quick

A quick category is currently only represented by the “Mark as favourite” (the little star) in the user interface.

Data type Json property Updateable Required on create Version implemented
Boolean quick No No 1.0
×