Creating a Ranking in a Report Element

Creates a ranking in a report element of type table (HTable, VTable, XTable, and Form) or section.

Restriction You can define only one ranking in a report element.
Request

POST <webiURL>/documents/{documentId}/reports/{reportId}/elements/{elementId}/ranking

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • {reportId} is the report identifier retrieved from the list of reports
  • {elementId} is the element identifier retrieved from the list of elements of a report

Request body: the ranking definition.

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/17281/reports/1/elements/20/ranking

Request body:

<ranking calculation="Count" top="3" bottom="3">
    <basedOn>=[Number of guests]</basedOn>
    <rankedBy>=[Year]</rankedBy>
</ranking>

Response:

<success>
    <message>The resource of type 'Ranking' has been successfully created.</message>
</success>