POST data/lookup/relationship/{id}
Gets lookup values for relationship by Id.
Request Information
URI
https://ofd-api.blueprintcpq.net/data/lookup/relationship/{id}?share={share}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Relationship Identifier. |
globally unique identifier |
Required |
share |
Optional share identifier. |
globally unique identifier |
None. |
Body Parameters
Filters to filter data by
Collection of RelationshipFilterName | Description | Type | Additional information |
---|---|---|---|
Filter | globally unique identifier |
None. |
|
Value | string |
None. |
Request Formats
application/json, text/json
Sample:
[ { "Filter": "c8a81826-87c8-42c0-8c85-291b38ce2090", "Value": "sample string 2" }, { "Filter": "c8a81826-87c8-42c0-8c85-291b38ce2090", "Value": "sample string 2" } ]
text/html
Sample:
[{"Filter":"c8a81826-87c8-42c0-8c85-291b38ce2090","Value":"sample string 2"},{"Filter":"c8a81826-87c8-42c0-8c85-291b38ce2090","Value":"sample string 2"}]
application/xml, text/xml
Sample:
<ArrayOfRelationshipFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels"> <RelationshipFilter> <Filter>c8a81826-87c8-42c0-8c85-291b38ce2090</Filter> <Value>sample string 2</Value> </RelationshipFilter> <RelationshipFilter> <Filter>c8a81826-87c8-42c0-8c85-291b38ce2090</Filter> <Value>sample string 2</Value> </RelationshipFilter> </ArrayOfRelationshipFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The lookup values.
Collection of LookupValueName | Description | Type | Additional 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>