Custom Schema Type
Was this helpful?
Was this helpful?
Retrieves a single custom schema type by id.
Your Emporix tenant's name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Unique id of the custom type.
Determines whether the response will include information about associated schemas.
falseList of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields. If a value is specified, then it must be present in the tenant configuration.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.GET /schema/{tenant}/custom-entities/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "CUSTOM_PRODUCT",
"name": {
"en": "Custom Product Type"
},
"metadata": {
"createdAt": "2023-08-09T09:21:42.693Z",
"modifiedAt": "2023-08-09T09:21:42.693Z",
"version": 1
}
}Deletes a single custom type. This operation will fail if there are schemas or custom instances assigned to this custom type.
Required scopes
schema.schema_manage - required for removing custom schema type
Your Emporix tenant's name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Unique id of the custom type.
DELETE /schema/{tenant}/custom-entities/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Retrieves all custom schema types.
Your Emporix tenant's name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Page 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}:descNote: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}:asc{fieldName}.{language}:descIf the sorting direction is not specified, the fields are sorted in ascending order.
A standard query parameter is used to search for specific values.
q=siteCode:main, where siteCode is the field name, and main is its desired value.q=items.product.name.en:apple_lobo, where name is the field name of product, en is the language code, and apple_lobo is the field value expressed in the specified language. Note: This query works only for localized fields, which are stored in a map format, where key is the language code and value is the translation to particular language.q=items.quantity.quantity:20q=items.quantity.quantity:>20q=items.quantity.quantity:<20q=items.quantity.quantity:>=20q=items.quantity.quantity:<=20q=items.quantity.quantity:(>=10 AND <=20)items.quantity.quantity is the name of the number-based field, and 20 is its querying value.q=metadataCreatedAt:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z")q=description.multiLanguage:true, where description.multiLanguage is the boolean field name, and true is its desired value.q=description.en:null, where description.en is the field that has its value set to null.q=mixin:exists, where mixin is the field that has a non-empty value.q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494), where id is the field name, and strings within the bracket are the desired values.q=id:5c3325baa9812100098ff48f siteCode:main where id and siteCode are 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.q=siteCode:~ain or q=code:(~U PL) - in case of searching for strings with space, where siteCode is the name of the field, and ain or U PL is its querying regex.items.product.name.en:~(Yoghurt im) - where name is the product field name, en is the desired language, and Joghurt im is the search term.siteCode:{main}Fields to be included in the response.
Determines whether the response will include information about associated schemas.
falseFlag indicating whether the total number of retrieved items should be returned.
falseExample: trueList of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields. If a value is specified, then it must be present in the tenant configuration.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.GET /schema/{tenant}/custom-entities HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "CUSTOM_PRODUCT",
"name": {
"en": "Custom Product Type"
},
"metadata": {
"createdAt": "2023-08-09T09:21:42.693Z",
"modifiedAt": "2023-08-09T09:21:42.693Z",
"version": 1
}
},
{
"code": "DOCUMENT",
"name": {
"en": "Documents"
},
"metadata": {
"createdAt": "2023-08-10T10:15:30.123Z",
"modifiedAt": "2023-08-19T10:15:30.123Z",
"version": 2
}
}
]Your Emporix tenant's name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$The Content-Language request HTTP header defines language(s) of the payload.
deUnique code for the custom type. Can only contain uppercase letters and underscores.
Localized custom type name in a form of a map of translations.
POST /schema/{tenant}/custom-entities HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"id": "CUSTOM_PRODUCT",
"name": {
"en": "Custom Product Type"
}
}{
"id": "CUSTOM_PRODUCT"
}Performs the UPSERT operation. If a custom schema type with specified ID exists in the system, then it is updated. If it doesn't exist, a new type is created.
Required scopes
schema.schema_manage - required for upserting custom schema type
Your Emporix tenant's name.
Note: Always write the tenant name in lowercase.
^[a-z][a-z0-9]+$Unique id of the custom type.
The Content-Language request HTTP header defines language(s) of the payload.
deLocalized custom type name in a form of a map of translations.
PUT /schema/{tenant}/custom-entities/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"name": {
"en": "Updated Custom Type"
},
"metadata": {
"version": 1
}
}{
"id": "CUSTOM_PRODUCT"
}