get_case_view_calculated_fields
Retrieve specific calculated fields from a case view in Pega applications. Specify case ID, view ID, and fields to evaluate, ensuring only valid view fields are returned for accurate data extraction and analysis.
Instructions
Get calculated fields for a given case view. Retrieves only the requested calculated fields from the case view. All requested calculated fields in the request body must be included in the view. Any requested fields that are not part of the view will be filtered out.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| calculations | Yes | Object containing the fields data to retrieve their respective calculated values. Must contain a "fields" array with field objects. | |
| caseID | Yes | Full case handle (case ID) to retrieve calculated fields from. Example: "MYORG-SERVICES-WORK S-293001". Must be a complete case identifier including spaces and special characters. | |
| viewID | Yes | Name of the view from which calculated fields are retrieved - ID of the view rule. This identifies the specific view containing the calculated fields to be evaluated. |
Input Schema (JSON Schema)
{
"properties": {
"calculations": {
"additionalProperties": false,
"description": "Object containing the fields data to retrieve their respective calculated values. Must contain a \"fields\" array with field objects.",
"properties": {
"fields": {
"description": "Array of field objects specifying which calculated fields to retrieve from the view.",
"items": {
"additionalProperties": false,
"properties": {
"context": {
"default": "content",
"description": "Context for the calculated field evaluation. Optional parameter that specifies the context in which the field should be evaluated. Default: \"content\".",
"type": "string"
},
"name": {
"description": "Name of the calculated field to retrieve. Can include property references starting with dot notation (e.g., \".LoanEligibilityCheckListCountAll\").",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"whens": {
"description": "Array of when condition objects for conditional field evaluation. Optional parameter for advanced field calculation scenarios.",
"items": {
"additionalProperties": false,
"properties": {
"context": {
"description": "Context for the when condition evaluation.",
"type": "string"
},
"name": {
"description": "Name of the when condition.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"fields"
],
"type": "object"
},
"caseID": {
"description": "Full case handle (case ID) to retrieve calculated fields from. Example: \"MYORG-SERVICES-WORK S-293001\". Must be a complete case identifier including spaces and special characters.",
"type": "string"
},
"viewID": {
"description": "Name of the view from which calculated fields are retrieved - ID of the view rule. This identifies the specific view containing the calculated fields to be evaluated.",
"type": "string"
}
},
"required": [
"caseID",
"viewID",
"calculations"
],
"type": "object"
}