XaitCPQ API

POST item-builder/{product}

Saves 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

The update.

Dictionary of string [key] and Object [value]

Request 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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The product definition.

SaveProductResult
NameDescriptionTypeAdditional information
Product

Dictionary of string [key] and Object [value]

None.
Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Product": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample: 
{"Product":{"sample string 1":{},"sample string 3":{}},"Errors":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample: 
<SaveProductResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Product xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Product>
</SaveProductResult>