View Color Coding

This documentation will describe the View Color Coding (XMCOLOR) endpoint. This endpoint allows users to view the color coding attributes used within Matrix.

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

Use cases #

• Configuring a dashboard to display alarms using the Matrix priority color coding.

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="XMCOLORS"'

Example response #

{
    "UL": {
        "FG": "#000000",
        "BG": "#FFFFFF"
    },
    "A": {
        "FG": "#000000",
        "BG": "#BB0000"
    },
    "B": {
        "FG": "#000000",
        "BG": "#FF5555"
    },
    "C": {
        "FG": "#000000",
        "BG": "#BB00BB"
    },
    "D": {
        "FG": "#55FFFF",
        "BG": "#000000"
    },
    "E": {
        "FG": "#000000",
        "BG": "#BBBB00"
    }
}

Response fields #

See the Supplemental Information documentation for a visual representation of the available colors.