POST 17.0/database/objectdefinablefields/list

Description

Retrieve a list of Object 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 ObjectDefinableFieldsUpdate
Name Description Type Additional information
ID

integer

None.
Type

integer

None.
DefinableFieldID

integer

None.
DefinableFieldItemID

integer

None.
Val

string

None.
ValNumber

decimal number

None.
ValDate

date

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "type": 1,
    "definableFieldID": 1,
    "definableFieldItemID": 1,
    "val": "sample string 1",
    "valNumber": 1.0,
    "valDate": "2025-01-09T20:41"
  },
  {
    "id": 1,
    "type": 1,
    "definableFieldID": 1,
    "definableFieldItemID": 1,
    "val": "sample string 1",
    "valNumber": 1.0,
    "valDate": "2025-01-09T20:41"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfObjectDefinableFieldsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ObjectDefinableFieldsUpdate>
    <ID>1</ID>
    <Type>1</Type>
    <DefinableFieldID>1</DefinableFieldID>
    <DefinableFieldItemID>1</DefinableFieldItemID>
    <Val>sample string 1</Val>
    <ValNumber>1</ValNumber>
    <ValDate>2025-01-09T20:41:58.418073+00:00</ValDate>
  </ObjectDefinableFieldsUpdate>
  <ObjectDefinableFieldsUpdate>
    <ID>1</ID>
    <Type>1</Type>
    <DefinableFieldID>1</DefinableFieldID>
    <DefinableFieldItemID>1</DefinableFieldItemID>
    <Val>sample string 1</Val>
    <ValNumber>1</ValNumber>
    <ValDate>2025-01-09T20:41:58.418073+00:00</ValDate>
  </ObjectDefinableFieldsUpdate>
</ArrayOfObjectDefinableFieldsUpdate>