/r/{repoId}/objectmanagement/categories/{id}
GET
Retrieving a category
In the response, you receive the detailed information about the specified category.
Parameters
repoId/string/required
The unique ID of the repository.
id/string/required
The unique ID of the category.
Responses
200
The category was determined successfully.
Content
Media type: application/json
{
"id": {
"type": "string",
"description": "The unique ID of the category.",
"nullable": true,
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000"
},
"name": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "The display name of the category. Key pairs from the ID of the language (ISO 639-1 and RFC-3066) and the display name in the corresponding language.",
"example": {
"en": "Bill"
}
},
"propertyRefs": {
"type": "array",
"items": {
"required": [
"propertyId"
],
"type": "object",
"properties": {
"propertyId": {
"minLength": 1,
"type": "string",
"description": "The unique ID of a property.",
"example": "00000000-0000-0000-0000-000000000000"
},
"required": {
"type": "boolean",
"description": "Labels the property as mandatory within the category.",
"default": false,
"nullable": true
},
"showInFacets": {
"type": "boolean",
"description": "This property is offered as a facet when searching for this category.",
"default": false,
"nullable": true
},
"showInImport": {
"type": "boolean",
"description": "This property is offered for storage of this category.",
"default": false,
"nullable": true
},
"showInResult": {
"type": "boolean",
"description": "This property is shown in the result list after the search for this category.",
"default": false,
"nullable": true
},
"showInSearch": {
"type": "boolean",
"description": "This property is offered when searching for this category.",
"default": false,
"nullable": true
}
},
"additionalProperties": false,
"description": "A PropertyRef object describes the reference of this category to its assigned property. The propertyId is used to assign the property to the category.\r\n \r\nThe remaining parameters of the PropertyRef object describe the behavior of the assigned property within this exact category.\r\nFor example, the property can be defined as a required field for this category using the required parameter."
},
"description": "References to properties assigned to a category. Consists of an array of reference objects. By specifying the propertyId, the respective property is assigned to the category."
},
"protection": {
"type": "object",
"properties": {
"preventDeletion": {
"type": "boolean",
"description": "Prevents deletion of items in the status Release and Archive. The property overrules all Delete rights. If you specified a retention period for items of this category, the items are still deleted after the period expires.",
"default": false
},
"preventDeletionChangeReason": {
"type": "string",
"description": "Reason for changing the property preventDeletion. Is only required if you change the value preventDeletion from true to false.",
"nullable": true,
"example": ""
}
},
"additionalProperties": false,
"description": "A Protection object controls the extended protection of items of this type."
},
"readOnly": {
"type": "boolean",
"description": "A read-only property indicating whether a category has been predefined by the system and cannot be changed.",
"default": false,
"readOnly": true
},
"retention": {
"type": "object",
"properties": {
"basedOn": {
"type": "string",
"description": "The start time used to calculate the end of retention period for documents.\r\nLAST_EDITED: The end of the retention period is calculated starting from the modification date.\r\n[propertyId]: The end of retention period is calculated based on a date from a property of the category.",
"default": "LAST_EDITED",
"nullable": true,
"example": "LAST_EDITED | 00000000-0000-0000-0000-000000000000"
},
"period": {
"type": "number",
"description": "Retention period for documents of this type (0 means unlimited).",
"format": "double",
"default": 0,
"example": 50
},
"unit": {
"type": "string",
"description": "The unit in which the retention period is specified.",
"default": "YEARS",
"nullable": true,
"example": "YEARS | MONTHS"
}
},
"additionalProperties": false,
"description": "A retention object describes the length of time that documents in this category are to be stored in the repository."
},
"titleRefs": {
"type": "array",
"items": {
"required": [
"propertyId"
],
"type": "object",
"properties": {
"delimiter": {
"type": "string",
"description": "Separator that is inserted before this property.",
"default": " ",
"nullable": true
},
"propertyId": {
"minLength": 1,
"type": "string",
"description": "The unique ID of a property.",
"example": "00000000-0000-0000-0000-000000000000 | FILE_NAME"
}
},
"additionalProperties": false,
"description": "A TitleRef object describes a property that is used as a title field in this category.\r\nThe title of a document is automatically formed using the TitleRef configuration for its category and is displayed in the search match list, for example."
},
"description": "The title of a document of this category. It is composed of an array of objects.",
"nullable": true
},
"type": {
"minLength": 1,
"type": "string",
"description": "The type of the category.\r\nDOSSIER_TYPE: Dossier type\r\nDOCUMENT_TYPE: Document type",
"example": "DOCUMENT_TYPE | DOSSIER_TYPE"
}
}
Media type: application/hal+json
{
"id": {
"type": "string",
"description": "The unique ID of the category.",
"nullable": true,
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000"
},
"name": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "The display name of the category. Key pairs from the ID of the language (ISO 639-1 and RFC-3066) and the display name in the corresponding language.",
"example": {
"en": "Bill"
}
},
"propertyRefs": {
"type": "array",
"items": {
"required": [
"propertyId"
],
"type": "object",
"properties": {
"propertyId": {
"minLength": 1,
"type": "string",
"description": "The unique ID of a property.",
"example": "00000000-0000-0000-0000-000000000000"
},
"required": {
"type": "boolean",
"description": "Labels the property as mandatory within the category.",
"default": false,
"nullable": true
},
"showInFacets": {
"type": "boolean",
"description": "This property is offered as a facet when searching for this category.",
"default": false,
"nullable": true
},
"showInImport": {
"type": "boolean",
"description": "This property is offered for storage of this category.",
"default": false,
"nullable": true
},
"showInResult": {
"type": "boolean",
"description": "This property is shown in the result list after the search for this category.",
"default": false,
"nullable": true
},
"showInSearch": {
"type": "boolean",
"description": "This property is offered when searching for this category.",
"default": false,
"nullable": true
}
},
"additionalProperties": false,
"description": "A PropertyRef object describes the reference of this category to its assigned property. The propertyId is used to assign the property to the category.\r\n \r\nThe remaining parameters of the PropertyRef object describe the behavior of the assigned property within this exact category.\r\nFor example, the property can be defined as a required field for this category using the required parameter."
},
"description": "References to properties assigned to a category. Consists of an array of reference objects. By specifying the propertyId, the respective property is assigned to the category."
},
"protection": {
"type": "object",
"properties": {
"preventDeletion": {
"type": "boolean",
"description": "Prevents deletion of items in the status Release and Archive. The property overrules all Delete rights. If you specified a retention period for items of this category, the items are still deleted after the period expires.",
"default": false
},
"preventDeletionChangeReason": {
"type": "string",
"description": "Reason for changing the property preventDeletion. Is only required if you change the value preventDeletion from true to false.",
"nullable": true,
"example": ""
}
},
"additionalProperties": false,
"description": "A Protection object controls the extended protection of items of this type."
},
"readOnly": {
"type": "boolean",
"description": "A read-only property indicating whether a category has been predefined by the system and cannot be changed.",
"default": false,
"readOnly": true
},
"retention": {
"type": "object",
"properties": {
"basedOn": {
"type": "string",
"description": "The start time used to calculate the end of retention period for documents.\r\nLAST_EDITED: The end of the retention period is calculated starting from the modification date.\r\n[propertyId]: The end of retention period is calculated based on a date from a property of the category.",
"default": "LAST_EDITED",
"nullable": true,
"example": "LAST_EDITED | 00000000-0000-0000-0000-000000000000"
},
"period": {
"type": "number",
"description": "Retention period for documents of this type (0 means unlimited).",
"format": "double",
"default": 0,
"example": 50
},
"unit": {
"type": "string",
"description": "The unit in which the retention period is specified.",
"default": "YEARS",
"nullable": true,
"example": "YEARS | MONTHS"
}
},
"additionalProperties": false,
"description": "A retention object describes the length of time that documents in this category are to be stored in the repository."
},
"titleRefs": {
"type": "array",
"items": {
"required": [
"propertyId"
],
"type": "object",
"properties": {
"delimiter": {
"type": "string",
"description": "Separator that is inserted before this property.",
"default": " ",
"nullable": true
},
"propertyId": {
"minLength": 1,
"type": "string",
"description": "The unique ID of a property.",
"example": "00000000-0000-0000-0000-000000000000 | FILE_NAME"
}
},
"additionalProperties": false,
"description": "A TitleRef object describes a property that is used as a title field in this category.\r\nThe title of a document is automatically formed using the TitleRef configuration for its category and is displayed in the search match list, for example."
},
"description": "The title of a document of this category. It is composed of an array of objects.",
"nullable": true
},
"type": {
"minLength": 1,
"type": "string",
"description": "The type of the category.\r\nDOSSIER_TYPE: Dossier type\r\nDOCUMENT_TYPE: Document type",
"example": "DOCUMENT_TYPE | DOSSIER_TYPE"
}
}
404
The category with the specified ID could not be determined.
Content
Media type: application/json
{
"code": {
"type": "integer",
"format": "int32",
"example": 240100
},
"reason": {
"type": "string",
"nullable": true,
"example": "Reason why the request failed."
}
}
Media type: application/hal+json
{
"code": {
"type": "integer",
"format": "int32",
"example": 240100
},
"reason": {
"type": "string",
"nullable": true,
"example": "Reason why the request failed."
}
}
Show operation