Resource: ClassificationPagedCollection

About this resource

Representation of a paged collection of Classification items

Properties

Property	Description	Type
items	One page of this paged collection, which is a subcollection of the complete collection.	Collection of Classification items
page	The current page of this paged collection.	int32
pageSize	The current page size of this paged collection.	int32
skip	The current skip size of this paged collection.	int32
take	The current take size of this paged collection.	int32
totalCount	The total count of items in this paged collection, not just on the current page.	int64

Relations

Method	Name	Description
GET	self	Provides a link to this resource.
GET	first	A link to the first page of this paged collection.
GET	prev	A link to the previous page of this paged collection.
GET	next	A link to the next page of this paged collection.
GET	last	A link to the last page of this paged collection.

Actions

Method

Action

Description

Response codes

POST /classifications

create

Creates a new classification.

201	Request completed successfully. The header parameter 'Location' contains the location of the new classification resource. The response body is a JSON object which contains the property "id" that corresponds to the newly created classification resource.
400	Bad request (in general)
403	Insufficient permissions

Examples

Searching for classifications

The parameters are specified as http headers.

GET /classifications HTTP/1.1
accept: application/hal+json
filter: ModifiedOn in today
sort: createdon
page: 1
pageSize: 20

The parameters are specified as query string parameters.

GET /classifications?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10 HTTP/1.1

The parameters are specified as a combination of query string parameters and http headers.

GET /classifications?filter=ModifiedOn+in+today&sort=createdon HTTP/1.1
page: 1
pageSize: 20

Creating a new classification

POST /classifications HTTP/1.1s
{
	"parentNamePath": "/StoreInfo/Europe",
	"name": "Brand Related",
	"identifier": "brand_related",
	"sortIndex": 6,
	"sortOrder": "Label",
	"disabledInDAMUI":"false",
	"fields": {
		"addOrUpdate": [
			{
				"id": "7b4e156c-0730-45d9-b904-a3cd007c02a5",
				"localizedValues": [
					{
						"languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC",
						"value": "description - en"
					}
				]
			}
		]
	},
	"registeredFieldGroups":{
  						"addOrUpdate": ["34DFBAA2-98A3-4480-A9B2-2AD582304E0B"],
	},
	"registeredFields":{
  						"addOrUpdate": ["24DFBAA2-98A3-4480-A9B2-2AD582304E0B"]
  					},
	"labels": [
		{
			"languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC",
			"value": "Brands - English"
		},
		{
			"languageId": "1ED74A99-84CD-4A9C-BFEB-A4D000EC3275",
			"value": "Brands - Dutch"
		}
	],
	"followerclassifications": {
		"addOrUpdate": ["21d41eb183234b0cbe7b6a9c898b1de1", "21d41eb183234b0cbe7b6a9c898b1de1"]
	}
}

Valid combinations of the isRoot, parentId and parentNamePath properties:

isRoot	parentId	parentNamePath
true	unset	unset
false or unset	<valid id>	unset
false or unset	unset	<valid path>

For a more detailed example of values that can be provided when creating classifications, see: Editing a classification
See also: Immediate propagation for classification updates