Jump to

• Request
• Response

Get available columns for the specified table

get

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

The result contains all available columns for the specified table

Request

Path Parameters

• tableName(required): string
  The table name

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

{
    "type":"object",
    "properties":{
        "tableName":{
            "type":"string",
            "description":"The database table name"
        },
        "columnName":{
            "type":"string",
            "description":"The column name"
        },
        "displayName":{
            "type":"string",
            "description":"The user friendly column name"
        },
        "dataType":{
            "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"
            ]
        }
    },
    "description":"The column properties of a table"
}

403 Response

You do not have access to the resource.

404 Response

The table does not exist

Back to Top