PUT api/Fields?tableName={tableName}&fieldAlias={fieldAlias}

Edit an existing field

Request Information

URI Parameters

Name	Description	Type	Additional information
tableName		string	Required
fieldAlias		string	Required

Body Parameters

The record data must be passed in through the body of the request in Json format. Set Content-Type header to application/json

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.

Request Formats

application/json, text/json

Sample:

{
  "Id": "750250b6-7158-4af5-a37d-3edd909c4e89",
  "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": "d31472fc-8f54-49b3-b80f-c5a3448a73fe",
      "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": "d31472fc-8f54-49b3-b80f-c5a3448a73fe",
      "PickListType": 1,
      "IsLimitToList": true,
      "IsMultiSelect": true,
      "IsTypeAhead": true,
      "ShowDescription": true
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.