Jump to

• Request
• Response

Get available metadata tables

get

/data/rest/dataservice/tables

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

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

API success

Body ()

Root Schema : List<MDTableRO>

Type: array

Title: List<MDTableRO>

Show Source

• Array of: object MDTableRO
  Title: MDTableRO

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

Nested Schema : MDTableRO

Type: object

Title: MDTableRO

Show Source

• displayTableName: string
  The user friendly table name
• physicalTableName: string
  The actual table name in database
• serviceCode: string
  the microservice name that the table belongs to
• tableType: string
  Allowed Values: [ "STANDARD" ]

  The table type

{
    "title":"MDTableRO",
    "type":"object",
    "properties":{
        "tableType":{
            "type":"string",
            "description":"The table type",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "STANDARD"
            ]
        },
        "physicalTableName":{
            "type":"string",
            "description":"The actual table name in database",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "displayTableName":{
            "type":"string",
            "description":"The user friendly table name",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "serviceCode":{
            "type":"string",
            "description":"the microservice name that the table belongs to",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

403 Response

You do not have access to the resource.

Back to Top