Update AlertConfiguration.

put https://qa.connect.calamp.com/connect/services/alerts/{id}

Update an AlertConfiguration and returns the updated AlertConfiguration.

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

groups

array of objects

Links to Groups to which the resource belongs.

groups

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

alertActionLinks

array of objects

Displays AlertActionLinks associated with AlertConfiguration. Read-only

alertActionLinks

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

triggerValues

object

Displays Trigger Name and Expressions. Read-only

Has additional fields

int64

name

string

required

Name of the AlertConfiguration

description

string

Description for AlertConfiguration

placeHolders

object

Placeholders for the associated triggers

status

string

Defaults to 'Enabled'

Enabled Disabled Suspended Deleted Pending_Delete

activatedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

deletedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

snoozeDuration

int64

Duration to snooze repetitive alerts. Value should be in seconds. Default value is 0 and Value = 0 disable snooze

schedule

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

scheduleEvaluation

string

IN OUT

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

alertType

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

processForSubAccounts

boolean

if this field is true then the alerts are processed for deviceEvents coming from subaccounts otherwise only the device events processed for the same account for which alert is configured

extendedAttribute

object

Represents an Extended Attribute in the system

value

string

required

Supplemental data. The application can store any string here as meta-data for a given resource. Max size = 1MB

createdOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When was this extendedAttribute created.

application

object

Represents a resource in the system

lastModifiedOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When was this extendedAttribute last modified.

severity

string

Defaults to LOW if not specified

CRITICAL HIGH MEDIUM LOW SYSTEM

400

Invalid request.

403

Not authorized for this operation.

404

AlertConfiguration not found.

409

Object state out-of-date.

500

Server error

Language

Credentials


xxxxxxxxxx
11
1
curl --request PUT \
2
     --url https://qa.connect.calamp.com/connect/services/alerts/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "alertConfiguration": {
8
    "version": 0
9
  }
10
}
11
'

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

application/json

200successful operation