GetReferenceTables - GET
|
Path |
/api/projects/{projectId}/model/referencetables |
|---|---|
|
Http Method |
GET |
Overview
Required permissions
-
Read access to the Build module. BUILD READ
Request
Query parameters
See: Metavault API - General concepts | Paging, sorting and filters for collection query parameters.
Response
Success response (200 OK)
JSON
{
"_embedded": {
"referenceTables": [
{
"_embedded": {
"columns": [
{
"id": "8fe01bf7-26ca-40b7-b64b-00dbf9fc1a39",
"dataPackageColumnId": "3c8bfb48192543899f8703a400a05b1b",
"businessName": "",
"columnName": "column3",
"typeFullName": "VARCHAR",
"dataType": "String",
"description": "",
"defaultValue": "",
"order": 0
},
{
"id": "94616ee4-4d58-49b9-aec6-acf8d3d08728",
"dataPackageColumnId": "42e807ece62a4920842c46c5be117ae7",
"businessName": "",
"columnName": "column4",
"typeFullName": "VARCHAR",
"dataType": "String",
"description": "",
"defaultValue": "",
"order": 1
}
]
},
"name": "MyReferenceTable",
"id": "7810438a-faca-4cee-9669-cee01fda94c7",
"entityType": "ReferenceTable",
"isDeployedInProduction": false,
"stagingTableId": "662c1259e3c34c099b9762850064d8b6",
"targetTableName": "ref.MyReferenceTable",
"columns": [
{
"id": "8fe01bf7-26ca-40b7-b64b-00dbf9fc1a39",
"dataPackageColumnId": "3c8bfb48192543899f8703a400a05b1b",
"businessName": "",
"columnName": "column3",
"typeFullName": "VARCHAR",
"dataType": "String",
"defaultValue": "",
"description": "",
"order": 0
},
{
"id": "94616ee4-4d58-49b9-aec6-acf8d3d08728",
"dataPackageColumnId": "42e807ece62a4920842c46c5be117ae7",
"businessName": "",
"columnName": "column4",
"typeFullName": "VARCHAR",
"dataType": "String",
"defaultValue": "",
"description": "",
"order": 1
}
]
},
{
"_embedded": {
"columns": [
{
"id": "7b3a9e92-199d-4ac3-a145-0f2a0b5f6e7a",
"dataPackageColumnId": "802f8ee405db4251b820a22c1f95534b",
"businessName": "",
"columnName": "color",
"typeFullName": "VARCHAR(255)",
"dataType": "String",
"length": 255,
"description": "",
"defaultValue": "",
"order": 0
}
]
},
"name": "color_ref",
"id": "8938d79d-5cfb-427a-a4f1-4296dacdff1e",
"entityType": "ReferenceTable",
"isDeployedInProduction": false,
"stagingTableId": "b27526087e1241bc9b654dee38bdfaf0",
"targetTableName": "ref.color_ref",
"columns": [
{
"id": "7b3a9e92-199d-4ac3-a145-0f2a0b5f6e7a",
"dataPackageColumnId": "802f8ee405db4251b820a22c1f95534b",
"businessName": "",
"columnName": "color",
"typeFullName": "VARCHAR(255)",
"dataType": "String",
"length": 255,
"defaultValue": "",
"description": "",
"order": 0
}
]
}
]
},
"sort": [],
"index": 0,
"limit": 10,
"expand": [],
"total": 2
}
Response fields
For collection parameter responses see:Metavault API - General concepts