Get or Delete Record ID Generator by Name

Return the details of a named ID generator, or delete a generator.

Use the following request to return information about a generator:

GET {serverURL}/generators/{generatorName}

This request returns details about the named generator.

Get a Specific Generator by Name

Request

GET https://{serverURL}/generators/{generator_name}

Table 1. Headers
Name	Required	Description
`Authorization`	Yes	`Bearer <access_token>`
`Content-Type`	Yes	`application/json`

Response

{
    "name": "{generator_name}",
    "type": "SEQUENTIAL",
    "valueType": "HEX",
    "rangeStart": "CCAABB",
    "step": "1"
}

Generate Next Value

Request

GET https://{serverURL}/generators/{generator_name}/generate

Table 2. Headers
Name	Required	Description
`Authorization`	Yes	`Bearer <access_token>`
`Content-Type`	Yes	`application/json`

Response

DECIMAL: 10
HEX: A
UUID: 33fefdbf-4b79-44b2-a39a-59600755eefa

Reset Generator's Values

Note: It is not possible to reset a generator's values, because generators are immutable. To reset or set a specific value, you must delete an old one and create new generator.

Delete a Generator

Request

DELETE https://{serverURL}/generators/{generator_name}

Table 3. Headers
Name	Required	Description
`Authorization`	Yes	`Bearer <access_token>`
`Content-Type`	Yes	`application/json`

Response

{
    "status" : "success"
}

Accelerate the Value of Data

Get or Delete Record ID Generator by Name

Footer