Getting the List of Custom Palettes

Returns the palettes defined by the end-user and attached to a Web Intelligence document.

Request

GET <webiURL>/documents/{documentId}/palettes

Where:

  • {documentId} is the document identifier retrieved from the list of documents
Response

Response type: application/xml or application/json

The response is the list of custom palettes. A custom palette is defined as follows:

<id>
<name>
<colors>
    <color>

Example

GET <webiURL>/documents/1234/palettes

<palettes>
    <palette>
        <id>5f95e34e-b5c1-49d5-ac60-eb73ee5527c2</id>
        <name>custom palette 1</name>
        <colors>
            <color rgb="#5b5b5b" alpha="100"/>
            <color rgb="#d2d2d2" alpha="100"/>
            <color rgb="#efefef" alpha="100"/>
            <color rgb="#848484" alpha="100"/>
            <color rgb="#aeadae" alpha="100"/>
            <color rgb="#0f0f0f" alpha="100"/>
            <color rgb="#ffffff" alpha="100"/>
            <color rgb="#bfbfbf" alpha="100"/>
            <color rgb="#6f706f" alpha="100"/>
            <color rgb="#a4a4a4" alpha="100"/>
            ...
        </colors>
    </palette>
    <palette>
        <id>9dccd8a9-ac02-4301-828a-7b0cc81bb937</id>
        <name>custom palette 2</name>
        <colors>
            <color rgb="#00ff00" alpha="50"/>
            <color rgb="#00fa00" alpha="50"/>
        </colors>
  </palette>
</palettes>