POST api/customfield/{save}

Save a custom field within a predefinied custom field group.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
save

string

None.

Body Parameters

SaveCustomFieldCommandDataContract
NameDescriptionTypeAdditional information
CustomFieldGroupId

integer

None.

TypeSystemName

string

None.

ControlTypeSystemName

string

None.

Name

string

None.

Validator

string

None.

Order

integer

None.

Options

Collection of string

None.

Id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomFieldGroupId": 1,
  "TypeSystemName": "sample string 2",
  "ControlTypeSystemName": "sample string 3",
  "Name": "sample string 4",
  "Validator": "sample string 5",
  "Order": 6,
  "Options": [
    "sample string 1",
    "sample string 2"
  ],
  "Id": 7
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomFieldDataContract
NameDescriptionTypeAdditional information
Type

EnumDataContract

None.

ControlType

EnumDataContract

None.

Name

string

None.

Validator

string

None.

Order

integer

None.

Options

Collection of string

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Type": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ControlType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Name": "sample string 1",
  "Validator": "sample string 2",
  "Order": 3,
  "Options": [
    "sample string 1",
    "sample string 2"
  ],
  "Id": 4
}