GET developer/tables/{tableName}
Gets table detail.
Request Information
URI
https://ofd-api.blueprintcpq.net/developer/tables/{tableName}
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| tableName |
Name of the table. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The table detail.
DeveloperTable| Name | Description | Type | Additional 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": "79beac99-95e9-4217-888b-7c41aeecba78",
"Name": "sample string 2",
"Identifier": "sample string 3",
"HumanReadableField": {
"Id": "04cd62b2-82fc-4fa1-9064-6803e8d9fef3",
"Name": "sample string 2",
"Label": "sample string 3",
"MaxLength": 1,
"DataType": "sample string 4",
"Unique": true,
"Help": "sample string 6",
"Relationship": {
"Id": "cf74f39f-404d-433b-8f0a-11c820fa9de0",
"CanBeNull": true
}
},
"IdField": {
"Id": "04cd62b2-82fc-4fa1-9064-6803e8d9fef3",
"Name": "sample string 2",
"Label": "sample string 3",
"MaxLength": 1,
"DataType": "sample string 4",
"Unique": true,
"Help": "sample string 6",
"Relationship": {
"Id": "cf74f39f-404d-433b-8f0a-11c820fa9de0",
"CanBeNull": true
}
},
"LockField": {
"Id": "04cd62b2-82fc-4fa1-9064-6803e8d9fef3",
"Name": "sample string 2",
"Label": "sample string 3",
"MaxLength": 1,
"DataType": "sample string 4",
"Unique": true,
"Help": "sample string 6",
"Relationship": {
"Id": "cf74f39f-404d-433b-8f0a-11c820fa9de0",
"CanBeNull": true
}
},
"CurrencyField": {
"Id": "04cd62b2-82fc-4fa1-9064-6803e8d9fef3",
"Name": "sample string 2",
"Label": "sample string 3",
"MaxLength": 1,
"DataType": "sample string 4",
"Unique": true,
"Help": "sample string 6",
"Relationship": {
"Id": "cf74f39f-404d-433b-8f0a-11c820fa9de0",
"CanBeNull": true
}
},
"Fields": [
{
"Id": "04cd62b2-82fc-4fa1-9064-6803e8d9fef3",
"Name": "sample string 2",
"Label": "sample string 3",
"MaxLength": 1,
"DataType": "sample string 4",
"Unique": true,
"Help": "sample string 6",
"Relationship": {
"Id": "cf74f39f-404d-433b-8f0a-11c820fa9de0",
"CanBeNull": true
}
},
{
"Id": "04cd62b2-82fc-4fa1-9064-6803e8d9fef3",
"Name": "sample string 2",
"Label": "sample string 3",
"MaxLength": 1,
"DataType": "sample string 4",
"Unique": true,
"Help": "sample string 6",
"Relationship": {
"Id": "cf74f39f-404d-433b-8f0a-11c820fa9de0",
"CanBeNull": true
}
}
],
"Relationships": [
{
"RelationshipType": "sample string 1",
"RelatedTableName": "sample string 2",
"RelatedTableId": "545a0318-9d7b-4af7-8148-77303cecc32b",
"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": "545a0318-9d7b-4af7-8148-77303cecc32b",
"RelatedTableIdentifier": "sample string 4",
"FromFieldName": "sample string 5",
"ToFieldName": "sample string 6",
"ToFieldDataType": "sample string 7",
"CanBeNull": true
}
]
}
text/html
Sample:
{"Id":"79beac99-95e9-4217-888b-7c41aeecba78","Name":"sample string 2","Identifier":"sample string 3","HumanReadableField":{"Id":"04cd62b2-82fc-4fa1-9064-6803e8d9fef3","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"cf74f39f-404d-433b-8f0a-11c820fa9de0","CanBeNull":true}},"IdField":{"Id":"04cd62b2-82fc-4fa1-9064-6803e8d9fef3","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"cf74f39f-404d-433b-8f0a-11c820fa9de0","CanBeNull":true}},"LockField":{"Id":"04cd62b2-82fc-4fa1-9064-6803e8d9fef3","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"cf74f39f-404d-433b-8f0a-11c820fa9de0","CanBeNull":true}},"CurrencyField":{"Id":"04cd62b2-82fc-4fa1-9064-6803e8d9fef3","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"cf74f39f-404d-433b-8f0a-11c820fa9de0","CanBeNull":true}},"Fields":[{"Id":"04cd62b2-82fc-4fa1-9064-6803e8d9fef3","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"cf74f39f-404d-433b-8f0a-11c820fa9de0","CanBeNull":true}},{"Id":"04cd62b2-82fc-4fa1-9064-6803e8d9fef3","Name":"sample string 2","Label":"sample string 3","MaxLength":1,"DataType":"sample string 4","Unique":true,"Help":"sample string 6","Relationship":{"Id":"cf74f39f-404d-433b-8f0a-11c820fa9de0","CanBeNull":true}}],"Relationships":[{"RelationshipType":"sample string 1","RelatedTableName":"sample string 2","RelatedTableId":"545a0318-9d7b-4af7-8148-77303cecc32b","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":"545a0318-9d7b-4af7-8148-77303cecc32b","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.