Retrieve formula column details by column ID

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 the full details of an existing formula column by its ID. Returns the column name, default value, and all condition definitions including their criteria and criteria patterns.

Request URL

https://{server-hostname}:8383/dcapi/reports/customReports/formulaColumn/{columnID}

Scope

CustomReport.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

columnIDstringMandatory

The columnID retrieved for saved formula column

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/reports/customReports/formulaColumn/{columnID} \
  --header 'Accept: application/formulaColumnDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
columnNamestring

Display name of the formula column

defaultValuestring

Default value returned when no condition matches (the ELSE branch)

columnDetailsJSON array

Array of condition objects. Each defines a CASE-WHEN branch with criteria and result value

Show Sub-Attributes
JSON object
Show Sub-Attributes
valuestring

Result value when this condition's criteria matches

criteriaJSON array

Array of criteria filter objects for this condition

Show Sub-Attributes
JSON object
Show Sub-Attributes
columnIDlong

Column ID the criteria is evaluated against. Fetch from Get Available Columns

comparatorstring

Comparison operator used (e.g., contains, equal, greater than)

searchValuearray

Array of string values to compare against

logicalOperatorstring

Logical operator (AND or OR) for combining with previous criteria

criteriaPatternstring

Logical expression combining criteria (e.g., 1, 1 AND 2, (1 OR 2) AND 3)

- HTTP code 401

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodestring

Unauthorized error code: 401. User does not own this formula column

errorMessagestring

Message indicating user is not authorized to access this formula column

- HTTP code 403

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 417

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodestring

Expectation failed error code: Custom Report V2 is not enabled

errorMessagestring

Message indicating Custom Report V2 feature is not active

- HTTP code 429

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodestring

Internal error code: unexpected failure during formula column retrieval

errorMessagestring

Detailed error description for the internal server error

Possible Response Codes

200HTTP code
401HTTP code
403HTTP code
417HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Formula column with multiple CASE-WHEN conditions

Copied!
  {
    "defaultValue": "Other",
    "columnDetails": [
      {
        "criteria": [
          {
            "comparator": "contains",
            "logicalOperator": "AND",
            "columnID": 103,
            "searchValue": [
              "Windows"
            ]
          }
        ],
        "value": "Windows",
        "criteriaPattern": "1"
      },
      {
        "criteria": [
          {
            "comparator": "contains",
            "logicalOperator": "AND",
            "columnID": 103,
            "searchValue": [
              "Linux"
            ]
          },
          {
            "comparator": "contains",
            "logicalOperator": "OR",
            "columnID": 103,
            "searchValue": [
              "Ubuntu"
            ]
          }
        ],
        "value": "Linux",
        "criteriaPattern": "1 OR 2"
      }
    ],
    "columnName": "OSCategory"
  }
                
Show full

Formula column with a single condition

Copied!
  {
    "defaultValue": "Low",
    "columnDetails": [
      {
        "criteria": [
          {
            "comparator": "greater than",
            "logicalOperator": "AND",
            "columnID": 205,
            "searchValue": [
              "90"
            ]
          }
        ],
        "value": "High",
        "criteriaPattern": "1"
      }
    ],
    "columnName": "PriorityLevel"
  }
                
Show full

Sample Response: HTTP 401

User does not own this formula column

Copied!
  {
    "errorMessage": "You are not authorized to access this formula column",
    "errorCode": "401"
  }
                
Show full

Sample Response: HTTP 403

User does not have the required role

Copied!
  {
    "errorMessage": "User does not have the required role to access this resource",
    "errorCode": "403"
  }
                
Show full

Sample Response: HTTP 417

Custom Report V2 is not enabled

Copied!
  {
    "errorMessage": "Custom Report V2 is not enabled",
    "errorCode": "417"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorMessage": "Rate limit exceeded. Please retry after some time",
    "errorCode": "429"
  }
                
Show full

Sample Response: HTTP 500

Unexpected failure during formula column retrieval

Copied!
  {
    "errorMessage": "Internal server error while retrieving formula column details",
    "errorCode": "500"
  }
                
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.