XaitCPQ API

GET quote/{quote}/documents

Gets the documents for a quote.

Request Information

URI

https://ofd-api.blueprintcpq.net/quote/{quote}/documents

URI Parameters

NameDescriptionTypeAdditional information
quote

Quote Identifier.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The documents.

Collection of DocumentDetail
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "846dbda3-f719-4404-a12b-4ad2508743f2",
    "Name": "sample string 2"
  },
  {
    "Id": "846dbda3-f719-4404-a12b-4ad2508743f2",
    "Name": "sample string 2"
  }
]

text/html

Sample: 
[{"Id":"846dbda3-f719-4404-a12b-4ad2508743f2","Name":"sample string 2"},{"Id":"846dbda3-f719-4404-a12b-4ad2508743f2","Name":"sample string 2"}]

application/xml, text/xml

Sample: 
<ArrayOfDocumentDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <DocumentDetail>
    <Id>846dbda3-f719-4404-a12b-4ad2508743f2</Id>
    <Name>sample string 2</Name>
  </DocumentDetail>
  <DocumentDetail>
    <Id>846dbda3-f719-4404-a12b-4ad2508743f2</Id>
    <Name>sample string 2</Name>
  </DocumentDetail>
</ArrayOfDocumentDetail>