Returns the details of the given field of the given database table

GET

api/databases/{dbid}/metadata/tables/{table}/fields/{field}

This request is used for getting information about the given field of the given database table. For example, you can get such field properties as DisplayName - name of field displayed in UI, TypeName - name of data type (.NET), etc.

Request:

Argument	Type	Description
dbid	GUID	The ID of the database
table	String	The name of the database table
field	String	The name of the database table field

Response:

Content

Type name	Description
Object

Request:

GET api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/tables/Notifications/fields/Description
Accept: text/json
Accept-Encoding: deflate
Host: localhost:6496
Cookie: sid=20715d87-29dc-429e-9a86-4b3c60cd8a45

Response:

Transfer-Encoding: chunked
Content-Encoding: 
Cache-Control: no-store
Content-Type: text/json; charset=utf-8
Date: Fri, 21 Dec 2012 15:35:41 GMT
ETag: "634916866010755264"
Last-Modified: Fri, 21 Dec 2012 09:36:41 GMT
Server: Microsoft-HTTPAPI/2.0
 
{
  "MetaName": "Description",
  "Name": "Description",
  "DisplayName": "Description",
  "Description": "",
  "TypeName": "System.String",
  "BigStringLite": null,
  "HashValue": null,
  "ApiFlags": null,
  "Declarative": false,
  "LockedBySolution": false,
  "IsDelayed": false,
  "AllowNull": true,
  "System": false,
  "IsBigString": false,
  "IsBlob": false,
  "UserProtoBuf": false,
  "StringSize": 4096,
  "StringCutPolicy": {
    "Value": 1,
    "Title": "CutWithDot"
  },
  "IndexNames": "",
  "Calculated": false
}