Create a new Generic Entity by Template name

Create a new Generic Entity by Template name

The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.

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

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
_namestringtrue
_ownerOrganizationobjectfalse
_ownerOrganization.idstringtrue(*)
Path Parameters:
ParameterTypeMandatoryDescriptionExample
templateNamestringtruenull
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).

Path Params
string
required
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 1 and 32
_ownerOrganization
object
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