Jump to

• Request
• Response

Get available columns for the specified table.

get

/sync/rest-service/dataservice/metadata/columns/{tableName}

The result contains all available columns for the specified table.

Request

Supported Media Types

• application/json

Path Parameters

• tableName: string
  The table name.

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 columns

Type: object

The column properties of a table.

Show Source

• columnName(optional): string
  The column name.
• dataType(optional): string
  The data type.
• displayName(optional): string
  The user friendly column name.
• fkTableName(optional): string
  The foreign key table name if it is a foreign key column.
• isFK(optional): boolean
  Default Value: false

  If the column is the foreign key.
• isPK(optional): boolean
  Default Value: false

  If the column is the primary key.
• syncConfigCode(optional): string
  The sync config id.
• tableName(optional): string
  The database table name.
• tableType(optional): string
  Allowed Values: [ "STANDARD", "VIEW", "SYNONYM" ]

  The table type.

{
    "type":"object",
    "properties":{
        "tableName":{
            "type":"string",
            "description":"The database table name."
        },
        "columnName":{
            "type":"string",
            "description":"The column name."
        },
        "syncConfigCode":{
            "type":"string",
            "description":"The sync config id."
        },
        "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.",
            "default":false
        },
        "isFK":{
            "type":"boolean",
            "description":"If the column is the foreign key.",
            "default":false
        },
        "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",
                "VIEW",
                "SYNONYM"
            ]
        }
    },
    "description":"The column properties of a table."
}

400 Response

Bad Request

500 Response

Internal Server Error

Back to Top