Get Columns Metadata of Table
get
/pds/rest-service/dataservice/metadata/columns/{tableName}
Send a request to this endpoint to fetch specified table columns info for specified configuration name. This endpoint will returns all columns associate with requested table and configuration name.
Request
Path Parameters
-
tableName(required): string
The table name.
Query Parameters
-
configCode(required): string
The configuration name.Allowed Values:
[ "ds_p6adminuser", "ds_p6reportuser", "ds_unifier" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful Operation
Root Schema : List<MDColumnRO>
Type:
array
Title:
Show Source
List<MDColumnRO>
-
Array of:
object MDColumnRO
Title:
MDColumnRO
The column properties of a table.
Nested Schema : MDColumnRO
Type:
object
Title:
MDColumnRO
The column properties of a table.
Show Source
-
columnName: string
The column name.
-
dataType: string
The data type.
-
displayName: string
The display column name.
-
fkTableName: string
The foreign key table name if it is a foreign key column.
-
isFK: boolean
If the column is the foreign key.
-
isPK: boolean
If the column is the primary key.
-
physicalDataType: string
The data type.
-
syncConfigCode: string
The configuration code.
-
tableName: string
The database table name.
-
tableType: string
Allowed Values:
[ "STANDARD", "VIEW", "SYNONYM" ]
The table type.
400 Response
Bad Request
500 Response
Internal Server Error