create_case
Create a new Pega case to initiate case workflows, automatically generating an initial assignment and returning case and assignment IDs for progression.
Instructions
Create a new Pega case. This is the FIRST step in case workflows. Automatically creates the initial assignment (returned in nextAssignmentInfo). Many case types accept empty content {}. If fields required, automatic field discovery provides guidance. Returns: caseID, assignmentID (in nextAssignmentInfo.ID), eTag. Next steps: use get_assignment with assignmentID to view form fields.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseTypeID | Yes | Case type ID (Example: "Org-App-Work-CaseType"). Use get_case_types to discover available types. | |
| parentCaseID | No | Parent case ID for child case creation | |
| processID | No | Starting process ID to use for case creation (Example: "pyStartCase"). Optional parameter that specifies which flow to use when creating the case. Some case types may require this to bypass initial validation. | |
| content | No | Field values for case creation (optional). Empty {} often works. If fields required, automatic discovery provides guidance. For embedded pages use pageInstructions. | |
| pageInstructions | No | Optional list of page-related operations for embedded pages, page lists, or page groups. Required for setting embedded page references (Example: Collection, Datasource). See Pega DX API documentation on page instructions for embedded pages. | |
| attachments | No | A list of attachments to be added to specific attachment fields (optional) | |
| viewType | No | UI resources to return. "none" returns no UI resources, "form" returns form UI metadata, "page" returns full page UI metadata | none |
| pageName | No | If provided, view metadata for specific page name will be returned (only used when viewType is "page") | |
| sessionCredentials | No | Optional session-specific credentials. If not provided, uses environment variables. Supports two authentication modes: (1) OAuth mode - provide baseUrl, clientId, and clientSecret, or (2) Token mode - provide baseUrl and accessToken. |