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

GetCustomFormFieldResult

Name	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.
RequiredWhenFinished	True if the field is requried when ticket should be set to state "Closed"	boolean	None.
AllowEditingByOperatorsOnly	True if only operator can edit the field	boolean	None.
PlaceHolderText	The place holder	string	None.
RegularExpression	The regular expression	string	None.
Disabled	The field is disabled	boolean	None.
DateType	The property is set only if Type is Date	CustomFormFieldDateType	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Title": "Versions",
  "Description": "Everything else",
  "Type": 2,
  "Required": false,
  "Items": null,
  "AddPleaseSelect": false,
  "RequiredWhenFinished": false,
  "AllowEditingByOperatorsOnly": false,
  "PlaceHolderText": null,
  "RegularExpression": null,
  "Disabled": false,
  "DateType": null
}

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>
  <AllowEditingByOperatorsOnly>false</AllowEditingByOperatorsOnly>
  <DateType i:nil="true" />
  <Description>Everything else</Description>
  <Disabled>false</Disabled>
  <Id>1</Id>
  <Items i:nil="true" />
  <PlaceHolderText i:nil="true" />
  <RegularExpression i:nil="true" />
  <Required>false</Required>
  <RequiredWhenFinished>false</RequiredWhenFinished>
  <Title>Versions</Title>
  <Type>Textbox</Type>
</GetCustomFormFieldResult>