XaitCPQ API

POST data/lookup/batch-relationships

Gets a batch of lookup values.

Request Information

URI

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

URI Parameters

NameDescriptionTypeAdditional information
share

(Optional) Optional share identifier.

 globally unique identifier

None.

Body Parameters

Filters and selected options.

Collection of BatchLookupFilterOptions
NameDescriptionTypeAdditional information
Relationship

globally unique identifier

None.
Filters

Collection of RelationshipFilter

None.
Selected

Collection of string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "Relationship": "5b5725f8-ea43-485f-afba-36a54ec86dcc",
    "Filters": [
      {
        "Filter": "78034d9c-5787-4835-8674-35edfbbf575c",
        "Value": "sample string 2"
      },
      {
        "Filter": "78034d9c-5787-4835-8674-35edfbbf575c",
        "Value": "sample string 2"
      }
    ],
    "Selected": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "Relationship": "5b5725f8-ea43-485f-afba-36a54ec86dcc",
    "Filters": [
      {
        "Filter": "78034d9c-5787-4835-8674-35edfbbf575c",
        "Value": "sample string 2"
      },
      {
        "Filter": "78034d9c-5787-4835-8674-35edfbbf575c",
        "Value": "sample string 2"
      }
    ],
    "Selected": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

text/html

Sample: 
[{"Relationship":"5b5725f8-ea43-485f-afba-36a54ec86dcc","Filters":[{"Filter":"78034d9c-5787-4835-8674-35edfbbf575c","Value":"sample string 2"},{"Filter":"78034d9c-5787-4835-8674-35edfbbf575c","Value":"sample string 2"}],"Selected":["sample string 1","sample string 2"]},{"Relationship":"5b5725f8-ea43-485f-afba-36a54ec86dcc","Filters":[{"Filter":"78034d9c-5787-4835-8674-35edfbbf575c","Value":"sample string 2"},{"Filter":"78034d9c-5787-4835-8674-35edfbbf575c","Value":"sample string 2"}],"Selected":["sample string 1","sample string 2"]}]

application/xml, text/xml

Sample: 
<ArrayOfBatchLookupFilterOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <BatchLookupFilterOptions>
    <Filters>
      <RelationshipFilter>
        <Filter>78034d9c-5787-4835-8674-35edfbbf575c</Filter>
        <Value>sample string 2</Value>
      </RelationshipFilter>
      <RelationshipFilter>
        <Filter>78034d9c-5787-4835-8674-35edfbbf575c</Filter>
        <Value>sample string 2</Value>
      </RelationshipFilter>
    </Filters>
    <Selected xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Selected>
    <Relationship>5b5725f8-ea43-485f-afba-36a54ec86dcc</Relationship>
  </BatchLookupFilterOptions>
  <BatchLookupFilterOptions>
    <Filters>
      <RelationshipFilter>
        <Filter>78034d9c-5787-4835-8674-35edfbbf575c</Filter>
        <Value>sample string 2</Value>
      </RelationshipFilter>
      <RelationshipFilter>
        <Filter>78034d9c-5787-4835-8674-35edfbbf575c</Filter>
        <Value>sample string 2</Value>
      </RelationshipFilter>
    </Filters>
    <Selected xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Selected>
    <Relationship>5b5725f8-ea43-485f-afba-36a54ec86dcc</Relationship>
  </BatchLookupFilterOptions>
</ArrayOfBatchLookupFilterOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The batch lookup values.

Collection of BatchLookupFilterResponse
NameDescriptionTypeAdditional information
Relationship

globally unique identifier

None.
Results

Collection of VisibleLookupValue

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Relationship": "f183317f-b764-4247-a147-a9d2ff4be022",
    "Results": [
      {
        "Visible": true,
        "Id": {},
        "HumanReadableValue": "sample string 3"
      },
      {
        "Visible": true,
        "Id": {},
        "HumanReadableValue": "sample string 3"
      }
    ]
  },
  {
    "Relationship": "f183317f-b764-4247-a147-a9d2ff4be022",
    "Results": [
      {
        "Visible": true,
        "Id": {},
        "HumanReadableValue": "sample string 3"
      },
      {
        "Visible": true,
        "Id": {},
        "HumanReadableValue": "sample string 3"
      }
    ]
  }
]

text/html

Sample: 
[{"Relationship":"f183317f-b764-4247-a147-a9d2ff4be022","Results":[{"Visible":true,"Id":{},"HumanReadableValue":"sample string 3"},{"Visible":true,"Id":{},"HumanReadableValue":"sample string 3"}]},{"Relationship":"f183317f-b764-4247-a147-a9d2ff4be022","Results":[{"Visible":true,"Id":{},"HumanReadableValue":"sample string 3"},{"Visible":true,"Id":{},"HumanReadableValue":"sample string 3"}]}]

application/xml, text/xml

Sample: 
<ArrayOfBatchLookupFilterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <BatchLookupFilterResponse>
    <Relationship>f183317f-b764-4247-a147-a9d2ff4be022</Relationship>
    <Results>
      <VisibleLookupValue>
        <HumanReadableValue>sample string 3</HumanReadableValue>
        <Id />
        <Visible>true</Visible>
      </VisibleLookupValue>
      <VisibleLookupValue>
        <HumanReadableValue>sample string 3</HumanReadableValue>
        <Id />
        <Visible>true</Visible>
      </VisibleLookupValue>
    </Results>
  </BatchLookupFilterResponse>
  <BatchLookupFilterResponse>
    <Relationship>f183317f-b764-4247-a147-a9d2ff4be022</Relationship>
    <Results>
      <VisibleLookupValue>
        <HumanReadableValue>sample string 3</HumanReadableValue>
        <Id />
        <Visible>true</Visible>
      </VisibleLookupValue>
      <VisibleLookupValue>
        <HumanReadableValue>sample string 3</HumanReadableValue>
        <Id />
        <Visible>true</Visible>
      </VisibleLookupValue>
    </Results>
  </BatchLookupFilterResponse>
</ArrayOfBatchLookupFilterResponse>