XaitCPQ API

POST data/lookup/relationship/paged/{id}

Gets paginated lookup values for relationship by Id.

Request Information

URI

https://scoregroup-uat-api.xaitcpq.net/data/lookup/relationship/paged/{id}?share={share}

URI Parameters

NameDescriptionTypeAdditional information
id

Relationship Identifier.

 globally unique identifier

Required
share

Optional share identifier.

 globally unique identifier

None.

Body Parameters

Page options, filters and selected options.

PagedLookupFilterOptions
NameDescriptionTypeAdditional information
FetchCount

integer

None.
SkipCount

integer

None.
Filters

Collection of RelationshipFilter

None.
Selected

Collection of string

None.

Request Formats

application/json, text/json

Sample: 
{
  "FetchCount": 1,
  "SkipCount": 1,
  "Filters": [
    {
      "Filter": "226ef0a0-bb1a-4f56-8e8b-0c47858af93a",
      "Value": "sample string 2"
    },
    {
      "Filter": "226ef0a0-bb1a-4f56-8e8b-0c47858af93a",
      "Value": "sample string 2"
    }
  ],
  "Selected": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample: 
{"FetchCount":1,"SkipCount":1,"Filters":[{"Filter":"226ef0a0-bb1a-4f56-8e8b-0c47858af93a","Value":"sample string 2"},{"Filter":"226ef0a0-bb1a-4f56-8e8b-0c47858af93a","Value":"sample string 2"}],"Selected":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample: 
<PagedLookupFilterOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Filters>
    <RelationshipFilter>
      <Filter>226ef0a0-bb1a-4f56-8e8b-0c47858af93a</Filter>
      <Value>sample string 2</Value>
    </RelationshipFilter>
    <RelationshipFilter>
      <Filter>226ef0a0-bb1a-4f56-8e8b-0c47858af93a</Filter>
      <Value>sample string 2</Value>
    </RelationshipFilter>
  </Filters>
  <Selected xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Selected>
  <FetchCount>1</FetchCount>
  <SkipCount>1</SkipCount>
</PagedLookupFilterOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The lookup values.

VisibleLookupResult
NameDescriptionTypeAdditional information
HasMoreData

boolean

None.
Data

Collection of VisibleLookupValue

None.

Response Formats

application/json, text/json

Sample: 
{
  "HasMoreData": true,
  "Data": [
    {
      "Visible": true,
      "Id": {},
      "HumanReadableValue": "sample string 3"
    },
    {
      "Visible": true,
      "Id": {},
      "HumanReadableValue": "sample string 3"
    }
  ]
}

text/html

Sample: 
{"HasMoreData":true,"Data":[{"Visible":true,"Id":{},"HumanReadableValue":"sample string 3"},{"Visible":true,"Id":{},"HumanReadableValue":"sample string 3"}]}

application/xml, text/xml

Sample: 
<VisibleLookupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Data>
    <VisibleLookupValue>
      <HumanReadableValue>sample string 3</HumanReadableValue>
      <Id />
      <Visible>true</Visible>
    </VisibleLookupValue>
    <VisibleLookupValue>
      <HumanReadableValue>sample string 3</HumanReadableValue>
      <Id />
      <Visible>true</Visible>
    </VisibleLookupValue>
  </Data>
  <HasMoreData>true</HasMoreData>
</VisibleLookupResult>