get_case
Retrieve detailed Pega case information by case ID, including optional view metadata for specific pages, to streamline case management and data access.
Instructions
Get detailed information about a Pega case by case ID
Input Schema
Name | Required | Description | Default |
---|---|---|---|
caseID | Yes | Full case handle (e.g.,ON6E5R-DIYRECIPE-WORK-RECIPECOLLECTION R-1008) | |
originChannel | No | Origin of this service. E.g. - Web, Mobile etc. | |
pageName | No | If provided, view metadata for specific page name will be returned (only used when viewType is "page") | |
viewType | No | Type of view data to return. "none" returns no UI resources, "page" returns full page UI metadata | none |
Input Schema (JSON Schema)
{
"properties": {
"caseID": {
"description": "Full case handle (e.g.,ON6E5R-DIYRECIPE-WORK-RECIPECOLLECTION R-1008)",
"type": "string"
},
"originChannel": {
"description": "Origin of this service. E.g. - Web, Mobile etc.",
"type": "string"
},
"pageName": {
"description": "If provided, view metadata for specific page name will be returned (only used when viewType is \"page\")",
"type": "string"
},
"viewType": {
"default": "none",
"description": "Type of view data to return. \"none\" returns no UI resources, \"page\" returns full page UI metadata",
"enum": [
"none",
"page"
],
"type": "string"
}
},
"required": [
"caseID"
],
"type": "object"
}