Jump to

• Request
• Response

Get available columns for the specified table

get

/data/rest/dataservice/columns/{tableName}

The result contains all available columns for the specified table

Request

Path Parameters

• tableName(required): string
  The table name

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<MDColumnRO>

Type: array

Title: List<MDColumnRO>

Show Source

• Array of: object MDColumnRO
  Title: MDColumnRO

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

Nested Schema : MDColumnRO

Type: object

Title: MDColumnRO

Show Source

• columnName: string
  The column name
• dataType: string
  The data type
• displayName: string
  The user friendly 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
• tableName: string
  The database table name
• tableType: string
  Allowed Values: [ "STANDARD" ]

  The table type

{
    "title":"MDColumnRO",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"The user friendly column name",
            "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"
            ]
        },
        "tableName":{
            "type":"string",
            "description":"The database table name",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "type":"string",
            "description":"The column name",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dataType":{
            "type":"string",
            "description":"The data type",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

403 Response

You do not have access to the resource.

404 Response

The table does not exist

Back to Top