Editing the Tracker Settings

Updates a trackdata function on a document.

It updates the style applied on alerters. It is also possible to enable/disable the visualization of a change type. If the track data definition is not provided, the mode is set to Manual and the document is set as reference.

The request body is optional. If not provided, the trackdata will be activated with default settings or the previous settings if trackdata has been activated previously.

Request

PUT <webiURL>/documents/{documentId}/tracker

Where:

  • {documentId}: the identifier of the Web Intelligence document retrieved from the list of documents

Request body (example):

<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00">
    <added> 
    <changed>   
    <removed>
    <increasing>   
    <decreasing>
</tracker>
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/8022/tracker

Request body in an XML file:

<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00">
    <added active="true"> 
        <style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000aa"/> 
    </added> 
    <changed active="true">  
        <background rgb="#aabbcc"/>  
        <style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000bb"/>   
    </changed> 
    <removed active="true">   
        <style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000cc"/>   
    </removed>  
    <increasing threshold="5.0" applyThreshold="false" active="true"> 
        <background rgb="#33cc33"/>  
        <style italic="false" bold="true" strikethrough="false" underline="false"/> 
    </increasing>   
    <decreasing threshold="8.0" applyThreshold="true" active="false"> 
        <background rgb="#33cc33"/> 
        <style italic="true" bold="false" strikethrough="true" underline="true"/>
    </decreasing>
</tracker>

Response:

<success>
    <message> The resource of type 'Tracker' has been successfully updated for the document.</message>
    <id>9917</id>
</success>