Editing an Alerter

Updates the definition of an alerter of a Web Intelligence document.

Request

PUT <webiURL>/documents/{documentId}/alerters/{aleterId}

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

Request body:

<alerter>
    <id>
    <name>
    <description>
    <rule>
        <action>
    </rule>
</alerter>
Response

Response type: application/xml or application/json

The response is a message stating the success or failure of the request.

Example

PUT <webiURL>/documents/5022/alerters/2

Request body:

<alerter>
    <name>Sample 2</name>
    <description>Add a complex alerter</description>
    <rule>
        <conditions>
            <condition expressionId="DP0.DO93" operator="Greater">
                <operand>20</operand>
            </condition>
            <condition expressionId="DP0.DO93" operator="Greater">
                <target expressionId="DP0.DO93" />
            </condition>
        </conditions>
        <action>
            <data>
                <formula type="HyperLink">my hyperlink</formula>
                <format type="Custom" sample="1 234,57">
                    <template positive="STANDARD"/>
                </format>
            </data>
            <style>
                <border>
                    <top thickness="Medium" rgb="#800000" style="Plain"/>
                    <bottom thickness="Medium" rgb="#800000" style="Plain"/>
                    <left thickness="Medium" rgb="#800000" style="Plain"/>
                    <right thickness="Medium" rgb="#800000" style="Plain"/>
                </border>
                <background width="0" height="0">
                    <color rgb="#00ff00"/>
                    <image src="bores://00002">
                        <alignment horizontal="Left" vertical="Top"/>
                    </image>
                </background>
                <font size="12" face="Arial" italic="false" bold="false" strikethrough="true" 
                    underline="true" rgb="#ff6600"/>
                <alignment horizontal="Center" vertical="Center"/>
            </style>
        </action>
    </rule>
    <rule>
        <expression>=&quot;hello&quot;</expression>
    </rule>
</alerter>

Response:

<success>
    <message>The resource of type 'Alerter' with identifier '2' has been successfully updated.</message>
    <id>2</id>
</success>