Ctrlk
CommunitySupport PortalYouTubeFree trialSign Up!
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Custom Schema Type

Retrieving all custom schema types

get

Retrieves all custom schema types.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: Always write the tenant name in lowercase.

Pattern: ^[a-z][a-z0-9]+$
Query parameters
pageNumberinteger · min: 1Optional

Page number to be retrieved. The number of the first page is 1.

Default: 1
pageSizeinteger · min: 1Optional

Number of items to be retrieved per page.

Default: 60
sortstringOptional

List 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.

qstringOptional

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, where siteCode is the field name, and main is its desired value.
    • By a localized field 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.
  • 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)
      where items.quantity.quantity is the name of the number-based field, and 20 is its querying 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, where description.multiLanguage is the boolean field name, and true is its desired value.
  • Searching for items with a nonexistent or empty property: q=description.en:null, where description.en is the field that has its value set to null.
  • Searching for items with an existing property: q=mixins.mixinName:exists, where the specific mixin named mixinName exists in the database.
  • Searching for items by multiple specific values: q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494), where id is the field name, and strings within the bracket are the desired values.
  • Searching for items by multiple fields: 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.
  • Searching for items with string-based properties conforming to a regex: 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.
  • Searching for items with a localized string-based property conforming to a 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.
Example: siteCode:{main}
fieldsstringOptional

Fields to be included in the response.

expandSchemasbooleanOptional

Determines whether the response will include information about associated schemas.

Default: false
Header parameters
X-Total-CountbooleanOptional

Flag indicating whether the total number of retrieved items should be returned.

Default: falseExample: true
Accept-LanguagestringOptional

List 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.

  • If the header is set to a particular language or a list of languages, all localized fields are retrieved as strings.
  • If the header is set to *, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.
  • If the header is empty, localized fields are retrieved in the default language defined in the Configuration Service.
Responses
200Success
application/json
get/schema/{tenant}/custom-entities
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
    }
  },
  {
    "id": "DOCUMENT",
    "name": {
      "en": "Documents"
    },
    "metadata": {
      "createdAt": "2023-08-10T10:15:30.123Z",
      "modifiedAt": "2023-08-19T10:15:30.123Z",
      "version": 2
    }
  }
]

Creating a custom schema type

post

Creates a custom type entity that can be later used for creating custom instances.

Note: When a custom entity type is created, a set of custom scopes is created, which allow managing custom instances of that type.

Reserved built-in type IDs cannot be used as custom schema type IDs. This includes AVAILABILITY and LOCATION.

Required scopes
This endpoint requires the following scopes:
  • : Required for managing schemas.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: Always write the tenant name in lowercase.

Pattern: ^[a-z][a-z0-9]+$
Header parameters
Content-LanguagestringOptional

The Content-Language request HTTP header defines language(s) of the payload.

Example: de
Body
idstringRequired

Unique code for the custom type. Can contain uppercase letters, digits, and underscores. The first character must be a letter.

nameobjectRequired

Localized custom type name in a form of a map of translations.

Responses
201

The request was successful. Custom schema type has been created.

application/json

Id of the created schema.

idstringOptional

ID of the generated document.

post/schema/{tenant}/custom-entities
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"
}

Retrieving a custom schema type

get

Retrieves a single custom schema type by id.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: Always write the tenant name in lowercase.

Pattern: ^[a-z][a-z0-9]+$
idstringRequired

Unique id of the custom type.

Query parameters
expandSchemasbooleanOptional

Determines whether the response will include information about associated schemas.

Default: false
Header parameters
Accept-LanguagestringOptional

List 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.

  • If the header is set to a particular language or a list of languages, all localized fields are retrieved as strings.
  • If the header is set to *, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.
  • If the header is empty, localized fields are retrieved in the default language defined in the Configuration Service.
Responses
200Success
application/json
idstringOptional

Unique id of the custom schema type.

nameobjectOptional

Localized custom type name in a form of a map of translations.

schemasobjectOptional

Information about associated schemas. This field is only included if expandSchemas is set to true

get/schema/{tenant}/custom-entities/{id}
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
  }
}

Upserting a custom schema type

put

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.

Note: When a custom entity type is created, a set of custom scopes is created, which allow managing custom instances of that type.

Required scopes
This endpoint requires the following scopes:
  • : Required for managing schemas.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: Always write the tenant name in lowercase.

Pattern: ^[a-z][a-z0-9]+$
idstringRequired

Unique id of the custom type.

Header parameters
Content-LanguagestringOptional

The Content-Language request HTTP header defines language(s) of the payload.

Example: de
Body
nameobjectRequired

Localized custom type name in a form of a map of translations.

Responses
201

Custom schema type was successfully created.

application/json

Id of the created schema.

idstringOptional

ID of the generated document.

put/schema/{tenant}/custom-entities/{id}
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"
}

Deleting a custom schema type

delete

Deletes a single custom type. This operation will fail if there are schemas or custom instances assigned to this custom type.

Note: Removing a custom entity type does not remove the custom scopes that were created when the type was added. Those scopes remain in the system until you remove them manually, if needed.

Required scopes
This endpoint requires the following scopes:
  • : Required for managing schemas.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: Always write the tenant name in lowercase.

Pattern: ^[a-z][a-z0-9]+$
idstringRequired

Unique id of the custom type.

Responses
204

Custom schema type was succefully removed

No content
delete/schema/{tenant}/custom-entities/{id}
DELETE /schema/{tenant}/custom-entities/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content
PreviousReference
NextCustom Instance

Last updated

Was this helpful?