XaitCPQ API

GET developer/tables

Gets all tables.

Request Information

URI

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

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

all tables.

Collection of DeveloperTable
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
Identifier

string

None.
HumanReadableField

DeveloperField

None.
IdField

DeveloperField

None.
LockField

DeveloperField

None.
CurrencyField

DeveloperField

None.
Fields

Collection of DeveloperField

None.
Relationships

Collection of DeveloperTableRelationship

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "2c240aab-4174-4cf4-9f44-9165919a0705",
    "Name": "sample string 2",
    "Identifier": "sample string 3",
    "HumanReadableField": {
      "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
      "Name": "sample string 2",
      "Label": "sample string 3",
      "MaxLength": 1,
      "DataType": "sample string 4",
      "Unique": true,
      "Help": "sample string 6",
      "Relationship": {
        "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
        "CanBeNull": true
      }
    },
    "IdField": {
      "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
      "Name": "sample string 2",
      "Label": "sample string 3",
      "MaxLength": 1,
      "DataType": "sample string 4",
      "Unique": true,
      "Help": "sample string 6",
      "Relationship": {
        "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
        "CanBeNull": true
      }
    },
    "LockField": {
      "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
      "Name": "sample string 2",
      "Label": "sample string 3",
      "MaxLength": 1,
      "DataType": "sample string 4",
      "Unique": true,
      "Help": "sample string 6",
      "Relationship": {
        "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
        "CanBeNull": true
      }
    },
    "CurrencyField": {
      "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
      "Name": "sample string 2",
      "Label": "sample string 3",
      "MaxLength": 1,
      "DataType": "sample string 4",
      "Unique": true,
      "Help": "sample string 6",
      "Relationship": {
        "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
        "CanBeNull": true
      }
    },
    "Fields": [
      {
        "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
        "Name": "sample string 2",
        "Label": "sample string 3",
        "MaxLength": 1,
        "DataType": "sample string 4",
        "Unique": true,
        "Help": "sample string 6",
        "Relationship": {
          "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
          "CanBeNull": true
        }
      },
      {
        "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
        "Name": "sample string 2",
        "Label": "sample string 3",
        "MaxLength": 1,
        "DataType": "sample string 4",
        "Unique": true,
        "Help": "sample string 6",
        "Relationship": {
          "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
          "CanBeNull": true
        }
      }
    ],
    "Relationships": [
      {
        "RelationshipType": "sample string 1",
        "RelatedTableName": "sample string 2",
        "RelatedTableId": "73d956da-a411-48d3-9626-2325f6f7df50",
        "RelatedTableIdentifier": "sample string 4",
        "FromFieldName": "sample string 5",
        "ToFieldName": "sample string 6",
        "ToFieldDataType": "sample string 7",
        "CanBeNull": true
      },
      {
        "RelationshipType": "sample string 1",
        "RelatedTableName": "sample string 2",
        "RelatedTableId": "73d956da-a411-48d3-9626-2325f6f7df50",
        "RelatedTableIdentifier": "sample string 4",
        "FromFieldName": "sample string 5",
        "ToFieldName": "sample string 6",
        "ToFieldDataType": "sample string 7",
        "CanBeNull": true
      }
    ]
  },
  {
    "Id": "2c240aab-4174-4cf4-9f44-9165919a0705",
    "Name": "sample string 2",
    "Identifier": "sample string 3",
    "HumanReadableField": {
      "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
      "Name": "sample string 2",
      "Label": "sample string 3",
      "MaxLength": 1,
      "DataType": "sample string 4",
      "Unique": true,
      "Help": "sample string 6",
      "Relationship": {
        "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
        "CanBeNull": true
      }
    },
    "IdField": {
      "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
      "Name": "sample string 2",
      "Label": "sample string 3",
      "MaxLength": 1,
      "DataType": "sample string 4",
      "Unique": true,
      "Help": "sample string 6",
      "Relationship": {
        "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
        "CanBeNull": true
      }
    },
    "LockField": {
      "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
      "Name": "sample string 2",
      "Label": "sample string 3",
      "MaxLength": 1,
      "DataType": "sample string 4",
      "Unique": true,
      "Help": "sample string 6",
      "Relationship": {
        "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
        "CanBeNull": true
      }
    },
    "CurrencyField": {
      "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
      "Name": "sample string 2",
      "Label": "sample string 3",
      "MaxLength": 1,
      "DataType": "sample string 4",
      "Unique": true,
      "Help": "sample string 6",
      "Relationship": {
        "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
        "CanBeNull": true
      }
    },
    "Fields": [
      {
        "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
        "Name": "sample string 2",
        "Label": "sample string 3",
        "MaxLength": 1,
        "DataType": "sample string 4",
        "Unique": true,
        "Help": "sample string 6",
        "Relationship": {
          "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
          "CanBeNull": true
        }
      },
      {
        "Id": "54a4e497-502a-49c1-8373-ebb3581c21f1",
        "Name": "sample string 2",
        "Label": "sample string 3",
        "MaxLength": 1,
        "DataType": "sample string 4",
        "Unique": true,
        "Help": "sample string 6",
        "Relationship": {
          "Id": "96844749-3cd9-45c7-92fa-97caceb4ac01",
          "CanBeNull": true
        }
      }
    ],
    "Relationships": [
      {
        "RelationshipType": "sample string 1",
        "RelatedTableName": "sample string 2",
        "RelatedTableId": "73d956da-a411-48d3-9626-2325f6f7df50",
        "RelatedTableIdentifier": "sample string 4",
        "FromFieldName": "sample string 5",
        "ToFieldName": "sample string 6",
        "ToFieldDataType": "sample string 7",
        "CanBeNull": true
      },
      {
        "RelationshipType": "sample string 1",
        "RelatedTableName": "sample string 2",
        "RelatedTableId": "73d956da-a411-48d3-9626-2325f6f7df50",
        "RelatedTableIdentifier": "sample string 4",
        "FromFieldName": "sample string 5",
        "ToFieldName": "sample string 6",
        "ToFieldDataType": "sample string 7",
        "CanBeNull": true
      }
    ]
  }
]

text/html

Sample: 
[{"Id":"2c240aab-4174-4cf4-9f44-9165919a0705","Name":"sample string 2","Identifier":"sample string 3","HumanReadableField":{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},"IdField":{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},"LockField":{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},"CurrencyField":{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},"Fields":[{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}}],"Relationships":[{"RelationshipType":"sample string 1","RelatedTableName":"sample string 2","RelatedTableId":"73d956da-a411-48d3-9626-2325f6f7df50","RelatedTableIdentifier":"sample string 4","FromFieldName":"sample string 5","ToFieldName":"sample string 6","ToFieldDataType":"sample string 7","CanBeNull":true},{"RelationshipType":"sample string 1","RelatedTableName":"sample string 2","RelatedTableId":"73d956da-a411-48d3-9626-2325f6f7df50","RelatedTableIdentifier":"sample string 4","FromFieldName":"sample string 5","ToFieldName":"sample string 6","ToFieldDataType":"sample string 7","CanBeNull":true}]},{"Id":"2c240aab-4174-4cf4-9f44-9165919a0705","Name":"sample string 2","Identifier":"sample string 3","HumanReadableField":{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},"IdField":{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},"LockField":{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},"CurrencyField":{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},"Fields":[{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}},{"Id":"54a4e497-502a-49c1-8373-ebb3581c21f1","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"96844749-3cd9-45c7-92fa-97caceb4ac01","CanBeNull":true}}],"Relationships":[{"RelationshipType":"sample string 1","RelatedTableName":"sample string 2","RelatedTableId":"73d956da-a411-48d3-9626-2325f6f7df50","RelatedTableIdentifier":"sample string 4","FromFieldName":"sample string 5","ToFieldName":"sample string 6","ToFieldDataType":"sample string 7","CanBeNull":true},{"RelationshipType":"sample string 1","RelatedTableName":"sample string 2","RelatedTableId":"73d956da-a411-48d3-9626-2325f6f7df50","RelatedTableIdentifier":"sample string 4","FromFieldName":"sample string 5","ToFieldName":"sample string 6","ToFieldDataType":"sample string 7","CanBeNull":true}]}]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.