API Configuration

11.0.9

1.6.1

App Name

Required

Allows customizing the app name.

App Description

Not required

Allows customizing the app description.

App Status

Required

Mandatory single selection with two options: Enable (set by default) and Disable

• Enable: If you select Client Notification when creating an alert task, the app name will be selectable on the push terminals.

• Disable: If you select Client Notification when creating an alert task, the app name will not appear on the push terminals.

Request Address URL

Required

Allows customizing the request address URL.

Request Method

Required

Mandatory single selection with two options: POST (set by default) and GET

Request Header

Required

Enters the corresponding key and value.

• Click Add to add key-value pairs in the request header.

• Click the deletion icon to delete the edited key-value pairs (retain at least one pair).

Some APIs require specific headers to be sent with the request to provide more metadata about the operation being performed. You can set them here by entering any key-value pairs you need.

Request Body

Required

Allows customizing input. The content (only in JSON, XML, and TXT formats) entered in the body will be sent to the push terminals as the notification body when the alert is triggered. The supported parameters are as follows:

• Triggered time: ${triggeredTime} (in yyyy-MM-dd HH:mm:ss format)

• Alert name: ${taskName}

• Template where the abnormal data is located: ${templatePath}

• Access address: ${targetLink} (platform address like webroot/decision/view/report?viewlet=GettingStarted.cpt)

• Triggering condition: ${ruleDescription} (configured condition description)

• Receiver: ${receiveUsers} (concatenate strings of receivers with a half-width comma (,))

• Number of values that meet the condition: ${ruleMatchDataCount}

• Maximum value that meets the condition: ${ruleMatchDataMax}

• Minimum value that meets the condition: ${ruleMatchDataMin}

• Getting the notification content of the alert creation page: ${notifyContent}

Note:

 If the ${notifyContent} parameter is added in Request Body, the actual content received in the app after the alert task is created = the request body filled in the app page + the notification content on the alert creation page.

If the ${notifyContent} parameter is not added, the actual content received in the app = the request body filled in the app page.