XaitCPQ API

GET document/templates/{quoteId}

Gets web available web templates.

Request Information

URI

https://ofd-api.blueprintcpq.net/document/templates/{quoteId}

URI Parameters

NameDescriptionTypeAdditional information
quoteId

Quote Id.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The web templates.

Collection of DocumentTemplate
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
UseDocXMerge

boolean

None.
Products

Collection of LookupValue

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "99bf2b81-012d-4927-a77a-356f21a337fd",
    "Name": "sample string 2",
    "UseDocXMerge": true,
    "Products": [
      {
        "Id": {},
        "HumanReadableValue": "sample string 2"
      },
      {
        "Id": {},
        "HumanReadableValue": "sample string 2"
      }
    ]
  },
  {
    "Id": "99bf2b81-012d-4927-a77a-356f21a337fd",
    "Name": "sample string 2",
    "UseDocXMerge": true,
    "Products": [
      {
        "Id": {},
        "HumanReadableValue": "sample string 2"
      },
      {
        "Id": {},
        "HumanReadableValue": "sample string 2"
      }
    ]
  }
]

text/html

Sample: 
[{"Id":"99bf2b81-012d-4927-a77a-356f21a337fd","Name":"sample string 2","UseDocXMerge":true,"Products":[{"Id":{},"HumanReadableValue":"sample string 2"},{"Id":{},"HumanReadableValue":"sample string 2"}]},{"Id":"99bf2b81-012d-4927-a77a-356f21a337fd","Name":"sample string 2","UseDocXMerge":true,"Products":[{"Id":{},"HumanReadableValue":"sample string 2"},{"Id":{},"HumanReadableValue":"sample string 2"}]}]

application/xml, text/xml

Sample: 
<ArrayOfDocumentTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <DocumentTemplate>
    <Id>99bf2b81-012d-4927-a77a-356f21a337fd</Id>
    <Name>sample string 2</Name>
    <Products>
      <LookupValue>
        <HumanReadableValue>sample string 2</HumanReadableValue>
        <Id />
      </LookupValue>
      <LookupValue>
        <HumanReadableValue>sample string 2</HumanReadableValue>
        <Id />
      </LookupValue>
    </Products>
    <UseDocXMerge>true</UseDocXMerge>
  </DocumentTemplate>
  <DocumentTemplate>
    <Id>99bf2b81-012d-4927-a77a-356f21a337fd</Id>
    <Name>sample string 2</Name>
    <Products>
      <LookupValue>
        <HumanReadableValue>sample string 2</HumanReadableValue>
        <Id />
      </LookupValue>
      <LookupValue>
        <HumanReadableValue>sample string 2</HumanReadableValue>
        <Id />
      </LookupValue>
    </Products>
    <UseDocXMerge>true</UseDocXMerge>
  </DocumentTemplate>
</ArrayOfDocumentTemplate>