Table metadata - PriceEdge API Documentation

Table metadata

Returns the column definitions for one table. Use it to see field names, data types, nullability, defaults, and which columns identify a row before you read, write, or delete data.

GET {api_url}/api/tables/{TableName}

Content-Type: application/json
Authorization: Bearer {token} // or ApiKey
client_id: {unique client id} // when using ApiKey, client_id is not needed

Path parameter	Description
`{TableName}`	Name of the table, for example `item`.

Example response

{
  "Data": [
    {
      "column_id": 2,
      "name": "_dtLastModifiedDate",
      "typeName": "datetime2",
      "max_length": 8,
      "precision": 27,
      "scale": 7,
      "is_nullable": true,
      "default_value": "(sysdatetime())",
      "is_primary_key": false,
      "typeName_display": "datetime2",
      "is_sparkline": false,
      "IsKey": false,
      "is_computed": false
    }
  ],
  "Errors": [],
  "Succeeded": true
}

Column fields

Each object in Data describes one column:

Field	Type	Description
`column_id`	`integer`	Internal identifier of the column.
`name`	`string`	Column name. Use this name in get, set, and delete requests.
`typeName`	`string`	Database type, such as `datetime2`, `nvarchar`, or `decimal`.
`max_length`	`integer`	Maximum storage length for the column.
`precision`	`integer`	Precision of numeric and datetime columns.
`scale`	`integer`	Scale of numeric columns.
`is_nullable`	`boolean`	Whether the column accepts null.
`default_value`	`string`	Default expression applied when a value is omitted. Null when the column has no default.
`is_primary_key`	`boolean`	Whether the column is part of the primary key.
`typeName_display`	`string`	Type label used for display.
`is_sparkline`	`boolean`	Whether the column is a sparkline.
`IsKey`	`boolean`	Whether the column identifies the row. Include key columns when you delete rows.
`is_computed`	`boolean`	Whether the database computes the column.

Errors is empty and Succeeded is true when the table metadata is returned.