POST api/Fields?tableName={tableName}

Creates a new Field

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tableName

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
NameDescriptionTypeAdditional 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": "69b496da-6e18-4e43-9f8e-0f24457b99db",
  "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": "6ae0c058-7c09-4c31-bdd9-41411ebfae52",
      "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": "6ae0c058-7c09-4c31-bdd9-41411ebfae52",
      "PickListType": 1,
      "IsLimitToList": true,
      "IsMultiSelect": true,
      "IsTypeAhead": true,
      "ShowDescription": true
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

On successful record creation, returns the record GUID

None.