Create a template

1 min

POST

{baseUrl}/idgen/templates

Creates a template in the reserved _default tenant's templates with its first format version (version 1), a DRAFT unless activate is true. Needs idgen.templates.write.

acceptstringGenerated from available response content types

bodyobjectThe template and its first version.

201The new template.

400INVALID_REQUEST: a malformed path or body value, or an invalid name.

401UNAUTHENTICATED: missing, expired or invalid credentials.

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

409NAMESPACE_ALREADY_EXISTS: the name is taken, or was used by a deleted template.

422INVALID_FORMAT: the first version is invalid; <code>message</code> lists every violation.

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 \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "name": "",
     "version": {
     "separator": "",
     "segments": [
     {
     "type": ""
     }
     ]
     }
     }'