XaitCPQ API

POST data/lookup/relationship/{id}

Gets lookup values for relationship by Id.

Request Information

URI

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

URI Parameters

NameDescriptionTypeAdditional information
id

Relationship Identifier.

 globally unique identifier

Required
share

Optional share identifier.

 globally unique identifier

None.

Body Parameters

Filters and selected options.

LookupFilterOptions
NameDescriptionTypeAdditional information
Filters

Collection of RelationshipFilter

None.
Selected

Collection of string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Filters": [
    {
      "Filter": "a3b53403-e558-48a6-bb67-3405aa79f68e",
      "Value": "sample string 2"
    },
    {
      "Filter": "a3b53403-e558-48a6-bb67-3405aa79f68e",
      "Value": "sample string 2"
    }
  ],
  "Selected": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample: 
{"Filters":[{"Filter":"a3b53403-e558-48a6-bb67-3405aa79f68e","Value":"sample string 2"},{"Filter":"a3b53403-e558-48a6-bb67-3405aa79f68e","Value":"sample string 2"}],"Selected":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample: 
<LookupFilterOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Filters>
    <RelationshipFilter>
      <Filter>a3b53403-e558-48a6-bb67-3405aa79f68e</Filter>
      <Value>sample string 2</Value>
    </RelationshipFilter>
    <RelationshipFilter>
      <Filter>a3b53403-e558-48a6-bb67-3405aa79f68e</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>
</LookupFilterOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The lookup values.

Collection of VisibleLookupValue
NameDescriptionTypeAdditional information
Visible

boolean

None.
Id

Object

None.
HumanReadableValue

string

None.

Response Formats

application/json, text/json

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

text/html

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

application/xml, text/xml

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