Help Contents

 

Custom Field Types

Resource: Custom Field Types ( /api/customfieldtypes )

Custom field types (collection) resource

Root Relation: CustomFieldTypes

This resource supports the following methods: GET

Methods

GET


Retrieves the list of custom field types.

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
404 - NotFoundReturned if the custom field type does not exist.

Example - Get all custom field types

Example of fetching all custom field types.

Request Headers

KeyValueDescription
Acceptapplication/json

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Items": [
    {
      "Name": "Text",
      "DisplayName": "Text",
      "Self": "http://localhost/api/customfieldtype/text"
    },
    {
      "Name": "ComboBox",
      "DisplayName": "Combo Box",
      "Self": "http://localhost/api/customfieldtype/combobox"
    },
    {
      "Name": "Checkbox",
      "DisplayName": "Checkbox",
      "Self": "http://localhost/api/customfieldtype/checkbox"
    }
  ]
}

Status Code

200 - OK

Example - Get custom field types using OData filter

Example of fetching subset of custom field types using OData filter.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
$filterName eq 'Text'Fetch custom field type with name 'Text'

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Items": [
    {
      "Name": "Text",
      "DisplayName": "Text",
      "Self": "http://localhost/api/customfieldtype/text"
    }
  ]
}

Status Code

200 - OK