POST 17.0/database/definablefields/list

Description

Retrieve a list of Definable Fields

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of DefinableFieldsUpdate
Name Description Type Additional information
ID

integer

None.
Description

string

String length: inclusive between 0 and 30
DefinableFieldGroupID

integer

None.
Type

byte

None.
DisplayOrder

integer

None.
WebUpload

byte

None.
ActionID

integer

None.
ShowAsReminder

byte

None.
CurrentOnlyReminder

byte

None.
InActive

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 1",
    "definableFieldGroupID": 1,
    "type": 64,
    "displayOrder": 1,
    "webUpload": 64,
    "actionID": 1,
    "showAsReminder": 64,
    "currentOnlyReminder": 64,
    "inActive": 64
  },
  {
    "id": 1,
    "description": "sample string 1",
    "definableFieldGroupID": 1,
    "type": 64,
    "displayOrder": 1,
    "webUpload": 64,
    "actionID": 1,
    "showAsReminder": 64,
    "currentOnlyReminder": 64,
    "inActive": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfDefinableFieldsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DefinableFieldsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <DefinableFieldGroupID>1</DefinableFieldGroupID>
    <Type>64</Type>
    <DisplayOrder>1</DisplayOrder>
    <WebUpload>64</WebUpload>
    <ActionID>1</ActionID>
    <ShowAsReminder>64</ShowAsReminder>
    <CurrentOnlyReminder>64</CurrentOnlyReminder>
    <InActive>64</InActive>
  </DefinableFieldsUpdate>
  <DefinableFieldsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <DefinableFieldGroupID>1</DefinableFieldGroupID>
    <Type>64</Type>
    <DisplayOrder>1</DisplayOrder>
    <WebUpload>64</WebUpload>
    <ActionID>1</ActionID>
    <ShowAsReminder>64</ShowAsReminder>
    <CurrentOnlyReminder>64</CurrentOnlyReminder>
    <InActive>64</InActive>
  </DefinableFieldsUpdate>
</ArrayOfDefinableFieldsUpdate>