GET api/userdefinedfieldlist

Get all user defined field list.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/userdefinedfieldlist. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of user defied list and its all values.

Collection of UserDefinedFieldListDto

Name	Description	Type
UserDefinedFieldListID	Unique identifier of a userdefined field list.	integer
Name	Name of a userdefined field list.	string
Description	Description of a userdefined field list.	string
Default	Indicates true if a user defined field list is set as default item.	boolean
Active	Indicates true if user defined field list is active.	boolean
ListValues	Collection of List values for a user defined field list.	Collection of UserDefinedFieldListValueDto

Response Formats

application/json, text/json

Sample:

[
  {
    "userDefinedFieldListID": 1,
    "name": "sample string 1",
    "description": "sample string 2",
    "default": true,
    "active": true,
    "listValues": [
      {
        "userDefinedFieldListValueID": 1,
        "userDefinedFieldListID": 1,
        "name": "sample string 1",
        "description": "sample string 2",
        "default": true,
        "score": 1.0,
        "active": true
      },
      {
        "userDefinedFieldListValueID": 1,
        "userDefinedFieldListID": 1,
        "name": "sample string 1",
        "description": "sample string 2",
        "default": true,
        "score": 1.0,
        "active": true
      }
    ]
  },
  {
    "userDefinedFieldListID": 1,
    "name": "sample string 1",
    "description": "sample string 2",
    "default": true,
    "active": true,
    "listValues": [
      {
        "userDefinedFieldListValueID": 1,
        "userDefinedFieldListID": 1,
        "name": "sample string 1",
        "description": "sample string 2",
        "default": true,
        "score": 1.0,
        "active": true
      },
      {
        "userDefinedFieldListValueID": 1,
        "userDefinedFieldListID": 1,
        "name": "sample string 1",
        "description": "sample string 2",
        "default": true,
        "score": 1.0,
        "active": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserDefinedFieldListDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.UserDefinedFields">
  <UserDefinedFieldListDto>
    <Active>true</Active>
    <Default>true</Default>
    <Description>sample string 2</Description>
    <ListValues>
      <UserDefinedFieldListValueDto>
        <Active>true</Active>
        <Default>true</Default>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Score>1</Score>
        <UserDefinedFieldListID>1</UserDefinedFieldListID>
        <UserDefinedFieldListValueID>1</UserDefinedFieldListValueID>
      </UserDefinedFieldListValueDto>
      <UserDefinedFieldListValueDto>
        <Active>true</Active>
        <Default>true</Default>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Score>1</Score>
        <UserDefinedFieldListID>1</UserDefinedFieldListID>
        <UserDefinedFieldListValueID>1</UserDefinedFieldListValueID>
      </UserDefinedFieldListValueDto>
    </ListValues>
    <Name>sample string 1</Name>
    <UserDefinedFieldListID>1</UserDefinedFieldListID>
  </UserDefinedFieldListDto>
  <UserDefinedFieldListDto>
    <Active>true</Active>
    <Default>true</Default>
    <Description>sample string 2</Description>
    <ListValues>
      <UserDefinedFieldListValueDto>
        <Active>true</Active>
        <Default>true</Default>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Score>1</Score>
        <UserDefinedFieldListID>1</UserDefinedFieldListID>
        <UserDefinedFieldListValueID>1</UserDefinedFieldListValueID>
      </UserDefinedFieldListValueDto>
      <UserDefinedFieldListValueDto>
        <Active>true</Active>
        <Default>true</Default>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Score>1</Score>
        <UserDefinedFieldListID>1</UserDefinedFieldListID>
        <UserDefinedFieldListValueID>1</UserDefinedFieldListValueID>
      </UserDefinedFieldListValueDto>
    </ListValues>
    <Name>sample string 1</Name>
    <UserDefinedFieldListID>1</UserDefinedFieldListID>
  </UserDefinedFieldListDto>
</ArrayOfUserDefinedFieldListDto>