XaitCPQ API

GET xaitporter/existing_project_options

If this CPQ record already has an associated XaitPorter Project then this API returns the XaitPorterCreateProjectOptions for the UI to call instead of

Request Information

URI

https://ofd-api.blueprintcpq.net/xaitporter/existing_project_options?recordId={recordId}

URI Parameters

NameDescriptionTypeAdditional information
recordId

CPQ record Identifier i.e. Quote Id

 string

Required

Body Parameters

None.

Response Information

Resource Description

object with a valid value.

XaitPorterCreateProjectOptions
NameDescriptionTypeAdditional information
page

string

None.
view

string

None.
recordId

string

None.
projectName

string

None.
projectTemplateId

integer

None.
projectTemplateName

string

None.
selectedDocuments

Collection of XaitPorterDocument

None.
projectRecordId

globally unique identifier

None.
projectId

integer

None.
projectDocumentLink

string

None.
productsChanged

boolean

None.
requestId

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "page": "sample string 1",
  "view": "sample string 2",
  "recordId": "sample string 3",
  "projectName": "sample string 4",
  "projectTemplateId": 5,
  "projectTemplateName": "sample string 6",
  "selectedDocuments": [
    {
      "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:05:42.7760584Z",
      "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:05:42.7760584Z",
      "productVersion": 5,
      "documentId": 6,
      "documentName": "sample string 7",
      "id": 8,
      "name": "sample string 9"
    }
  ],
  "projectRecordId": "3aacdb09-78a1-4606-bf1e-56c6f5831050",
  "projectId": 8,
  "projectDocumentLink": "sample string 9",
  "productsChanged": true,
  "requestId": "sample string 11"
}

text/html

Sample: 
{"page":"sample string 1","view":"sample string 2","recordId":"sample string 3","projectName":"sample string 4","projectTemplateId":5,"projectTemplateName":"sample string 6","selectedDocuments":[{"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:05:42.7760584Z","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:05:42.7760584Z","productVersion":5,"documentId":6,"documentName":"sample string 7","id":8,"name":"sample string 9"}],"projectRecordId":"3aacdb09-78a1-4606-bf1e-56c6f5831050","projectId":8,"projectDocumentLink":"sample string 9","productsChanged":true,"requestId":"sample string 11"}

application/xml, text/xml

Sample: 
<XaitPorterCreateProjectOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Page>sample string 1</Page>
  <ProductsChanged>true</ProductsChanged>
  <ProjectDocumentLink>sample string 9</ProjectDocumentLink>
  <ProjectId>8</ProjectId>
  <ProjectName>sample string 4</ProjectName>
  <ProjectRecordId>3aacdb09-78a1-4606-bf1e-56c6f5831050</ProjectRecordId>
  <ProjectTemplateId>5</ProjectTemplateId>
  <ProjectTemplateName>sample string 6</ProjectTemplateName>
  <RecordId>sample string 3</RecordId>
  <RequestId>sample string 11</RequestId>
  <SelectedDocuments>
    <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:05:42.7760584+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:05:42.7760584+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>
  </SelectedDocuments>
  <View>sample string 2</View>
</XaitPorterCreateProjectOptions>