Create a new Device Alert by Template name

post

https://device/v1/devices/{deviceId}/alerts/{templateName}

Request Body Parameters:

Parameter	Type	Mandatory	Description	Example
<customAttribute1>	<customAttribute1Type>	false	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	false	Regular custom attribute N value
_clearNotes	string	false	Clear notes
_name	string	false	The name of the alert
_severity	string	false	The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO	MAJOR
_state	string	false	The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE	ACTIVE
Path Parameters:

Parameter	Type	Mandatory	Description
deviceId	string	true	null
templateName	string	true	null
Query Parameters:

Parameter	Type	Mandatory	Description	Example
includeReferencers	boolean	false	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.

This API requires PROTECTED_API permission(s).

Path Params

deviceId

string

required

templateName

string

required

Query Params

includeReferencers

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

_state

string

enum

Defaults to ACTIVE

The alert wanted state

Allowed:

_severity

string

enum

Defaults to INFO

The alert wanted severity

Allowed:

_clearNotes

string

Clear notes

_name

string

length between 1 and 64

The name of the alert

Headers

x-execution-mode

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

Parameter	Type	Description	Example
<customAttribute1>	<customAttribute1Type>	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	Regular custom attribute N value
_caption	string
_clearDateTime	string	Clear Date time of the alert	2007-12-20T10:15:30Z
_clearNotes	string	Clear notes
_clearTrigger	string	The alert cleared trigger type Values:MANUAL,AUTOMATIC	AUTOMATIC
_clearedBy	object
_clearedBy.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_clearedBy.name	string	The caption of the referenced entity
_clearedBy.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_clearedBy.parentEntityId	string	The id of the parent entity (appears only for child entities)
_clearedBy.template	object
_clearedBy.template.displayName	string	The display name of the template
_clearedBy.template.id	string	The id of the template
_clearedBy.template.name	string	The name of the template
_clearedBy.template.parentTemplate	object
_clearedBy.template.parentTemplate.displayName	string
_clearedBy.template.parentTemplate.id	string
_clearedBy.template.parentTemplate.name	string
_clearedBy.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_clearedBy.templateName	string	The name of the referenced entity template
_creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_device	object
_device.id	string
_device.name	string	The caption of the referenced entity
_device.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_device.parentEntityId	string	The id of the parent entity (appears only for child entities)
_device.template	object
_device.template.displayName	string	The display name of the template
_device.template.id	string	The id of the template
_device.template.name	string	The name of the template
_device.template.parentTemplate	object
_device.template.parentTemplate.displayName	string
_device.template.parentTemplate.id	string
_device.template.parentTemplate.name	string
_device.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_device.templateName	string	The name of the referenced entity template
_id	string	The id of the alert instance	3fa85f64-5717-4562-b3fc-2c963f66afa6
_lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_name	string	The name of the alert
_ownerOrganization	object
_ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.name	string	The caption of the referenced entity
_ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
_ownerOrganization.template	object
_ownerOrganization.template.displayName	string	The display name of the template
_ownerOrganization.template.id	string	The id of the template
_ownerOrganization.template.name	string	The name of the template
_ownerOrganization.template.parentTemplate	object
_ownerOrganization.template.parentTemplate.displayName	string
_ownerOrganization.template.parentTemplate.id	string
_ownerOrganization.template.parentTemplate.name	string
_ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.templateName	string	The name of the referenced entity template
_referencers	object	An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1)
_setDateTime	string	Set Date time of the alert	2007-12-20T10:15:30Z
_severity	string	The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO	MAJOR
_state	string	The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE	ACTIVE
_template	object
_template.displayName	string	The display name of the template
_template.id	string	The id of the template
_template.name	string	The name of the template
_template.parentTemplate	object
_template.parentTemplate.displayName	string
_template.parentTemplate.id	string
_template.parentTemplate.name	string

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Code : TOKEN_NOT_VALID, Details: []

404Code : DEVICE_NOT_FOUND, Details: [id] Code : TEMPLATE_NOT_FOUND_BY_NAME, Details: [templateName] Code : REFERENCE_CONFIGURATION_ENTITY_NOT_FOUND, Details: [attributeName, entityId]

409Code : MORE_THAN_ONE_TEMPLATE_WITH_NAME, Details: [numTemplatesFound, templateName]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []