Managing APIs

App Name

Yes

App name to be customized.

App Description

No

App description to be customized.

App Status

Yes

Mandatory configuration item, which can either be Enable (default value) or Disable

• Enable: If you select Client Notification when creating an alert task, you can select this app as a Push Terminal.

• Disable: If you select Client Notification when creating an alert task, the app name will not appear when you set Push Terminal.

Request Address URL

Yes

Request URL to be customized.

Request Method

Yes

Mandatory configuration item, which can either be POST (default value) or GET

Request Header

Yes

Key and value to be set.

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 requests to provide more metadata about the operation being performed. You can set them here by entering any key-value pairs you need.

Request Body

No

Request body to be customized (only in .json, .xml, and .txt formats), which will be sent to the push terminals as the notification body when an alert is triggered. The following parameters are supported:

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

• Alert Name: ${taskName}

• Template: ${templatePath}

• Access Address: ${targetLink} (platform relative address, such as webroot/decision/view/report?viewlet=GettingStarted.cpt)

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

• Receiver: ${receiveUsers} (whose character strings are concatenated with half-width commas (,))

• Number of Data Records Meeting Conditions: ${ruleMatchDataCount}

• Maximum Value Meeting Conditions: ${ruleMatchDataMax}

• Minimum Value Meeting Conditions: ${ruleMatchDataMin}

Note:

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

If the ${notifyContent} parameter is not added, the actual content received in the app is the content of Request Body filled on the app page.