Overview of the management API

This API explains how to create a generator that generates an ID for a lookup type. In addition, you can get details of a generator based on the generator name, get a list of generators defined for the tenant, generate the next value for a generator, and delete generators.

Create generator

Request

POST https://{{rdm_uri}}/generators/{{rdm_tenant_name}}
Authorization: Bearer {{token}}
 
 
[
    {
        "name" : "{{generator_name}}",
        "type" : "SEQUENTIAL",
        "rangeStart" : 100
    },
   ...
]

Response

[
    {
        "name" : "{{generator_name}}",
        "type" : "SEQUENTIAL",
        "rangeStart" : 100,
        "currentValue" : 100
    },
   ...
]

List generators

Request

GET https://{{rdm_uri}}/generators/{{rdm_tenant_name}}
Authorization: Bearer {{token}}

Response

[
    {
        "name" : "{{generator_name}}",
        "type" : "SEQUENTIAL",
        "rangeStart" : 100,
        "currentValue" : 100
 
    },
   ...
]

Get generator

Request

GET https://{{rdm_uri}}/generators/{{rdm_tenant_name}}/{{generator_name}}
Authorization: Bearer {{token}}

Response

{
    "name" : "{{generator_name}}",
    "type" : "SEQUENTIAL",
    "rangeStart" : 100,
    "currentValue" : 100
}

Generate next value

Request

GET https://{{rdm_uri}}/generators/{{rdm_tenant_name}}/{{generator_name}}/generate
Authorization: Bearer {{token}}

Response

101

Delete generator

Request

DELETE https://{{rdm_uri}}/generators/{{rdm_tenant_name}}/{{generator_name}}
Authorization: Bearer {{token}}

Response

{ "status" : "success"}