Create a new Registration Code by Template id

Create a new Registration Code by Template id

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_codestringtrueThe registration code entity that is attached to the deviceRegistrationCode123
_ownerOrganizationobjecttrue
_ownerOrganization.idstringtrue(*)
_templateIdstringtrueThe id of a template that is configured in the settings service.3fa85f64-5717-4562-b3fc-2c963f66afa6
Query Parameters:
ParameterTypeMandatoryDescriptionExample
includeReferencersbooleanfalseOptional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

This API requires PROTECTED_API permission(s).

Query Params
boolean

Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

Body Params
string
required
length between 0 and 128

The registration code entity that is attached to the device

uuid
required

The id of a template that is configured in the settings service.

_ownerOrganization
object
required
Headers
string
enum
Defaults to async

X-Execution-Mode — Optional header to control execution mode.

Use sync to make the API wait until all background operations complete before returning a response.

If omitted, the request is processed asynchronously (default).

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json