Custom Instance
Retrieves all custom instances associated with a specific custom schema type.
Supports offset pagination (pageNumber, pageSize) and cursor pagination (next, prev). Cursor pagination is active when next or prev is provided.
In cursor mode:
nextandprevcannot be used together and return400.pageNumberis ignored.the
X-Total-Countrequest header is ignored and theX-Total-Countresponse header is not returned.
If no sort is provided, results are returned in _id:ASC order. If a sort is provided, _id:ASC is appended as a tie-breaker when _id is not already part of the sort.
When the emporix-site header is set, each site-aware mixin is deep-merged. {mixinName}__{siteCode} overlays the base {mixinName}, and only the merged base keys are returned. Without the header, base and overlay keys are returned unmerged. Accept-Language is applied after the site merge when emporix-site is present.
For v2 mixins, Accept-Language filters localized TEXT and OBJECT maps, including maps nested under plain objects and maps used as array items.
- : Read custom instances of any custom schema type.
- : Read custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_read`.
- : Allows to read only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_read_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTPage number to be retrieved. The number of the first page is 1.
1Number of items to be retrieved per page.
60List of properties used to sort the results, separated by colons. The order of properties indicates their priority in sorting.
Possible values:
{fieldName}{fieldName}:asc{fieldName}:desc
Note: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}:asc{fieldName}.{language}:desc
If the sorting direction is not specified, the fields are sorted in ascending order.
A standard query parameter is used to search for specific values.
- Searching for items by string-based properties:
- By a field value:
q=siteCode:main, wheresiteCodeis the field name, andmainis its desired value. - By a value that is not equal to the specified value:
q=id:!=64d35aa7fa54121ca47db657, whereidis the field name, and64d35aa7fa54121ca47db657is the excluded schema ID. - By a localized field value:
q=items.product.name.en:apple_lobo, wherenameis the field name of product,enis the language code, andapple_lobois the field value expressed in the specified language. Note: This query works only for localized fields, which are stored in a map format, wherekeyis the language code andvalueis the translation to particular language.
- By a field value:
- Searching for items by a number-based property:
- With a specific value:
q=items.quantity.quantity:20 - With a value greater than:
q=items.quantity.quantity:>20 - With a value lower than:
q=items.quantity.quantity:<20 - With a value greater than or equal to:
q=items.quantity.quantity:>=20 - With a value lower than or equal to:
q=items.quantity.quantity:<=20 - With a value within a range of values:
q=items.quantity.quantity:(>=10 AND <=20)
whereitems.quantity.quantityis the name of the number-based field, and20is its querying value.
- With a specific value:
- Searching for items by a date-based property: All number-based property queries are also valid for dates. In that case, the date should be placed within double quotes:
q=metadataCreatedAt:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z") - Searching for items by a boolean-based property:
q=description.multiLanguage:true, wheredescription.multiLanguageis the boolean field name, andtrueis its desired value. - Searching for items with a nonexistent or empty property:
q=description.en:null, wheredescription.enis the field that has its value set tonull. - Searching for items with an existing property:
q=mixins.mixinName:exists, where the specific mixin namedmixinNameexists in the database. - Searching for items by multiple specific values:
q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494), whereidis the field name, and strings within the bracket are the desired values. - Searching for items by multiple fields:
q=id:5c3325baa9812100098ff48f siteCode:mainwhereidandsiteCodeare field names. All objects that contain the specified values are returned. Multiple fields (separated by space) can be specified. Multiple values for each field can also be specified in the format presented earlier. - Searching for items with string-based properties conforming to a regex:
q=siteCode:~ainorq=code:(~U PL)- in case of searching for strings with space, wheresiteCodeis the name of the field, andainorU PLis its querying regex. - Searching for items with a localized string-based property conforming to a regex:
items.product.name.en:~(Yoghurt im)- wherenameis the product field name,enis the desired language, andJoghurt imis the search term.
siteCode:{main}Fields to be included in the response.
Fetches data about expanded references. You can provide full path to the reference, use wildcard character *, or provide a specific index (starting with 0) in array of references. Multiple paths can be specified by separating them with commas.
Examples:
customAttributes.references.product_reference- expands a specific reference*- expands all referencescustomAttributes.*- expands all references within customAttributescustomAttributes.references.customers_array.0- expands the first element in an array of references
Opaque cursor from the X-Next-Cursor response header. Use it to retrieve the next set of results.
Cannot be combined with prev in the same request; sending both returns 400 Bad Request.
When provided, cursor pagination is active: pageNumber is ignored and the X-Total-Count request header is ignored (the X-Total-Count response header is not returned).
Opaque cursor from the X-Prev-Cursor response header. Use it to retrieve the previous set of results. Cannot be combined with next in the same request; sending both returns 400 Bad Request. When provided, cursor pagination is active and pageNumber is ignored.
Flag indicating whether the total number of retrieved items should be returned.
falseExample: trueList of language codes acceptable for the custom-instance response, ordered by preference. If a value is specified, it must be present in the tenant configuration.
The following rules apply:
- A specific language or ordered list returns first-class localized fields as strings in the first matching language.
*returns first-class localized fields as maps of translations.- An omitted or empty header returns first-class localized fields as strings in the tenant's default language.
- For v2 mixin language maps, a specific language or ordered list returns the first matching non-null translation as a single-key map.
- A v2 mixin language map without a matching non-null translation is omitted. For a localized
OBJECT, a whole-fieldnullvalue is preserved. - In an array of language maps, an element without a matching translation is omitted.
*, an omitted header, or an empty header leaves full v2 mixin language maps unchanged.- v1
[{language,value}]mixin arrays remain unchanged.
Site code used to resolve site-aware mixin overlays. The following behaviors apply:
- When set – each
{mixinName}__{siteCode}overlay is deep-merged into the base{mixinName}value. Nested objects are merged recursively. Arrays and other non-object values are replaced by the overlay (not concatenated or merged by index). Non-null site values override base values for the same path. A null overlay node does not clear the base value. Only the merged base keys are returned. - When omitted or blank – base mixin keys and overlay keys are returned unmerged.
Accept-Language is applied after the site merge when emporix-site is present.
mainUnsupported language provided.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
GET /schema/{tenant}/custom-entities/{type}/instances HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "123",
"name": {
"en": "Report"
},
"type": "CUSTOM_DOCUMENT",
"owner": {
"type": "EMPLOYEE",
"userId": "00u4ukqvzlEP31sCk417"
},
"mixins": {
"productCustomAttributes": {
"inStock": true,
"populatirty": 1
}
},
"media": [
"media_id_1",
"media_id_2"
],
"metadata": {
"mixins": {
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/productCustomAttributesMixIn-v38.json"
},
"createdAt": "2025-04-17T13:00:00.000Z",
"modifiedAt": "2025-05-14T13:00:00.000Z",
"version": 3
}
},
{
"id": "456",
"name": {
"en": "Manual"
},
"type": "CUSTOM_DOCUMENT",
"owner": {
"type": "CUSTOMER",
"userId": "79474954",
"legalEntityId": "0149b1314144a01491314z128"
},
"media": [
"media_id_3"
],
"metadata": {
"createdAt": "2025-04-17T13:00:00.000Z",
"modifiedAt": "2025-04-17T13:00:00.000Z",
"version": 1
}
}
]Creates a custom instance entity associated with a given custom schema type.
For site-aware mixin schemas (siteAware: true), you can store per-site overlays in mixins under keys in the form {mixinName}__{siteCode}. Declare only the base mixin name in metadata.mixins. Overlay values are validated against the same JSON Schema as the base mixin. Overlay keys are rejected when the mixin schema is not site-aware.
- : Manage custom instances of any custom schema type.
- : Manage custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage`.
- : Allows to manage only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTWhen set to true, references are validated if the provided resources exist. If set to false, validation is skipped.
trueThe Content-Language request HTTP header defines language(s) of the payload.
deId of the custom instance.
Localized custom type name in a form of a map of translations.
Custom instance was successfully created.
Id of the created schema.
ID of the generated document.
Mixins validation failed.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
Conflict.
POST /schema/{tenant}/custom-entities/{type}/instances HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253
{
"id": "123",
"name": {
"en": "Report"
},
"mixins": {
"productCustomAttributes": {
"inStock": true,
"popularity": 1
}
},
"metadata": {
"mixins": {
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/productCustomAttributesMixIn-v38.json"
}
}
}{
"id": "123"
}Retrieves a single custom instance by id.
When the emporix-site header is set, each site-aware mixin is deep-merged. {mixinName}__{siteCode} overlays the base {mixinName}, and only the merged base keys are returned. Without the header, base and overlay keys are returned unmerged so integrations can inspect the stored data. Accept-Language is applied after the site merge when emporix-site is present.
For v2 mixins, Accept-Language filters localized TEXT and OBJECT maps, including maps nested under plain objects and maps used as array items.
- : Read custom instances of any custom schema type.
- : Read custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_read`.
- : Allows to read only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_read_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTUnique identifier of the entity.
Fetches data about expanded references. You can provide full path to the reference, use wildcard character *, or provide a specific index (starting with 0) in array of references. Multiple paths can be specified by separating them with commas.
Examples:
customAttributes.references.product_reference- expands a specific reference*- expands all referencescustomAttributes.*- expands all references within customAttributescustomAttributes.references.customers_array.0- expands the first element in an array of references
List of language codes acceptable for the custom-instance response, ordered by preference. If a value is specified, it must be present in the tenant configuration.
The following rules apply:
- A specific language or ordered list returns first-class localized fields as strings in the first matching language.
*returns first-class localized fields as maps of translations.- An omitted or empty header returns first-class localized fields as strings in the tenant's default language.
- For v2 mixin language maps, a specific language or ordered list returns the first matching non-null translation as a single-key map.
- A v2 mixin language map without a matching non-null translation is omitted. For a localized
OBJECT, a whole-fieldnullvalue is preserved. - In an array of language maps, an element without a matching translation is omitted.
*, an omitted header, or an empty header leaves full v2 mixin language maps unchanged.- v1
[{language,value}]mixin arrays remain unchanged.
Site code used to resolve site-aware mixin overlays. The following behaviors apply:
- When set – each
{mixinName}__{siteCode}overlay is deep-merged into the base{mixinName}value. Nested objects are merged recursively. Arrays and other non-object values are replaced by the overlay (not concatenated or merged by index). Non-null site values override base values for the same path. A null overlay node does not clear the base value. Only the merged base keys are returned. - When omitted or blank – base mixin keys and overlay keys are returned unmerged.
Accept-Language is applied after the site merge when emporix-site is present.
mainUnique identifier of the custom instance.
Localized custom type name in a form of a map of translations.
Custom schema type to which custom instance is related.
List of media IDs assigned to the custom instance.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
Given resource cannot be found.
GET /schema/{tenant}/custom-entities/{type}/instances/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "123",
"name": {
"en": "Report"
},
"type": "CUSTOM_DOCUMENT",
"owner": {
"type": "EMPLOYEE",
"userId": "00u4ukqvzlEP31sCk417"
},
"mixins": {
"productCustomAttributes": {
"inStock": true,
"populatirty": 1
}
},
"media": [
"media_id_1",
"media_id_2"
],
"metadata": {
"mixins": {
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/productCustomAttributesMixIn-v38.json"
},
"createdAt": "2025-04-17T13:00:00.000Z",
"modifiedAt": "2025-05-14T13:00:00.000Z",
"version": 3
}
}Performs the UPSERT operation. If a custom instance with the specified ID exists in the system, then it is updated. If it does not exist, a new custom instance is created.
For site-aware mixin schemas (siteAware: true), you can store per-site overlays in mixins under keys in the form {mixinName}__{siteCode}. Declare only the base mixin name in metadata.mixins. Overlay values are validated against the same JSON Schema as the base mixin. Overlay keys are rejected when the mixin schema is not site-aware.
- : Manage custom instances of any custom schema type.
- : Manage custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage`.
- : Allows to manage only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTUnique identifier of the entity.
When set to true, references are validated if the provided resources exist. If set to false, validation is skipped.
trueThe Content-Language request HTTP header defines language(s) of the payload.
deLocalized custom type name in a form of a map of translations.
Custom instance was successfully created.
Id of the created schema.
ID of the generated document.
Custom instance was successfully updated
Mixins validation failed.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
Conflict.
PUT /schema/{tenant}/custom-entities/{type}/instances/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 255
{
"name": {
"en": "Report"
},
"mixins": {
"productCustomAttributes": {
"inStock": false,
"popularity": 2
}
},
"metadata": {
"mixins": {
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/productCustomAttributesMixIn-v38.json"
},
"version": 1
}
}{
"id": "123"
}Deletes a custom instance.
- : Manage custom instances of any custom schema type.
- : Manage custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage`.
- : Allows to manage only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTUnique identifier of the entity.
No content
No content
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
DELETE /schema/{tenant}/custom-entities/{type}/instances/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Partially updates a custom instance. The patch request consists of a set of operations that should be defined according to the RFC-6902 standard.
To append a row to an array mixin field, use add with a path ending in /-. See the Append to an array mixin field example.
- : Manage custom instances of any custom schema type.
- : Manage custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage`.
- : Allows to manage only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTUnique identifier of the entity.
When set to true, references are validated if the provided resources exist. If set to false, validation is skipped.
trueThe Content-Language request HTTP header defines language(s) of the payload.
deIndicates an operation which should be done on a return. Available operations: add remove and replace
Path to the field to update.
Examples: /name, /mixins/additionalAttributes/externalId, /mixins/additionalAttributes/careInstructions/1.
To append an item to an array mixin field (for example, a table row), use add with a path ending in /-. The - means append after the last element.
Indicates a value that should be changed or added. The value can be of a primitive type, like string, number, boolean or it can be an object or an array.
Custom instance was successfully patched
No content
Mixins validation failed.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
Given resource cannot be found.
PATCH /schema/{tenant}/custom-entities/{type}/instances/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
[
{
"op": "replace",
"path": "/name",
"value": {
"en": "New name"
}
}
]No content
Returns all custom instances for the provided type that match the specified criteria.
Supports offset pagination (pageNumber, pageSize) and cursor pagination (next, prev). Cursor pagination is active when next or prev is provided.
In cursor mode:
nextandprevcannot be used together and return400.pageNumberis ignored.the
X-Total-Countrequest header is ignored and theX-Total-Countresponse header is not returned.
If no sort is provided, results are returned in _id:ASC order. If a sort is provided, _id:ASC is appended as a tie-breaker when _id is not already part of the sort.
When the emporix-site header is set, each site-aware mixin is deep-merged. {mixinName}__{siteCode} overlays the base {mixinName}, and only the merged base keys are returned. Without the header, base and overlay keys are returned unmerged. Accept-Language is applied after the site merge when emporix-site is present.
For v2 mixins, Accept-Language filters localized TEXT and OBJECT maps, including maps nested under plain objects and maps used as array items.
- : Read custom instances of any custom schema type.
- : Read custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_read`.
- : Allows to read only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_read_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTPage number to be retrieved. The number of the first page is 1.
1Number of items to be retrieved per page.
60List of properties used to sort the results, separated by colons. The order of properties indicates their priority in sorting.
Possible values:
{fieldName}{fieldName}:asc{fieldName}:desc
Note: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}:asc{fieldName}.{language}:desc
If the sorting direction is not specified, the fields are sorted in ascending order.
Fields to be included in the response.
Fetches data about expanded references. You can provide full path to the reference, use wildcard character *, or provide a specific index (starting with 0) in array of references. Multiple paths can be specified by separating them with commas.
Examples:
customAttributes.references.product_reference- expands a specific reference*- expands all referencescustomAttributes.*- expands all references within customAttributescustomAttributes.references.customers_array.0- expands the first element in an array of references
Opaque cursor from the X-Next-Cursor response header. Use it to retrieve the next set of results.
Cannot be combined with prev in the same request; sending both returns 400 Bad Request.
When provided, cursor pagination is active: pageNumber is ignored and the X-Total-Count request header is ignored (the X-Total-Count response header is not returned).
Opaque cursor from the X-Prev-Cursor response header. Use it to retrieve the previous set of results. Cannot be combined with next in the same request; sending both returns 400 Bad Request. When provided, cursor pagination is active and pageNumber is ignored.
Flag indicating whether the total number of retrieved items should be returned.
falseExample: trueList of language codes acceptable for the custom-instance response, ordered by preference. If a value is specified, it must be present in the tenant configuration.
The following rules apply:
- A specific language or ordered list returns first-class localized fields as strings in the first matching language.
*returns first-class localized fields as maps of translations.- An omitted or empty header returns first-class localized fields as strings in the tenant's default language.
- For v2 mixin language maps, a specific language or ordered list returns the first matching non-null translation as a single-key map.
- A v2 mixin language map without a matching non-null translation is omitted. For a localized
OBJECT, a whole-fieldnullvalue is preserved. - In an array of language maps, an element without a matching translation is omitted.
*, an omitted header, or an empty header leaves full v2 mixin language maps unchanged.- v1
[{language,value}]mixin arrays remain unchanged.
Site code used to resolve site-aware mixin overlays. The following behaviors apply:
- When set – each
{mixinName}__{siteCode}overlay is deep-merged into the base{mixinName}value. Nested objects are merged recursively. Arrays and other non-object values are replaced by the overlay (not concatenated or merged by index). Non-null site values override base values for the same path. A null overlay node does not clear the base value. Only the merged base keys are returned. - When omitted or blank – base mixin keys and overlay keys are returned unmerged.
Accept-Language is applied after the site merge when emporix-site is present.
mainA standard query parameter used to search for specific values.
Custom instances succesfully retrieved
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
POST /schema/{tenant}/custom-entities/{type}/instances/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"q": "mixins.productCustomAttributes.inStock:true"
}[
{
"id": "123",
"name": {
"en": "Report"
},
"type": "CUSTOM_DOCUMENT",
"owner": {
"type": "EMPLOYEE",
"userId": "00u4ukqvzlEP31sCk417"
},
"mixins": {
"productCustomAttributes": {
"inStock": true,
"populatirty": 1
}
},
"media": [
"media_id_1",
"media_id_2"
],
"metadata": {
"mixins": {
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/productCustomAttributesMixIn-v38.json"
},
"createdAt": "2025-04-17T13:00:00.000Z",
"modifiedAt": "2025-05-14T13:00:00.000Z",
"version": 3
}
}
]Creates multiple custom instances. The maximum batch size is 200.
- : Manage custom instances of any custom schema type.
- : Manage custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage`.
- : Allows to manage only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTWhen set to true, references are validated if the provided resources exist. If set to false, validation is skipped.
falseId of the custom instance.
Localized custom type name in a form of a map of translations.
Bulk operation was successful
Index of the processed item, matching the item position in request body.
HTTP Status Code.
HTTP Status description
Error message.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
POST /schema/{tenant}/custom-entities/{type}/instances/bulk HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 291
[
{
"id": "123",
"name": {
"en": "Report"
},
"mixins": {
"productCustomAttributes": {
"inStock": true,
"popularity": 1
}
},
"metadata": {
"mixins": {
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/productCustomAttributesMixIn-v38.json"
}
}
},
{
"id": "456",
"name": {
"en": "Manual"
}
}
][
{
"index": 0,
"code": 201,
"status": "Created"
},
{
"index": 1,
"code": 409,
"status": "Conflict",
"message": "Custom instance with id='456' already exists for type='CUSTOM'"
}
]Upserts multiple custom instances. The maximum batch size is 200.
- : Manage custom instances of any custom schema type.
- : Manage custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage`.
- : Allows to manage only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTWhen set to true, references are validated if the provided resources exist. If set to false, validation is skipped.
falseCustom instance id
Localized custom type name in a form of a map of translations.
Bulk operation was successful
Index of the processed item, matching the item position in request body.
HTTP Status Code.
HTTP Status description
Error message.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
PUT /schema/{tenant}/custom-entities/{type}/instances/bulk HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 291
[
{
"id": "123",
"name": {
"en": "Report"
},
"mixins": {
"productCustomAttributes": {
"inStock": true,
"popularity": 1
}
},
"metadata": {
"mixins": {
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/productCustomAttributesMixIn-v38.json"
}
}
},
{
"id": "456",
"name": {
"en": "Manual"
}
}
][
{
"index": 0,
"code": 201,
"status": "Created"
},
{
"index": 1,
"code": 204,
"status": "No Content"
}
]Removes multiple custom instances.
Note: The IDs of items should be defined in the request body as an array of strings.
Example: ["firstId", "secondId", "thirdId"]
- : Manage custom instances of any custom schema type.
- : Manage custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage`.
- : Allows to manage only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTBulk operation was successful
Index of the processed item, matching the item position in request body.
HTTP Status Code.
HTTP Status description
Error message.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
DELETE /schema/{tenant}/custom-entities/{type}/instances/bulk HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"index": 0,
"code": 204,
"status": "No Content"
},
{
"index": 1,
"code": 204,
"status": "No Content"
}
]Partially updates multiple custom instances in a single request. Each item must contain the custom instance id and a list of patch operations.
The maximum batch size is 200.
- : Manage custom instances of any custom schema type.
- : Manage custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage`.
- : Allows to manage only your own custom instances of a given type. For example, for type `DOCUMENT` → `custom.document_manage_own`.
Your Emporix tenant name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Custom schema type to which the custom instance is associated.
CUSTOM_DOCUMENTWhen set to true, references are validated if the provided resources exist. If set to false, validation is skipped.
trueThe Content-Language request HTTP header defines language(s) of the payload.
deUnique identifier of the custom instance to patch.
Bulk patch was processed. Each item contains its own result status.
Index of the processed item, matching the item position in request body.
HTTP Status Code.
HTTP Status description
Error message.
Mixins validation failed.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that the tenant from the token does not match tenant from path.
Permission denied due to insufficient rights. This may happen when the request does not contain sufficient scopes for the given query values.
PATCH /schema/{tenant}/custom-entities/{type}/instances/bulk HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204
[
{
"id": "Ford",
"data": [
{
"op": "REPLACE",
"path": "/name/en",
"value": "Ford bulk patched"
}
]
},
{
"id": "Aston_Martin",
"data": [
{
"op": "REPLACE",
"path": "/mixins/productCustomAttributes/minOrderQuantity",
"value": 10
}
]
}
][
{
"index": 0,
"id": "Ford",
"code": 204,
"status": "No Content"
},
{
"index": 1,
"code": 404,
"status": "Not Found"
}
]Last updated
Was this helpful?

