Create a new Device Alert by Template name

post https://example.com/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	Example
deviceId	string	true	null
templateName	string	true	null

This API requires PROTECTED_API permission(s).

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.parentEntityId	string	The id of the parent entity (appears only for child entities)
_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.parentEntityId	string	The id of the parent entity (appears only for child entities)
_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.parentEntityId	string	The id of the parent entity (appears only for child entities)
_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

Response body

object

_state

string

Defaults to ACTIVE

The alert wanted state

ACTIVE CLEARED SUSPENDED

_severity

string

Defaults to INFO

The alert wanted severity

CRITICAL MAJOR MINOR INFO

_clearNotes

string

Clear notes

_name

string

length between 1 and 64

The name of the alert

_id

uuid

required

The id of the alert instance

_template

object

name

string

The name of the template

displayName

string

The display name of the template

parentTemplate

object

Base information about the template parent

string

The id of the 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)

_ownerOrganization

object

required

uuid

required

A UUID formatted string

templateId

uuid

required

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

parentEntityId

string

The id of the parent entity (appears only for child entities)

templateName

string

required

The name of the referenced entity template

name

string

required

The caption of the referenced entity

_clearDateTime

date-time

Clear Date time of the alert

_clearTrigger

string

required

The alert cleared trigger type

MANUAL AUTOMATIC

_clearedBy

object

required

uuid

required

A UUID formatted string

templateId

uuid

required

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

parentEntityId

string

The id of the parent entity (appears only for child entities)

templateName

string

required

The name of the referenced entity template

name

string

required

The caption of the referenced entity

_creationTime

date-time

required

A UTC date-time in the ISO-8601 format

_lastModifiedTime

date-time

required

A UTC date-time in the ISO-8601 format

_device

object

required

device entity

string

required

templateId

uuid

required

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

parentEntityId

string

The id of the parent entity (appears only for child entities)

templateName

string

required

The name of the referenced entity template

name

string

required

The caption of the referenced entity

_setDateTime

date-time

required

Set Date time of the alert

_caption

string

Language

Credentials

Bearer

JWT


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://example.com/device/v1/devices/deviceId/alerts/templateName \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "_state": "ACTIVE",
8
  "_severity": "INFO"
9
}
10
'

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: []