Sequential IDs management
Was this helpful?
Was this helpful?
The name of your tenant.
Note: The tenant name should always be provided in lowercase.
[a-zA-Z0-9_-]+GET /sequential-id/{tenant}/schemas HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"name": "testSchema",
"schemaType": "orderNoSequence",
"active": true,
"preText": "C-__year__-__month__-",
"postText": "-D",
"startValue": 1,
"maxValue": 999999999,
"numberOfDigits": 9,
"counter": 45684,
"placeholders": {
"__year__": {
"required": true
},
"__month__": {
"required": true
}
}
},
{
"name": "customer_number",
"startValue": 1,
"schemaType": "orderNoSequence",
"preText": "C-",
"minValue": 100,
"maxValue": 999999999,
"numberOfDigits": 9,
"counter": 109
}
]The ID of the schema to retrieve.
The name of your tenant.
Note: The tenant name should always be provided in lowercase.
^[a-z][a-z0-9]+$GET /sequential-id/{tenant}/schemas/{schemaId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"name": "testSchema",
"schemaType": "orderNoSequence",
"active": true,
"preText": "C-__year__-__month__-",
"postText": "-D",
"startValue": 1,
"maxValue": 999999999,
"numberOfDigits": 9,
"counter": 45684,
"placeholders": {
"__year__": {
"required": true
},
"__month__": {
"required": true
}
}
}The ID of the schema to activate.
The name of your tenant.
Note: The tenant name should always be provided in lowercase.
^[a-z][a-z0-9]+$POST /sequential-id/{tenant}/schemas/{schemaId}/setActive HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
The schema type corresponding to the entity it is used for. Possible values are:
orderNoSequenceinvoiceNoSequencequoteNoSequencepickPackNoSequenceorderHoldingAreaNoSequenceThe name of your tenant.
Note: The tenant name should always be provided in lowercase.
[a-zA-Z0-9_-]+GET /sequential-id/{tenant}/schemas/types/{schemaType} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"name": "testSchema",
"schemaType": "orderNoSequence",
"active": true,
"preText": "C-__year__-__month__-",
"postText": "-D",
"startValue": 1,
"maxValue": 999999999,
"numberOfDigits": 9,
"counter": 45684,
"placeholders": {
"__year__": {
"required": true
},
"__month__": {
"required": true
}
}
},
{
"name": "customer_number",
"startValue": 1,
"schemaType": "orderNoSequence",
"preText": "C-",
"minValue": 100,
"maxValue": 999999999,
"numberOfDigits": 9,
"counter": 109
}
]GET /sequential-id/sequenceSchemas HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "sequentialId",
"name": "order_number",
"schemaType": "orderNoSequence",
"active": true,
"preText": "C-",
"postText": "-A",
"startValue": 100,
"maxValue": 999999999,
"numberOfDigits": 9,
"counter": 109,
"placeholders": {
"__year__": {
"required": true
}
}
}
]The name of the sequence schema.
The schema type corresponding to the entity it is used for. Possible values are:
orderNoSequenceinvoiceNoSequencequoteNoSequencepickPackNoSequenceorderHoldingAreaNoSequence^[a-zA-Z0-9]*$The prefix of the ID. It can contain placeholders, which are replaced with their values.
Placeholders are defined in the placeholders property.
The suffix of the ID. It can contain placeholders, which are replaced with their values.
Placeholders are defined in the placeholders property.
The starting value of the sequence. It is used to generate the first ID. The starting value is incremented for each subsequent ID.
The maximum value of the sequence. It is used to limit the range of generated IDs. If the maximum value is reached, the sequence will not generate any more IDs.
The number of digits in the generated ID. It is used to format the ID. If the number of digits is less than the maximum value, leading zeros are added.
POST /sequential-id/sequenceSchemas HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 187
{
"name": "invoiceNoSequence",
"schemaType": "invoiceNoSequence",
"preText": "INV__num__",
"maxValue": 999999999,
"numberOfDigits": 4,
"startValue": 1000,
"placeholders": {
"__num__": {
"required": true
}
}
}textCreates and returns the nextId in the sequence. If you specify the sequenceKey parameter in request body, the nextId number is generated for this sequence, otherwise default pool is used.
This endpoint is deprecated. Please use the /sequential-id/{tenant}/schemas/types/{schemaType}/nextId instead.
The sequence schema to generate the nextId for.
Value used to resolve certain placeholders.
Placeholders such as __year__, __month__, __day__, __hour__, __minute__, __second__, and __country__, which are defined in the schema, can have default values computed when their counterparts are missing in the request body.
The default values are derived from the site. Specifically:
site.homeBase.timezone field.site.homeBase.address.country.If these values are missing in site, the following defaults are used:
UTC for timezoneDE for countryThe number of IDs to create sequentially in one request.
The pattern to follow for the nextID.
The filler text for values based on certain properties or settings in the system.
POST /sequential-id/sequenceSchemas/{sequenceSchema}/nextIds HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"numberOfIds": 3,
"sequenceKey": "2016-05",
"placeholders": {
"__year__": "2016",
"__month__": "05"
}
}{
"ids": [
"C-2016-06-0000000045-D",
"asfasf2323"
]
}The name of your tenant.
Note: The tenant name should always be provided in lowercase.
[a-zA-Z0-9_-]+The name of the sequence schema.
The schema type corresponding to the entity it is used for. Possible values are:
orderNoSequenceinvoiceNoSequencequoteNoSequencepickPackNoSequenceorderHoldingAreaNoSequence^[a-zA-Z0-9]*$The prefix of the ID. It can contain placeholders, which are replaced with their values.
Placeholders are defined in the placeholders property.
The suffix of the ID. It can contain placeholders, which are replaced with their values.
Placeholders are defined in the placeholders property.
The starting value of the sequence. It is used to generate the first ID. The starting value is incremented for each subsequent ID.
The maximum value of the sequence. It is used to limit the range of generated IDs. If the maximum value is reached, the sequence will not generate any more IDs.
The number of digits in the generated ID. It is used to format the ID. If the number of digits is less than the maximum value, leading zeros are added.
POST /sequential-id/{tenant}/schemas HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 233
{
"name": "testSchema",
"schemaType": "orderNoSequence",
"preText": "C-__year__-__month__-",
"postText": "-D",
"maxValue": 999999999,
"numberOfDigits": 9,
"startValue": 3,
"placeholders": {
"__year__": {
"required": true
},
"__month__": {
"required": true
}
}
}textThe schema type corresponding to the entity it is used for. Possible values are:
orderNoSequenceinvoiceNoSequencequoteNoSequencepickPackNoSequenceorderHoldingAreaNoSequenceThe name of your tenant.
Note: The tenant name should always be provided in lowercase.
^[a-z][a-z0-9]+$Value used to resolve certain placeholders.
Placeholders such as __year__, __month__, __day__, __hour__, __minute__, __second__, and __country__, which are defined in the schema, can have default values computed when their counterparts are missing in the request body.
The default values are derived from the site. Specifically:
site.homeBase.timezone field.site.homeBase.address.country.If these values are missing in site, the following defaults are used:
UTC for timezoneDE for countryThe pattern to follow for the nextID.
The filler text for values based on certain properties or settings in the system.
POST /sequential-id/{tenant}/schemas/types/{schemaType}/nextId HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"sequenceKey": "2016-05",
"placeholders": {
"__year__": "2016",
"__month__": "05"
}
}{
"id": "B7012562"
}Value used to resolve certain placeholders.
Placeholders such as __year__, __month__, __day__, __hour__, __minute__, __second__, and __country__, which are defined in the schema, can have default values computed when their counterparts are missing in the request body.
The default values are derived from the site. Specifically:
site.homeBase.timezone field.site.homeBase.address.country.If these values are missing in site, the following defaults are used:
UTC for timezoneDE for countryPOST /sequential-id/sequenceSchemaBatch/nextIds HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 159
{
"testSchema": {
"sequenceKey": "2016-05",
"placeholders": {
"__year__": "2016",
"__month__": "05"
}
},
"testSchema2": {
"numberOfIds": 2,
"placeholders": {
"--prefix--": "C-"
}
}
}{
"testSchema": {
"ids": [
"C-2016-05-0000000045-D",
"C-2016-05-0000000045-D"
]
}
}