Jump to

• Request
• Response

Get Tables Metadata

get

/pds/rest-service/dataservice/metadata/tables

Send a request to this endpoint to fetch tables metadata for specified configuration name. This endpoint will returns all tables metadata associate with requested configuration name.

Request

Supported Media Types

• application/json

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 tables

Type: object

The table properties in metadata.

Show Source

• displayTableName(optional): string
  The display table name in the database.
• isBlackListed(optional): string
  Is the table blacklisted.
• physicalTableName(optional): string
  The actual table name in the database.
• serviceCode(optional): string
  The service name that the table.
• syncConfigCode(optional): string
  The sync config id.
• tableType(optional): string
  Allowed Values: [ "STANDARD", "VIEW", "SYNONYM" ]

  The table type.

{
    "type":"object",
    "properties":{
        "syncConfigCode":{
            "type":"string",
            "description":"The sync config id."
        },
        "physicalTableName":{
            "type":"string",
            "description":"The actual table name in the database."
        },
        "displayTableName":{
            "type":"string",
            "description":"The display table name in the database."
        },
        "tableType":{
            "type":"string",
            "description":"The table type.",
            "enum":[
                "STANDARD",
                "VIEW",
                "SYNONYM"
            ]
        },
        "serviceCode":{
            "type":"string",
            "description":"The service name that the table."
        },
        "isBlackListed":{
            "type":"string",
            "description":"Is the table blacklisted."
        }
    },
    "description":"The table properties in metadata."
}

400 Response

Bad Request

500 Response

Internal Server Error

Back to Top