Assignment Resources
Was this helpful?
Was this helpful?
Manage Assignments
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
saasdev2Assignment's reference unique identifier, for example: productId.
44170435If set to true, resources assigned to not published categories are retrieved as well.
Possible values:
truefalse
Note: To get unpublished categories you need to have category.category_read_unpublished scope.falseExample: trueIf set to true, each entry is enriched with supercategoriesIds field containing supercategories ids.
Possible values:
truefalsefalseExample: truePage number to be retrieved. The number of the first page is 1.
Note: If the pageNumber parameter is passed, size of the pages must be specified in the pageSize parameter.
1Number of export files to be retrieved per page.
60List of properties used to sort the results, separated by commas. This list is validated against available fields. Sorting by deprecated field is forbidden. Possible values:
{fieldName}:ASC{fieldName}:DESC{fieldName}:ASC,{fieldName2}:DESC{internationalizedFieldName.en}:ASC - contains localized field name and extension. Valid only if Accepted-language header contains this extension and it is supported by configuration of the tenant. If all language are accepted (Accept-language='*') then extension must exist in tenant configuration. No other sorting are allowed for this specific internationalized field.{internationalizedFieldName}:ASC - contains only localized field name. Extension will be deducted based on Accept-language header. If all language are accepted (Accept-language='*') then extension is taken from tenant configuration and is equal to default language. In other case the language with highest priority is taken. No other sorting are allowed for this specific localized field.{fieldName}:ASC,{fieldName2}:DESCList of properties used to project and sort the results, separated by commas. Possible values:
* - each internationalized field is returned as a map containing all available (specified in tenant configuration) translations. This is also the default behaviour if the header is not set.en, en,de - each internationalized field is returned as a map containing translation specified by a header value. If translation is not supported by tenant configuration then exception is thrown. First language is the one with highest priority.fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5 - each internationalized field is returned as a map containing translation specified by a header value. If translation is not supported by tenant configuration then exception is thrown.*Example: `*`, `en`, `en,de,fr`, `en-EN`, `fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7`To use this endpoint you have to add X-Version header with proper value to your request.
Note: The header value has to match following regular expression: ^v[1-9][0-9]?$
v2Pattern: ^v[1-9][0-9]?$The header value indicates if the total count of entities should be returned. Possible values:
truefalse
Default value: falsefalseExample: trueGET /category/{tenant}/assignments/references/{referenceId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
X-Version: v2
Accept: */*
[
{
"id": "text",
"parentId": "text",
"localizedName": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"localizedDescription": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"localizedSlug": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"code": "text",
"ecn": [
"text"
],
"Validity": {
"from": "2025-06-21T13:19:59.601Z",
"to": "2025-06-21T13:19:59.601Z"
},
"position": 1,
"published": true,
"supercategoriesIds": [
"text"
],
"mixins": {},
"Metadata": {
"createdAt": "2025-06-21T13:19:59.601Z",
"modifiedAt": "2025-06-21T13:19:59.601Z",
"version": 1,
"mixins": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"media": [
{
"id": "345-12345",
"url": "https://emporix.com/platform/saas-ag/media/v2/public/files/12345678",
"contentType": "image/jpeg",
"metadata": {
"createdAt": "2022-12-06T06:54:36.834Z"
},
"customAttributes": {
"id": "345-54353",
"height": 1234,
"width": 1024,
"sizeKB": 5,
"type": "jpg",
"name": "ima.jpg"
}
}
]
}
]Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
saasdev2Assignment's reference unique identifier, for example: productId.
1256792345To use this endpoint you have to add X-Version header with proper value to your request.
Note: The header value has to match following regular expression: ^v[1-9][0-9]?$
v2Pattern: ^v[1-9][0-9]?$DELETE /category/{tenant}/assignments/references/{referenceId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
X-Version: v2
Accept: */*
{}