POST api/customfield/{save}

Save a custom field within a predefinied custom field group. Processes this custom field API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
save		string	None.

Body Parameters

The save custom field command data contract supplied with the request.

SaveCustomFieldCommandDataContract

Name	Description	Type	Additional information
CustomFieldGroupId	The unique identifier of the related custom field group resource.	integer	None.
TypeSystemName	The type system name value.	string	None.
ControlTypeSystemName	The control type system name value.	string	None.
Name	The name value.	string	None.
Validator	The validator value.	string	None.
Order	The order value.	integer	None.
Options	The collection of options.	Collection of string	None.
SystemStatus	The system status value.	EnumDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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"
  ],
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 7
}

Response Information

Resource Description

The response returned after the operation completes.

CustomFieldDataContract

Name	Description	Type	Additional information
Type	The type value.	EnumDataContract	None.
ControlType	The control type value.	EnumDataContract	None.
Name	The name value.	string	None.
Validator	The validator value.	string	None.
Order	The order value.	integer	None.
Options	The collection of options.	Collection of string	None.
SystemStatus	The system status value.	EnumDataContract	None.
Id	The unique identifier of this resource.	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"
  ],
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 4
}