XaitCPQ API

GET item-builder/{product}

Gets a product definition.

Request Information

URI

https://ofd-api.blueprintcpq.net/item-builder/{product}

URI Parameters

NameDescriptionTypeAdditional information
product

The product identifier.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The definition.

Dictionary of string [key] and Object [value]

Response Formats

application/json, text/json

Sample: 
{
  "sample string 1": {},
  "sample string 3": {}
}

text/html

Sample: 
{"sample string 1":{},"sample string 3":{}}

application/xml, text/xml

Sample: 
<ArrayOfKeyValueOfstringanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringanyType>
    <Key>sample string 1</Key>
    <Value />
  </KeyValueOfstringanyType>
  <KeyValueOfstringanyType>
    <Key>sample string 3</Key>
    <Value />
  </KeyValueOfstringanyType>
</ArrayOfKeyValueOfstringanyType>