Resource: Classification

About this resource

Representation of a Classification

Properties

Property	Description	Type
createdOn	Gets the creation datetime in UTC time.	datetime
disabledInDAMUI	Gets the property used to indicate whether this classification is disabled in DAM UI.	boolean
hasChildren	Indicates if the classiciation has child classifications. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-classification' and the value 'HasChildren' to your request.	boolean
id	Gets the Id of this classification.	guid
identifier	Gets the identifier of this classification.	string
isRoot	Indicates if the classification is a root classification.	boolean
labelPath	Gets the full label path of this classification. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-classification' and the value 'LabelPath' to your request.	string
labels	A collection of Label items.	LabelCollection
modifiedOn	Gets the last modification datetime in UTC time.	datetime
name	Gets the name of this classification.	string
namePath	Gets the full name path of this classification. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-classification' and the value 'NamePath' to your request.	string
parentId	Gets the Id of the parent of this classification.	guid
registeredFieldGroups	A collection of Registered Field Group items.	RegisteredFieldGroupCollection
registeredFields	A collection of Registered Field items.	RegisteredFieldCollection
sortIndex	Gets the index of this classification. This index indicates where this classification is sorted in the list of children of the parent of this classification.	int32
sortOrder	Get the property used to sort the child classifications of this classification.	string
tag	Gets or sets the value for the Tag of this object. The value of this property has to be valid Xml. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-classification' and the value 'Tag' to your request.	string

Relations

Method	Name	Select-key	Resource type	Description
GET	self			Provides a link to this resource.
GET	parent	select-Classification: parent	Classification	Gets the classification that is the parent of this classification.
GET	ancestors	select-Classification: ancestors	LinkedClassificationCollection	Gets the ancestors of this classification
GET	children	select-Classification: children	ClassificationCollection	Gets the children classification of this classification.
GET	image	select-Classification: image	Image	Gets the classification's image
GET	fields	select-Classification: fields	FieldCollection	Gets the collection containing all the textfields of this classification.
GET	recordpermissions	select-Classification: recordpermissions	ClassificationPermissions	Gets the collection containing all the record permissions of this classification.
GET	downloadpermissions	select-Classification: downloadpermissions	ClassificationDownloadPermissions	Gets the collection containing all the download permissions of this classification.
GET	classificationtreepermissions	select-Classification: classificationtreepermissions	ClassificationPermissions	Gets the collection containing all the classification tree permissions of this classification.
GET	followerclassifications	select-Classification: followerclassifications	ClassificationCollection	Gets the collection containing all the classifications this classification maps to.
GET	classificationtreepermission	select-Classification: classificationtreepermission	ClassificationUserPermissions	Gets permissions the user has on this classification.
GET	modifiedby	select-Classification: modifiedby	User	Gets or sets the user that last modified this resource.
GET	createdby	select-Classification: createdby	User	Gets or sets the user that created this resource.

Actions

Method

Action

Description

Response codes

PUT /classification/{classificationId}

edit

Edits an existing classification.

204	Request completed successfully
400	Bad request (in general)
403	Insufficient permissions
404	Classification not found

DELETE /classification/{classificationId}

delete

Deletes an existing classification.

204	Request completed successfully
403	Insufficient permissions
404	Classification not found

PUT /classification/{classificationId}/recordpermissions

recordpermissionsedit

Set the record permissions of a classification.

204	Request completed successfully
400	Bad Request
403	Insufficient permissions
404	Classification not found

PUT /classification/{classificationId}/downloadpermissions

downloadpermissionsedit

Set the download permissions of the classification.

204	Request completed successfully
400	Bad Request
403	Insufficient permissions
404	Classification not found

PUT /classification/{classificationId}/classificationtreepermissions

classificationtreepermissionsedit

Set the classification tree permissions of a classification.

204	Request completed successfully
400	Bad Request
403	Insufficient permissions
404	Classification not found

Examples

Reading a classification using a name path

GET /classification/?namePath={urlEncodedNamePath} HTTP/1.1
accept: application/hal+json

{
"_links": {
		"parent": {s
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/parent",
			"select-key": "parent"
		},
		"ancestors": {
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/ancestors",
			"select-key": "ancestors"
		},
		"children": {
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/children",
			"select-key": "children"
		},
		"image": {
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/image",
			"select-key": "image"
		},
		"fields": {
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/fields",
			"select-key": "fields"
		},
		"recordpermissions": {
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/recordpermissions",
			"select-key": "recordpermissions"
		},
		"classificationtreepermissions": {
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/classificationtreepermissions",
			"select-key": "classificationtreepermissions"
		},
		"followerclassifications": {
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/followerclassifications",
			"select-key": "followerclassifications"
		},
		"modifiedby": {
			"href": "/user/fa286193ddbf44299d2ea2390e2a8b99",
			"select-key": "modifiedby"
		},
		"createdby": {
			"href": "/user/fa286193ddbf44299d2ea2390e2a8b99",
			"select-key": "createdby"
		},
		"self": {
			"href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc"
		}
	},
	"id": "28d96d5c7c8b41bcb8f4a68800b82adc",
	"identifier": "Test4",
	"name": "Test4",
	"namePath": null,
	"sortIndex": 6,
	"sortOrder": "Label",
	"disabledInDAMUI":"true",
	"labels": [
		{
			"value": "Test4",
			"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc"
		}
	],
	"isRoot": true,
	"parentId": null,
	"hasChildren": null,
	"tag": null,
	"modifiedOn": "2016-09-21T11:10:59.757Z",
	"createdOn": "2016-09-21T11:10:31.983Z"
}

Reading a classification using unique identifier

GET /classification/b54b7d7534944e91a8eea68700d85825 HTTP/1.1
accept: application/hal+json

{
	"_links": {
		"parent": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825/parent",
			"select-key": "parent"
		},
		"ancestors": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825/ancestors",
			"select-key": "ancestors"
		},
		"children": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825/children",
			"select-key": "children"
		},
		"image": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825/image",
			"select-key": "image"
		},
		"fields": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825/fields",
			"select-key": "fields"
		},
		"recordpermissions": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825/recordpermissions",
			"select-key": "recordpermissions"
		},
		"classificationtreepermissions": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825/classificationtreepermissions",
			"select-key": "classificationtreepermissions"
		},
		"followerclassifications": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825/followerclassifications",
			"select-key": "followerclassifications"
		},
		"modifiedby": {
			"href": "/user/fa286193ddbf44299d2ea2390e2a8b99",
			"select-key": "modifiedby"
		},
		"createdby": {
			"href": "/user/fa286193ddbf44299d2ea2390e2a8b99",
			"select-key": "createdby"
		},
		"self": {
			"href": "/classification/b54b7d7534944e91a8eea68700d85825"
		}
	},
	"id": "b54b7d7534944e91a8eea68700d85825",
	"identifier": "Test3",
	"name": "Test3",
	"namePath": null,
	"sortIndex": 5,
	"sortOrder": "Label",
	"disabledInDAMUI":"true",
	"labels": [
		{
			"value": "Test3",
			"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc"
		}
	],
	"isRoot": true,
	"parentId": null,
	"hasChildren": null,
	"tag": null,
	"modifiedOn": "2016-09-20T13:07:50.893Z",
	"createdOn": "2016-09-20T13:07:41.133Z"
}

Immediate propagation for classification updates.

For POST, PUT and DELETE operations on the /classification resource you can force an immediate update of the search index, or immediate propagation. To do so, add the boolean header/query-string parameter set-immediateSearchIndexUpdate and set it to "true". If you don't specify this parameter, or set it to "false", the change will be added to the queue of the Enterprise search synchronization process. Setting the parameter to true will immediately push the classification changes to the search index, so that this classification can immediately be found, e.g. while an ETL import is still running. This is important, for example, when importing both the child and parent classifications.

PUT /classification/1fe6e87a31bc4208bd1ca4f000dbfaff
"set-immediateSearchIndexUpdate": "true",
{
"name": "Digital Images",
"identifer": "digital_images",
"sortIndex": 6,
...
}

Editing a classification (full body)

PUT /classification/1fe6e87a31bc4208bd1ca4f000dbfaff
{
	"name": "Digital Images",
	"identifer": "digital_images",
	"sortIndex": 6,
	"sortOrder": "Label",
	"disabledInDAMUI":"false",
	"fields": {
		"addOrUpdate": [
			{
				"id": "7B4E156C-0730-45D9-B904-A3CD007C02A5",
				"localizedValues": [
					{
						"languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC",
						"value": "All images coming from a digital source"
					}
				]
			},
			{
				"id": "AB57432B-C899-40CF-BD44-802D5201973C",
				"sortIndex": 1
			}
		],
		"remove": [
			{
				"id": "1A5842C2-3204-41F9-9527-D7E2F293131E"
			},
			{
				"id": "D78B9DA1-A1E2-4DBE-8E2A-8F8FA62667F5"
			}
		]
	},
	"registeredFields": {
		"addOrUpdate": [ "6A5842C2-3204-41F9-9527-D7E2F293131E" ],
		"remove": [ "7A5842C2-3204-41F9-9527-D7E2F293131E" ]
	},
	"registeredFieldGroups": {
		"addOrUpdate": [ "8A5842C2-3204-41F9-9527-D7E2F293131E" ],
		"remove": [ "9A5842C2-3204-41F9-9527-D7E2F293131E" ]
	}
	"labels": [
		{
			"languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC",
			"value": "Brands - English"
		},
		{
			"languageId": "1ED74A99-84CD-4A9C-BFEB-A4D000EC3275",
			"value": "Brands - Dutch"
		}
	],
	"followerclassifications": {
		"addOrUpdate": ["21d41eb183234b0cbe7b6a9c898b1de1", "21d41eb183234b0cbe7b6a9c898b1de1"],
		"remove":[ "21d41eb183234b0cbe7b6a9c898b1de1 ]
	}
}

Field operations are similar to editing fields on a record.
For more detailed examples of such operations and the field values that can be provided when creating or editing classifications, see Editing a record.
Labels cannot be added or removed, but their value can be set or cleared.
A languageId and value should always be specified. Explicitly specifying a null value clears the label.

Editing a classification (attributes only)

PUT /classification/1fe6e87a31bc4208bd1ca4f000dbfaff
{
	"name": "New Classification Name"
}

Deleting a classification

DELETE /classification/8735a5a3e75a4bc0a2a1a3cd0069b669

Editing record or classification tree permissions on a classification

There are two different endpoints for classification permissions: recordpermissions and classificationtreepermissions

Both endpoints accept the same request body:

PUT /classification/8735a5a3e75a4bc0a2a1a3cd0069b669/{recordpermissions|classificationtreepermissions}
{
	"breakInheritance":false,
	"permissions": {
		"addOrUpdate": [
			{
					"userGroupId":"21d41eb183234b0cbe7b6a9c898b1de1",
					"accessRight":"Read"
			},
			{
					"userGroupId":"21d41eb183234b0cbe7b6a9c898b1de1",
					"accessRight":"FullControl"
			}
		],
		"remove": [
			{
					"userGroupId":"21d41eb183234b0cbe7b6a9c898b1de1
			}
		]
	}
}

For a full overview, see the complete list of access rights.

Editing download permissions on a classification

The following example shows the request body for the endpoint:

PUT /classification/8735a5a3e75a4bc0a2a1a3cd0069b669/downloadpermissions
{
	"breakInheritance":false,
	"permissions": {
		"addOrUpdate": [
			{
					"userGroupId":"e688500cc109488f959da82b0093014a",
					"accessRight":"Allow"
			}
		],
		"remove": [
			{
					"userGroupId": "0cb08fb798d74d369e75e017350f8378"
			}
		]
	}
}

For a full overview, see the complete list of download rights.

Follower Classifications

A follower classification is a classification that is mapped to another classification, so that records automatically get linked to that follower classification once they are linked to the leader classification. They can be configured through the creation of a classification and/or editing of a classification.

By adding the header value "select-classification: followerClassifications" all follower classifications of the current classification will be returned.

GET /classification/id
select-classification: FollowerClassifications

The body of the editing request is in the following format:

PUT /classification/8735a5a3e75a4bc0a2a1a3cd0069b669
{
	"followerclassifications": {
		"addOrUpdate": [ "ae82e88999d8479ab48ca3cd0069b4ba" ],
		"remove": [ "ae82e88999d8479ab48ca3cd0069b4ba" ]
	}
}

Reading a user's classification tree permissions

This endpoint will return the classification tree permissions of the given classification for the calling user.

GET /classification/8735a5a3e75a4bc0a2a1a3cd0069b669/classificationtreepermission

The following response will be returned indicating the user's tree permissions:

{
	"canRead": true,
	"canClassify": true,
	"canModify": false,
	"canDelete": false
}