XaitCPQ API

POST data/export/{name}/{recordId}

Exports a record and associated records.

Request Information

URI

https://ofd-api.blueprintcpq.net/data/export/{name}/{recordId}

URI Parameters

NameDescriptionTypeAdditional information
name

Page name.

 string

Required
recordId

Record Identifier.

 string

Required

Body Parameters

The related tables.

Collection of globally unique identifier

Request Formats

application/json, text/json

Sample: 
[
  "6ca28917-9950-434e-b8ff-57e3e575a0e1",
  "5abbba8f-4b3a-411d-b961-8ad5122e8713"
]

text/html

Sample: 
["6ca28917-9950-434e-b8ff-57e3e575a0e1","5abbba8f-4b3a-411d-b961-8ad5122e8713"]

application/xml, text/xml

Sample: 
<ArrayOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <guid>6ca28917-9950-434e-b8ff-57e3e575a0e1</guid>
  <guid>5abbba8f-4b3a-411d-b961-8ad5122e8713</guid>
</ArrayOfguid>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An ExportRecord.

ExportRecord
NameDescriptionTypeAdditional information
BaseRecord

Dictionary of string [key] and Object [value]

None.
BaseRecordTable

string

None.
RelatedRecords

Dictionary of string [key] and Collection of Dictionary of string [key] and Object [value] [value]

None.

Response Formats

application/json, text/json

Sample: 
{
  "BaseRecord": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "BaseRecordTable": "sample string 1",
  "RelatedRecords": {
    "sample string 1": [
      {
        "sample string 1": {},
        "sample string 3": {}
      },
      {
        "sample string 1": {},
        "sample string 3": {}
      }
    ],
    "sample string 2": [
      {
        "sample string 1": {},
        "sample string 3": {}
      },
      {
        "sample string 1": {},
        "sample string 3": {}
      }
    ]
  }
}

text/html

Sample: 
{"BaseRecord":{"sample string 1":{},"sample string 3":{}},"BaseRecordTable":"sample string 1","RelatedRecords":{"sample string 1":[{"sample string 1":{},"sample string 3":{}},{"sample string 1":{},"sample string 3":{}}],"sample string 2":[{"sample string 1":{},"sample string 3":{}},{"sample string 1":{},"sample string 3":{}}]}}

application/xml, text/xml

Sample: 
<ExportRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <BaseRecord 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>
  </BaseRecord>
  <BaseRecordTable>sample string 1</BaseRecordTable>
  <RelatedRecords xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfArrayOfKeyValueOfstringanyTypety7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:ArrayOfKeyValueOfstringanyType>
          <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>
        </d2p1:ArrayOfKeyValueOfstringanyType>
        <d2p1:ArrayOfKeyValueOfstringanyType>
          <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>
        </d2p1:ArrayOfKeyValueOfstringanyType>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfArrayOfKeyValueOfstringanyTypety7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfArrayOfKeyValueOfstringanyTypety7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:ArrayOfKeyValueOfstringanyType>
          <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>
        </d2p1:ArrayOfKeyValueOfstringanyType>
        <d2p1:ArrayOfKeyValueOfstringanyType>
          <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>
        </d2p1:ArrayOfKeyValueOfstringanyType>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfArrayOfKeyValueOfstringanyTypety7Ep6D1>
  </RelatedRecords>
</ExportRecord>