GET api/CustomForms/GetCustomFormField/{id}
Gets custom form field and its settings.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
GetCustomFormFieldResultName | Description | Type | Additional information |
---|---|---|---|
Id |
Custom form field id |
integer |
None. |
Title |
The title |
string |
None. |
Description |
The description |
string |
None. |
Type |
The type |
CustomFieldTypeEnum |
None. |
Required |
True if the field is required |
boolean |
None. |
Items | Collection of GetCustomFormFieldItemResult |
None. |
|
AddPleaseSelect |
True if the field should have "please select" option |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "Title": "Versions", "Description": "Everything else", "Type": 2, "Required": false, "Items": null, "AddPleaseSelect": false }
application/xml, text/xml
Sample:
<GetCustomFormFieldResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results"> <AddPleaseSelect>false</AddPleaseSelect> <Description>Everything else</Description> <Id>1</Id> <Items i:nil="true" /> <Required>false</Required> <Title>Versions</Title> <Type>Textbox</Type> </GetCustomFormFieldResult>