GET api/v2/schema/{table}

Gets schema information for the specified table. This will not work for the CON table due to a reserved keyword, please use the POST call for CON details.

Request Information

URI Parameters

Name	Description	Type	Additional information
table		string	Required

Body Parameters

None.

Response Information

Resource Description

TableSchema

Name	Description	Type	Additional information
Table		string	None.
Fields		Collection of TableFieldSchema	None.

Response Formats

application/json, text/json

Sample:

{
  "Table": "sample string 1",
  "Fields": [
    {
      "Field": "sample string 1",
      "TypeName": "sample string 2",
      "MaxLength": 3,
      "Precision": 4,
      "Scale": 5,
      "IsNullable": true
    },
    {
      "Field": "sample string 1",
      "TypeName": "sample string 2",
      "MaxLength": 3,
      "Precision": 4,
      "Scale": 5,
      "IsNullable": true
    }
  ]
}

application/xml, text/xml

Sample:

<TableSchema xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SchoolMint.Aeries.DataV2">
  <Fields>
    <TableFieldSchema>
      <Field>sample string 1</Field>
      <IsNullable>true</IsNullable>
      <MaxLength>3</MaxLength>
      <Precision>4</Precision>
      <Scale>5</Scale>
      <TypeName>sample string 2</TypeName>
    </TableFieldSchema>
    <TableFieldSchema>
      <Field>sample string 1</Field>
      <IsNullable>true</IsNullable>
      <MaxLength>3</MaxLength>
      <Precision>4</Precision>
      <Scale>5</Scale>
      <TypeName>sample string 2</TypeName>
    </TableFieldSchema>
  </Fields>
  <Table>sample string 1</Table>
</TableSchema>