XaitCPQ API

POST xaitporter/confirm_project

Creates a new project from XaitPorter project template with the given project name.

Request Information

URI

https://ofd-api.blueprintcpq.net/xaitporter/confirm_project

URI Parameters

None.

Body Parameters

The confirmation options object

XaitPorterConfirmProjectOptions
NameDescriptionTypeAdditional information
ProjectRecordId

globally unique identifier

None.
DocumentSelections

Collection of XaitPorterDocument

None.
RequestId

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectRecordId": "b7c3650c-60e1-451e-9565-ce16cd453ea3",
  "DocumentSelections": [
    {
      "overridden": true,
      "selectedSections": [
        {
          "id": 1,
          "name": "sample string 2"
        },
        {
          "id": 1,
          "name": "sample string 2"
        }
      ],
      "productId": "sample string 2",
      "productName": "sample string 3",
      "productLastModified": "2024-12-21T16:24:29.9977623Z",
      "productVersion": 5,
      "documentId": 6,
      "documentName": "sample string 7",
      "id": 8,
      "name": "sample string 9"
    },
    {
      "overridden": true,
      "selectedSections": [
        {
          "id": 1,
          "name": "sample string 2"
        },
        {
          "id": 1,
          "name": "sample string 2"
        }
      ],
      "productId": "sample string 2",
      "productName": "sample string 3",
      "productLastModified": "2024-12-21T16:24:29.9977623Z",
      "productVersion": 5,
      "documentId": 6,
      "documentName": "sample string 7",
      "id": 8,
      "name": "sample string 9"
    }
  ],
  "RequestId": "sample string 2"
}

text/html

Sample: 
{"ProjectRecordId":"b7c3650c-60e1-451e-9565-ce16cd453ea3","DocumentSelections":[{"overridden":true,"selectedSections":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"productId":"sample string 2","productName":"sample string 3","productLastModified":"2024-12-21T16:24:29.9977623Z","productVersion":5,"documentId":6,"documentName":"sample string 7","id":8,"name":"sample string 9"},{"overridden":true,"selectedSections":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"productId":"sample string 2","productName":"sample string 3","productLastModified":"2024-12-21T16:24:29.9977623Z","productVersion":5,"documentId":6,"documentName":"sample string 7","id":8,"name":"sample string 9"}],"RequestId":"sample string 2"}

application/xml, text/xml

Sample: 
<XaitPorterConfirmProjectOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <DocumentSelections>
    <XaitPorterDocument>
      <Id>8</Id>
      <Name>sample string 9</Name>
      <DocumentId>6</DocumentId>
      <DocumentName>sample string 7</DocumentName>
      <Overridden>true</Overridden>
      <ProductId>sample string 2</ProductId>
      <ProductLastModified>2024-12-21T16:24:29.9977623+00:00</ProductLastModified>
      <ProductName>sample string 3</ProductName>
      <ProductVersion>5</ProductVersion>
      <SelectedSections>
        <XaitPorterSection>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </XaitPorterSection>
        <XaitPorterSection>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </XaitPorterSection>
      </SelectedSections>
    </XaitPorterDocument>
    <XaitPorterDocument>
      <Id>8</Id>
      <Name>sample string 9</Name>
      <DocumentId>6</DocumentId>
      <DocumentName>sample string 7</DocumentName>
      <Overridden>true</Overridden>
      <ProductId>sample string 2</ProductId>
      <ProductLastModified>2024-12-21T16:24:29.9977623+00:00</ProductLastModified>
      <ProductName>sample string 3</ProductName>
      <ProductVersion>5</ProductVersion>
      <SelectedSections>
        <XaitPorterSection>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </XaitPorterSection>
        <XaitPorterSection>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </XaitPorterSection>
      </SelectedSections>
    </XaitPorterDocument>
  </DocumentSelections>
  <ProjectRecordId>b7c3650c-60e1-451e-9565-ce16cd453ea3</ProjectRecordId>
  <RequestId>sample string 2</RequestId>
</XaitPorterConfirmProjectOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the XaitPorter project document link, if success, else an empty string.

string

Response Formats

application/json, text/json, text/html

Sample: 
"sample string 1"

application/xml, text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>