Creating the Tracker Settings

Activates a trackdata function on a document.

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

Request

POST <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

POST <webiURL>/documents/8022/tracker

Request body:

<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00">
    <added active="true"> 
        <background/> 
        <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">  
        <background/> 
        <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 created for the document.</message>
    <id>9917</id>
</success>