Fetch a list of all custom data type names

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API allows clients to fetch the list of existing custom data types. This helps in managing and reusing data types when creating or updating custom fields.

Request URL

https://{server-hostname}:8383/dcapi/customColumn/customColumnPage

Scope

CustomField.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/customColumnDetails.v1+jsonapplication/customColumnDetails.v1+jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/customColumn/customColumnPage \
  --header 'Accept: application/customColumnDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
customDataTypeListarray

An array containing the list of available custom data types

containsCustomDataTypestring

A boolean value indicating whether any custom data types exist (true if present, false if not)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "customDataTypeList": [
      "CHAR"
    ],
    "containsCustomDataType": "false"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.