Get Pending Alarms

This documentation will describe the Get Pending Alarms (XMAPEND) endpoint. This endpoint allows users to obtain a list of alarms currently within the pending queue of Alarm Monitoring.

See the Authentication documentation for information on how to obtain the authentication headers within the request.

Use cases #

• Configuring an external alerting product to send a notification if a service is down.
• Managing a status monitor that shows if anything is down.
• Monitoring the age of pending alarms.

Date formats #

NTD is a timestamp format used by DICE. NTD dates are used when defining time frames within endpoint calls. See the Date Format documentation for information on converting NTD to UNIX and vice versa if needed.

Supported attributes #

Example request #

curl --location "https://example.securemcloud.com/rest/rest.php?dataSource=methods&*view=xmsubmit" \
--header 'X-DICE-APPKEY: {{X-DICE-APPKEY}}' \
--header 'X-DICE-USERNAME: {{X-DICE-USERNAME}}' \
--header 'X-DICE-DATE: {{X-DICE-DATE}}' \
--header 'X-DICE-NONCE: {{X-DICE-NONCE}}' \
--header 'X-DICE-DIGEST: {{X-DICE-DIGEST}}' \
--header 'Accept: application/json' \
--form '*setMethod="XMAPEND"' \
--form 'FIXED_HISTORY_TAG="Y"' \
--form 'SOURCE="DATAENTRY"'

Example response #

{
    "XMAPEND": [
        {
            "PRIORITY": "z",
            "PASSCODE_VERIFIED": "N",
            "PENDING_TIME": "738972.69799",
            "PEND_TIME": "16:45:06",
            "PEND_DATE": "03/25/2024",
            "HISTORY_TIME": "16:45:06",
            "ACCOUNT_NUMBER": "       D1",
            "INCIDENT_NUMBER": "11562786",
            "HIST_TEXT": "*L T C*  LATE TO CLOSE",
            "COMPANY_NAME": "GOLF BALLS 'R' US",
            "HISTORY_EVENT_NTD": "738972.69799",
            "TYPE": "*LTC*",
            "TRACK_GROUPING": "TEST2",
            "CONTACT_LIST": "NOTIFY"
        },
        {
            "PRIORITY": "z",
            "PASSCODE_VERIFIED": "N",
            "PENDING_TIME": "738973.00002",
            "PEND_TIME": "00:00:02",
            "PEND_DATE": "03/26/2024",
            "HISTORY_TIME": "00:00:02",
            "ACCOUNT_NUMBER": "  CENTRAL",
            "INCIDENT_NUMBER": "11562884",
            "HIST_TEXT": "HOL NH1, PRB #6R:  (NH1)",
            "COMPANY_NAME": "DICE CENTRAL STATION",
            "HISTORY_EVENT_NTD": "738973.00002",
            "TYPE": "ALERT"
        },
        {
            "PRIORITY": "z",
            "PASSCODE_VERIFIED": "N",
            "PENDING_TIME": "738973.40633",
            "PEND_TIME": "09:45:07",
            "PEND_DATE": "03/26/2024",
            "HISTORY_TIME": "09:45:07",
            "ACCOUNT_NUMBER": "NW0000000",
            "INCIDENT_NUMBER": "11562890",
            "HIST_TEXT": "*L T O*  LATE TO OPEN",
            "COMPANY_NAME": "TEST ACCT",
            "HISTORY_EVENT_NTD": "738973.40633",
            "TYPE": "*LTO*",
            "TRACK_GROUPING": "ANDY",
            "CONTACT_LIST": "NOTIFY"
        },
        {
            "PRIORITY": "z",
            "PASSCODE_VERIFIED": "N",
            "PENDING_TIME": "738974.00002",
            "PEND_TIME": "00:00:02",
            "PEND_DATE": "03/27/2024",
            "HISTORY_TIME": "00:00:02",
            "ACCOUNT_NUMBER": "  CENTRAL",
            "INCIDENT_NUMBER": "11562992",
            "HIST_TEXT": "HOL NH1, PRB #6R:  (NH1)",
            "COMPANY_NAME": "DICE CENTRAL STATION",
            "HISTORY_EVENT_NTD": "738974.00002",
            "TYPE": "ALERT"
        },
        {
            "PRIORITY": "z",
            "PASSCODE_VERIFIED": "N",
            "PENDING_TIME": "738978.99940",
            "PEND_TIME": "23:59:08",
            "PEND_DATE": "03/31/2024",
            "HISTORY_TIME": "23:59:08",
            "ACCOUNT_NUMBER": "    KMN12",
            "INCIDENT_NUMBER": "11563395",
            "HIST_TEXT": "*L T C*  LATE TO CLOSE",
            "COMPANY_NAME": "Documentation Surveillance",
            "HISTORY_EVENT_NTD": "738978.99940",
            "TYPE": "*LTC*",
            "TRACK_GROUPING": "ALARM",
            "CONTACT_LIST": "NOTIFY"
        }
    ],
    "TOTAL_RECORDS": "5"
}

Response fields #