Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful Operation

Body ()

Root Schema : List<MDColumnRO>

Type: array

Title: List<MDColumnRO>

Show Source

• Array of: object MDColumnRO
  Title: MDColumnRO

  The column properties of a table.

{
    "title":"List<MDColumnRO>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/MDColumnRO",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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.

{
    "title":"MDColumnRO",
    "type":"object",
    "properties":{
        "tableName":{
            "type":"string",
            "description":"The database table name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "type":"string",
            "description":"The column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "syncConfigCode":{
            "type":"string",
            "description":"The configuration code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "displayName":{
            "type":"string",
            "description":"The display column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dataType":{
            "type":"string",
            "description":"The data type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "physicalDataType":{
            "type":"string",
            "description":"The data type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isPK":{
            "type":"boolean",
            "description":"If the column is the primary key.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isFK":{
            "type":"boolean",
            "description":"If the column is the foreign key.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "fkTableName":{
            "type":"string",
            "description":"The foreign key table name if it is a foreign key column.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "tableType":{
            "type":"string",
            "description":"The table type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "STANDARD",
                "VIEW",
                "SYNONYM"
            ]
        }
    },
    "description":"The column properties of a table.",
    "exampleSetFlag":false
}

400 Response

Bad Request

500 Response

Internal Server Error

Back to Top