Fetch a list of custom fields values

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

Retrieves all custom field values for a specific resource

Request URL

https://{serverurl}/dcapi/customFields/computers/{ColumnID}

Scope

DesktopCentralCloud.CustomField.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

ColumnIDstringMandatory

Provide the resource ID obtained from this API

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/customFields/computers/{ColumnID} \
  --header 'Accept: application/customFields.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Array
Hide Sub-Attributes
JSON Object
Show Sub-Attributes
maxAllowedSizestring

Maximum size allowed for the field

columnNamestring

Actual column name of the custom field

isPIIColumnstring

Indicates whether the field contains Personally Identifiable Information (true/false)

defaultValuestring

Default value assigned to the field

extendedDataTypestring

Extended/custom data type associated with the field

addedBystring

User who created or added the field

dataTypestring

The data type of a custom field can be one of the following: 1.CHAR
2.INTEGER
3.BOOLEAN
4.FILE < br>A custom data type can also be specified as the field’s data type, which can be created using the API. /dcapi/customColumn/customDataType

displayNamestring

Display name of the custom field

valuestring

Current value of the field

descriptionstring

Description of the field

inputFormatstring

Expected format for input values

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  [
    {
      "isPIIColumn": false,
      "defaultValue": "1",
      "addedBy": "1",
      "displayName": "sample",
      "dataType": "int",
      "extendedDataType": "",
      "description": "",
      "maxAllowedSize": "4",
      "inputFormat": "<INTEGER>",
      "value": "3",
      "columnName": "COL301"
    }
  ]
                
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.