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

Supported Media Types

• application/json

Path Parameters

• tableName: string
  The table name.

Query Parameters

• configCode: string
  The configuration name.

  Allowed Values: [ "ds_p6adminuser", "ds_p6reportuser", "ds_unifier" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : Metadata for columns

Type: object

The column properties of a table.

Show Source

• columnName(optional): string
  The column name.
• dataType(optional): string
  The data type.
• displayName(optional): string
  The display column name.
• fkTableName(optional): string
  The foreign key table name if it is a foreign key column.
• isFK(optional): boolean
  If the column is the foreign key.
• isPK(optional): boolean
  If the column is the primary key.
• physicalDataType(optional): string
  The data type.
• syncConfigCode(optional): string
  The configuration code.
• tableName(optional): string
  The database table name.
• tableType(optional): string
  Allowed Values: [ "STANDARD", "VIEW", "SYNONYM" ]

  The table type.

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

400 Response

Bad Request

500 Response

Internal Server Error

Back to Top