Getting the Details of an Alerter

Gets the full description of an alerter of a Web Intelligence document.

Request

GET <webiURL>/documents/{documentId}/alerters/{alerterId}

Where:

  • {documentId} is the identifier of the Web Intelligence document retrieved from the list of documents
  • {alerterId} is the alerter identifier retrieved from the list of alerters
Response

Response type: application/xml or application/json

Response body: details of the document alerter identified by:

  • <id>
  • <name>
  • <description> (optional)
  • <rule>, which is the definition of the rule
  • <action>, which is the definition of the affect on the document formatting

Example

GET <webiURL>/documents/8022/alerters/3

<alerter>
    <id>1</id>
    <name>Sales Revenue</name>
    <description>Test Raylight</description>
    <rule>
        <conditions>
            <condition expressionId="DP0.DO93" operator="Greater">
                <operand>2000000</operand>
            </condition>
        </conditions>
        <action>
            <data>
                <formula type="HyperLink">test</formula>
                <format type="Custom">
                    <template positive="STANDARD"/>
                </format>
            </data>
            <style>
                <background>
                    <color rgb="#ffff00"/>
                </background>
                <font rgb="#ff0000"/>
            </style>
        </action>
    </rule>
</alerter>