Preview a version

1 min

POST

{baseUrl}/idgen/templates/{name}/versions/preview

A dry run of adding a version: sample IDs and every violation, including overlaps with the template's versions (none when it does not exist yet). Stores nothing. Needs idgen.templates.read.

namestringThe template name (<code>^[a-z][a-z0-9._-]{0,63}$</code>).

acceptstringGenerated from available response content types

bodyobjectThe format to check and how many sample IDs to return.

200The sample IDs and violations.

400INVALID_REQUEST: a malformed path, query or body value.

401UNAUTHENTICATED: missing, expired or invalid credentials.

403FORBIDDEN: the caller lacks the <code>idgen.templates.read</code> permission, or its tenant or site scope does not match.

500INTERNAL_ERROR: an unexpected failure. Retry once, then report it with the <code>x-request-id</code>.

503AUTH_UNAVAILABLE or BACKEND_UNAVAILABLE (both retryable): retry with backoff.

curl --request POST \
     --url http://localhost:8080/idgen/templates/{name}/versions/preview \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "version": {
     "separator": "",
     "segments": [
     {
     "type": ""
     }
     ]
     }
     }'