XaitCPQ API

GET xaitporter/tables

Gets all the tables tagged with external metadata JSON information on the XaitPorter tables for the XaitCPQ integration to identify and update. The tables are filtered based on the user's available access to the projects.

Request Information

URI

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

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

object with the list of Projects accessible by the user (based on the userEmail) and the list tables that belong to the accessible projects

Collection of XaitPorterProject
NameDescriptionTypeAdditional information
Tables

Collection of XaitPorterProjectTable

None.
id

integer

None.
name

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Tables": [
      {
        "Id": 1,
        "Reference": 2,
        "Name": "sample string 3",
        "DocumentId": 4,
        "DocumentTitle": "sample string 5",
        "DocumentLink": "sample string 6",
        "SectionId": 7,
        "SectionTitle": "sample string 8",
        "SectionLink": "sample string 9",
        "ProjectId": 10,
        "TableTag": "sample string 11"
      },
      {
        "Id": 1,
        "Reference": 2,
        "Name": "sample string 3",
        "DocumentId": 4,
        "DocumentTitle": "sample string 5",
        "DocumentLink": "sample string 6",
        "SectionId": 7,
        "SectionTitle": "sample string 8",
        "SectionLink": "sample string 9",
        "ProjectId": 10,
        "TableTag": "sample string 11"
      }
    ],
    "id": 1,
    "name": "sample string 2"
  },
  {
    "Tables": [
      {
        "Id": 1,
        "Reference": 2,
        "Name": "sample string 3",
        "DocumentId": 4,
        "DocumentTitle": "sample string 5",
        "DocumentLink": "sample string 6",
        "SectionId": 7,
        "SectionTitle": "sample string 8",
        "SectionLink": "sample string 9",
        "ProjectId": 10,
        "TableTag": "sample string 11"
      },
      {
        "Id": 1,
        "Reference": 2,
        "Name": "sample string 3",
        "DocumentId": 4,
        "DocumentTitle": "sample string 5",
        "DocumentLink": "sample string 6",
        "SectionId": 7,
        "SectionTitle": "sample string 8",
        "SectionLink": "sample string 9",
        "ProjectId": 10,
        "TableTag": "sample string 11"
      }
    ],
    "id": 1,
    "name": "sample string 2"
  }
]

text/html

Sample: 
[{"Tables":[{"Id":1,"Reference":2,"Name":"sample string 3","DocumentId":4,"DocumentTitle":"sample string 5","DocumentLink":"sample string 6","SectionId":7,"SectionTitle":"sample string 8","SectionLink":"sample string 9","ProjectId":10,"TableTag":"sample string 11"},{"Id":1,"Reference":2,"Name":"sample string 3","DocumentId":4,"DocumentTitle":"sample string 5","DocumentLink":"sample string 6","SectionId":7,"SectionTitle":"sample string 8","SectionLink":"sample string 9","ProjectId":10,"TableTag":"sample string 11"}],"id":1,"name":"sample string 2"},{"Tables":[{"Id":1,"Reference":2,"Name":"sample string 3","DocumentId":4,"DocumentTitle":"sample string 5","DocumentLink":"sample string 6","SectionId":7,"SectionTitle":"sample string 8","SectionLink":"sample string 9","ProjectId":10,"TableTag":"sample string 11"},{"Id":1,"Reference":2,"Name":"sample string 3","DocumentId":4,"DocumentTitle":"sample string 5","DocumentLink":"sample string 6","SectionId":7,"SectionTitle":"sample string 8","SectionLink":"sample string 9","ProjectId":10,"TableTag":"sample string 11"}],"id":1,"name":"sample string 2"}]

application/xml, text/xml

Sample: 
<ArrayOfXaitPorterProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <XaitPorterProject>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Tables>
      <XaitPorterProjectTable>
        <DocumentId>4</DocumentId>
        <DocumentLink>sample string 6</DocumentLink>
        <DocumentTitle>sample string 5</DocumentTitle>
        <Id>1</Id>
        <Name>sample string 3</Name>
        <ProjectId>10</ProjectId>
        <Reference>2</Reference>
        <SectionId>7</SectionId>
        <SectionLink>sample string 9</SectionLink>
        <SectionTitle>sample string 8</SectionTitle>
        <TableTag>sample string 11</TableTag>
      </XaitPorterProjectTable>
      <XaitPorterProjectTable>
        <DocumentId>4</DocumentId>
        <DocumentLink>sample string 6</DocumentLink>
        <DocumentTitle>sample string 5</DocumentTitle>
        <Id>1</Id>
        <Name>sample string 3</Name>
        <ProjectId>10</ProjectId>
        <Reference>2</Reference>
        <SectionId>7</SectionId>
        <SectionLink>sample string 9</SectionLink>
        <SectionTitle>sample string 8</SectionTitle>
        <TableTag>sample string 11</TableTag>
      </XaitPorterProjectTable>
    </Tables>
  </XaitPorterProject>
  <XaitPorterProject>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Tables>
      <XaitPorterProjectTable>
        <DocumentId>4</DocumentId>
        <DocumentLink>sample string 6</DocumentLink>
        <DocumentTitle>sample string 5</DocumentTitle>
        <Id>1</Id>
        <Name>sample string 3</Name>
        <ProjectId>10</ProjectId>
        <Reference>2</Reference>
        <SectionId>7</SectionId>
        <SectionLink>sample string 9</SectionLink>
        <SectionTitle>sample string 8</SectionTitle>
        <TableTag>sample string 11</TableTag>
      </XaitPorterProjectTable>
      <XaitPorterProjectTable>
        <DocumentId>4</DocumentId>
        <DocumentLink>sample string 6</DocumentLink>
        <DocumentTitle>sample string 5</DocumentTitle>
        <Id>1</Id>
        <Name>sample string 3</Name>
        <ProjectId>10</ProjectId>
        <Reference>2</Reference>
        <SectionId>7</SectionId>
        <SectionLink>sample string 9</SectionLink>
        <SectionTitle>sample string 8</SectionTitle>
        <TableTag>sample string 11</TableTag>
      </XaitPorterProjectTable>
    </Tables>
  </XaitPorterProject>
</ArrayOfXaitPorterProject>