GET api/Fields?tableName={tableName}

Returns field display names in an array for the provided table

Request Information

URI Parameters

Name	Description	Type	Additional information
tableName	Table name values can include "Contact", "Company", "Group", "Opportunity", or the name of the Custom Table	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of DBField

Name	Type	Additional information
Id	globally unique identifier	None.
ColumnName	string	None.
Alias	string	None.
DisplayName	string	None.
FieldType	string	None.
IsReadOnly	boolean	None.
IsTracked	boolean	None.
AllowEmpty	boolean	None.
IsCustom	boolean	None.
Length	integer	None.
Size	integer	None.
TableName	string	None.
Attributes	Collection of DBAttribute	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "c3f856cf-20b6-4ca5-a6d9-dd0cc2e84e12",
    "ColumnName": "sample string 2",
    "Alias": "sample string 3",
    "DisplayName": "sample string 4",
    "FieldType": "sample string 5",
    "IsReadOnly": true,
    "IsTracked": true,
    "AllowEmpty": true,
    "IsCustom": true,
    "Length": 10,
    "Size": 11,
    "TableName": "sample string 12",
    "Attributes": [
      {
        "Left": 1,
        "Right": 2,
        "MinimumLength": 3,
        "Mask": "sample string 4",
        "AttributeName": "sample string 5",
        "TypeId": "sample string 6",
        "Size": 7,
        "Length": 8,
        "DefaultValue": {},
        "AllowEmpty": true,
        "PickListID": "810180d4-dcd9-4bc2-b402-e84b8124fd70",
        "PickListType": 1,
        "IsLimitToList": true,
        "IsMultiSelect": true,
        "IsTypeAhead": true,
        "ShowDescription": true
      },
      {
        "Left": 1,
        "Right": 2,
        "MinimumLength": 3,
        "Mask": "sample string 4",
        "AttributeName": "sample string 5",
        "TypeId": "sample string 6",
        "Size": 7,
        "Length": 8,
        "DefaultValue": {},
        "AllowEmpty": true,
        "PickListID": "810180d4-dcd9-4bc2-b402-e84b8124fd70",
        "PickListType": 1,
        "IsLimitToList": true,
        "IsMultiSelect": true,
        "IsTypeAhead": true,
        "ShowDescription": true
      }
    ]
  },
  {
    "Id": "c3f856cf-20b6-4ca5-a6d9-dd0cc2e84e12",
    "ColumnName": "sample string 2",
    "Alias": "sample string 3",
    "DisplayName": "sample string 4",
    "FieldType": "sample string 5",
    "IsReadOnly": true,
    "IsTracked": true,
    "AllowEmpty": true,
    "IsCustom": true,
    "Length": 10,
    "Size": 11,
    "TableName": "sample string 12",
    "Attributes": [
      {
        "Left": 1,
        "Right": 2,
        "MinimumLength": 3,
        "Mask": "sample string 4",
        "AttributeName": "sample string 5",
        "TypeId": "sample string 6",
        "Size": 7,
        "Length": 8,
        "DefaultValue": {},
        "AllowEmpty": true,
        "PickListID": "810180d4-dcd9-4bc2-b402-e84b8124fd70",
        "PickListType": 1,
        "IsLimitToList": true,
        "IsMultiSelect": true,
        "IsTypeAhead": true,
        "ShowDescription": true
      },
      {
        "Left": 1,
        "Right": 2,
        "MinimumLength": 3,
        "Mask": "sample string 4",
        "AttributeName": "sample string 5",
        "TypeId": "sample string 6",
        "Size": 7,
        "Length": 8,
        "DefaultValue": {},
        "AllowEmpty": true,
        "PickListID": "810180d4-dcd9-4bc2-b402-e84b8124fd70",
        "PickListType": 1,
        "IsLimitToList": true,
        "IsMultiSelect": true,
        "IsTypeAhead": true,
        "ShowDescription": true
      }
    ]
  }
]