GET api/UserDefinedFields/{table}

Gets the list of all user defined fields that have been defined for a specific type of object.

Request Information

URI Parameters

Name	Description	Type	Additional information
table		UDFTable	Required

Body Parameters

None.

Response Information

Resource Description

Returns the list of user defined fields.

Collection of UserDefinedField

Name	Description	Type	Additional information
TableName	Gets or sets the name of the table that this field applies to.	UDFTable	None.
FieldName	Gets or sets the name of this field.	string	None.
Caption	Gets or sets a description/label for this field.	string	None.
DefaultValue	Gets or sets a default value for this field.	string	None.
Editable	Gets or sets whether this field is editable.	boolean	None.
Required	Gets or sets whether this field is required.	boolean	None.
InputType	Gets or sets the type of input that is being used to render this field.	UDFInputType	None.
SelectorType	Gets or sets how to get the list of pre-defined values for this field.	UDFSelectorType	None.
SelectorValues	The list of pre-defined values for this field, if any. Only applicable when is .	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "tableName": 0,
    "fieldName": "sample string 1",
    "caption": "sample string 2",
    "defaultValue": "sample string 3",
    "editable": true,
    "required": true,
    "inputType": 0,
    "selectorType": 0,
    "selectorValues": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "tableName": 0,
    "fieldName": "sample string 1",
    "caption": "sample string 2",
    "defaultValue": "sample string 3",
    "editable": true,
    "required": true,
    "inputType": 0,
    "selectorType": 0,
    "selectorValues": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserDefinedField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <UserDefinedField>
    <Caption>sample string 2</Caption>
    <DefaultValue>sample string 3</DefaultValue>
    <Editable>true</Editable>
    <FieldName>sample string 1</FieldName>
    <InputType>Unknown</InputType>
    <Required>true</Required>
    <SelectorType>None</SelectorType>
    <SelectorValues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SelectorValues>
    <TableName>Booking</TableName>
  </UserDefinedField>
  <UserDefinedField>
    <Caption>sample string 2</Caption>
    <DefaultValue>sample string 3</DefaultValue>
    <Editable>true</Editable>
    <FieldName>sample string 1</FieldName>
    <InputType>Unknown</InputType>
    <Required>true</Required>
    <SelectorType>None</SelectorType>
    <SelectorValues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SelectorValues>
    <TableName>Booking</TableName>
  </UserDefinedField>
</ArrayOfUserDefinedField>