XaitCPQ API

POST data/link/{name}/{section}/{id}

Gets link options.

Request Information

URI

https://ofd-api.blueprintcpq.net/data/link/{name}/{section}/{id}

URI Parameters

NameDescriptionTypeAdditional information
name

Page name.

 string

Required
section

Section Name or Id.

 string

Required
id

Base Record Identifier.

 string

Required

Body Parameters

None.

Response Information

Resource Description

True if it succeeds, false if it fails.

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>