Adding Record ID Generators
Add an ID generator.
To add a generator use a POST request as shown here:
POST https://{serverURL}/generatorsThe body of the request should include the generator name, type and UUID version as shown here:
{
{
"name": "UUID_4",
"type": "UUID",
"uuidVersion": 4
}
}Note: None of the currently defined parameter values can be updated, so at present this endpoint can be used only for creating generators.
This request returns the details of and conformation for the created generator.
Create SEQUENTIAL Generator With HEX Format and Fixed Length
Request
POST https://{serverURL}/generators| Name | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <access_token> |
Content-Type | Yes | application/json |
Body
[
{
"name" : "{generator_name}",
"type" : "SEQUENTIAL",
"valueType": "HEX",
"rangeStart": "1",
"step": "A",
"fixedLength" : 4
}
]Response
[
{
"name" : "{generator_name}",
"type" : "SEQUENTIAL",
"valueType" : "HEX",
"rangeStart" : "1",
"step": "A",
"fixedLength" : 4
}
]Create UUID Generator
Request
| Name | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <access_token> |
Content-Type | Yes | application/json |
Body
The body of the request should include the generator name, type, and UUID version as shown here:
[
{
"name" : "{generator_name}",
"type" : "UUID",
"uuidVersion": 4
}
]
Response
[
{
"name": "{generator_name}",
"type": "UUID",
"uuidVersion": 4
}
]Note: When you add a generator, make sure you record the generator name as you won't be able to retrieve the generator details without the name of the generator.. If you don't know the name of the generator, raise a support ticket.