Jump to

• Request
• Response

Get available metadata for tables.

get

/sync/rest-service/dataservice/metadata/tables

The result contains all the tables that the user can issue queries to retrieve data from.

Request

Supported Media Types

• application/json

Query Parameters

• configCode(optional): string
  The configuration name.

  Default Value: default

  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 user friendly table name.
• isBlackListed(optional): string
  Is the table blacklisted.
• physicalTableName(optional): string
  The actual table name in the database.
• serviceCode(optional): string
  The microservice name that the table belongs to.
• serviceId(optional): integer(int64)
  The service Id that the table belongs to.
• 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 user friendly table name."
        },
        "tableType":{
            "type":"string",
            "description":"The table type.",
            "enum":[
                "STANDARD",
                "VIEW",
                "SYNONYM"
            ]
        },
        "serviceCode":{
            "type":"string",
            "description":"The microservice name that the table belongs to."
        },
        "serviceId":{
            "type":"integer",
            "format":"int64",
            "description":"The service Id that the table belongs to."
        },
        "isBlackListed":{
            "type":"string",
            "description":"Is the table blacklisted."
        }
    },
    "description":"The table properties in metadata."
}

500 Response

Internal Server Error

Back to Top