XaitCPQ API

POST data/lookup/table/{id}

Gets the table lookup values.

Request Information

URI

https://ofd-api.blueprintcpq.net/data/lookup/table/{id}?share={share}

URI Parameters

NameDescriptionTypeAdditional information
id

Table Identifier or Name.

 string

Required
share

Optional share identifier.

 globally unique identifier

None.

Body Parameters

Filters

Collection of LookupFilter
NameDescriptionTypeAdditional information
Field

string

None.
Value

string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "Field": "sample string 1",
    "Value": "sample string 2"
  },
  {
    "Field": "sample string 1",
    "Value": "sample string 2"
  }
]

text/html

Sample: 
[{"Field":"sample string 1","Value":"sample string 2"},{"Field":"sample string 1","Value":"sample string 2"}]

application/xml, text/xml

Sample: 
<ArrayOfLookupFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <LookupFilter>
    <Field>sample string 1</Field>
    <Value>sample string 2</Value>
  </LookupFilter>
  <LookupFilter>
    <Field>sample string 1</Field>
    <Value>sample string 2</Value>
  </LookupFilter>
</ArrayOfLookupFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The table lookup values.

Collection of LookupValue
NameDescriptionTypeAdditional information
Id

Object

None.
HumanReadableValue

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": {},
    "HumanReadableValue": "sample string 2"
  },
  {
    "Id": {},
    "HumanReadableValue": "sample string 2"
  }
]

text/html

Sample: 
[{"Id":{},"HumanReadableValue":"sample string 2"},{"Id":{},"HumanReadableValue":"sample string 2"}]

application/xml, text/xml

Sample: 
<ArrayOfLookupValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <LookupValue>
    <HumanReadableValue>sample string 2</HumanReadableValue>
    <Id />
  </LookupValue>
  <LookupValue>
    <HumanReadableValue>sample string 2</HumanReadableValue>
    <Id />
  </LookupValue>
</ArrayOfLookupValue>