Getting the List of Values Under a Specific Data Object Value

Returns the list of values under a specified value of a data object in a hierarchy.

A data object is a data provider expression, a variable, or a linked dimension.

Request

PUT <webiURL>/documents/{documentId}/dataobjects/{dataObjectId}/lov

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • {dataObjectId} is the valid identifier of a data object in the document

Request body: a specific value of the list of values of a data object.

Caution Make sure the value you specify in the request body is correct. The Web Service SDK does not make any checking of the value. Incorrect values are ignored and replaced with the root values.
Response

Response type: application/xml or application/json

Example

PUT <url>/documents/6070/dataobjects/DP0.DO9d/lov

Request body (XML file):

<lov hierarchical="true" partial="false" refreshable="false">
    <query>
        <path>
            <value id="\[Customer\].\[Customer Geography\].\[State-Province\|State-Province\].&\[NSW\]&\[AU\]" final="false">Queensland</value>
        </path>
    </query>
</lov>

Response:

<lov hierarchical="true" partial="false" refreshable="false">
    <values>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Alexandria\]&\[NSW\]" final="false">Alexandria</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Coffs Harbour\]&\[NSW\]" final="false">Coffs Harbour</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Darlinghurst\]&\[NSW\]" final="false">Darlinghurst</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Goulburn\]&\[NSW\]" final="false">Goulburn</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Lane Cove\]&\[NSW\]" final="false">Lane Cove</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Lavender Bay\]&\[NSW\]" final="false">Lavender Bay</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Malabar\]&\[NSW\]" final="false">Malabar</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Matraville\]&\[NSW\]" final="false">Matraville</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Milsons Point\]&\[NSW\]" final="false">Milsons Point</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Newcastle\]&\[NSW\]" final="false">Newcastle</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[North Ryde\]&\[NSW\]" final="false">North Ryde</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[North Sydney\]&\[NSW\]" final="false">North Sydney</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Port Macquarie\]&\[NSW\]" final="false">Port Macquarie</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Rhodes\]&\[NSW\]" final="false">Rhodes</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Silverwater\]&\[NSW\]" final="false">Silverwater</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Springwood\]&\[NSW\]" final="false">Springwood</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[St. Leonards\]&\[NSW\]" final="false">St. Leonards</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Sydney\]&\[NSW\]" final="false">Sydney</value>
        <value id="\[Customer\].\[Customer Geography\].\[City\].&\[Wollongong\]&\[NSW\]" final="false">Wollongong</value>
    </values>
</lov>