cases

cases bulk-actions

List bulk actions available across a set of cases

Usage

pega cases bulk-actions [flags]

Source endpoint: POST /cases/bulk-actions — view command source

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--cases	option	Yes		Comma-separated case IDs

Examples

pega cases bulk-actions --cases CASE-1,CASE-2,CASE-3

cases bulk-perform

Perform an action across multiple cases in a single API call

Usage

pega cases bulk-perform [flags]

Source endpoint: PATCH /cases — view command source

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--action	option	Yes		Case action ID
--cases	option	Yes		Comma-separated case IDs
--data	option	No		JSON content (inline, @file, or -)
--page-instructions	option	No		JSON page-instructions array (inline, @file, or -)
--attachments	option	No		JSON attachments array (inline, @file, or -)
--running-mode	option	No		Launchpad-only: async (returns 202 with jobID)

Examples

pega cases bulk-perform --action Approve --cases CASE-1,CASE-2,CASE-3

pega cases bulk-perform --action Approve --cases CASE-1,CASE-2 --data '{"reason":"OK"}'

cases calc-fields

Compute calculated fields for a case view

Usage

pega cases calc-fields <caseId> [flags]

Source endpoint: POST /cases/{caseID}/views/{viewID}/calculated_fields — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--view	option	Yes		View name
--data	option	Yes		JSON: {calculations:{fields:[{name:".X",context:"content"}]}} (inline, @file, or -)

Examples

pega cases calc-fields MYAPP-CASE-1 --view Summary --data @fields.json

cases create

Create a new Pega case (V2)

Usage

pega cases create [flags]

Source endpoint: POST /cases — view command source

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--type	option	Yes		Case type ID
--data	option	No		JSON content (inline, @file, or - for stdin)

Examples

pega cases create --type InsuranceClaim

pega cases create --type InsuranceClaim --data @claim.json

cases delete

Delete a Pega case (V2)

Usage

pega cases delete <caseId> [flags]

Source endpoint: DELETE /cases/{caseID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Full case handle

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega cases delete MYAPP-CASE-1

cases discard-updates

Release the case lock (discard pending updates)

Usage

pega cases discard-updates <caseId> [flags]

Source endpoint: DELETE /cases/{caseID}/updates — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega cases discard-updates MYAPP-CASE-1

cases get

Get a Pega case by ID

Usage

pega cases get <caseId> [flags]

Source endpoint: GET /cases/{caseID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Full case handle

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega cases get MYAPP-CASE-1 --fields status,urgency

cases get-action

Get the view/form for a specific action on a case

Usage

pega cases get-action <caseId> [flags]

Source endpoint: GET /cases/{caseID}/actions/{actionID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--action	option	Yes		Case action ID

Examples

pega cases get-action MYAPP-CASE-1 --action Approve

cases get-view

Get a named view for a case

Usage

pega cases get-view <caseId> [flags]

Source endpoint: GET /cases/{caseID}/views/{viewID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--view	option	Yes		View name

Examples

pega cases get-view MYAPP-CASE-1 --view Summary

cases list-ancestors

List all ancestor cases in the case hierarchy

Usage

pega cases list-ancestors <caseId> [flags]

Source endpoint: GET /cases/{caseID}/ancestors — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega cases list-ancestors MYAPP-CASE-1

cases list-attachment-categories

List configured attachment categories on a case

Usage

pega cases list-attachment-categories <caseId> [flags]

Source endpoint: GET /cases/{caseID}/attachment_categories — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega cases list-attachment-categories MYAPP-CASE-1

cases list-descendants

List all descendant cases in the case hierarchy

Usage

pega cases list-descendants <caseId> [flags]

Source endpoint: GET /cases/{caseID}/descendants — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega cases list-descendants MYAPP-CASE-1

cases list-stages

List stages for a case

Usage

pega cases list-stages <caseId> [flags]

Source endpoint: GET /cases/{caseID}/stages — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega cases list-stages MYAPP-CASE-1

cases perform-action

Perform a case-level action

Usage

pega cases perform-action <caseId> [flags]

Source endpoint: PATCH /cases/{caseID}/actions/{actionID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--action	option	Yes		Case action ID
--data	option	No		JSON content (inline, @file, or -)
--page-instructions	option	No		JSON page-instructions array (inline, @file, or -)
--attachments	option	No		JSON attachments array (inline, @file, or -)

Examples

pega cases perform-action MYAPP-CASE-1 --action Approve

pega cases perform-action MYAPP-CASE-1 --action Approve --data '{"reason":"OK"}'

pega cases perform-action MYAPP-CASE-1 --action Approve --data @form.json --page-instructions @pi.json

cases recalculate

Recalculate calculated fields and when conditions for a case action

Usage

pega cases recalculate <caseId> [flags]

Source endpoint: PATCH /cases/{caseID}/actions/{actionID}/recalculate — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--action	option	Yes		Case action ID
--data	option	Yes		JSON: {calculations:{fields:[{name:".X",context:"content"}]}} (inline, @file, or -)

Examples

pega cases recalculate MYAPP-CASE-1 --action Approve --data '{"calculations":{"fields":[{"name":".Total","context":"content"}]}}'

cases refresh-action

Refresh a case action view (re-render form)

Usage

pega cases refresh-action <caseId> [flags]

Source endpoint: PATCH /cases/{caseID}/actions/{actionID}/refresh — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--action	option	Yes		Case action ID
--data	option	No		JSON content (inline, @file, or -)
--page-instructions	option	No		JSON page-instructions array (inline, @file, or -)
--interest-page	option	No		Embedded list row reference. Infinity '25+
--interest-page-action-id	option	No		Action ID of the inner action. Infinity '25+
--attachments	option	No		NOT ACCEPTED for refresh — INVALID_ARGS if passed

Examples

pega cases refresh-action MYAPP-CASE-1 --action Approve

cases refresh-view

Refresh a named case view

Usage

pega cases refresh-view <caseId> [flags]

Source endpoint: PATCH /cases/{caseID}/views/{viewID}/refresh — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--view	option	Yes		View name
--data	option	No		JSON content (inline, @file, or -)
--page-instructions	option	No		JSON page-instructions array
--interest-page	option	No		Embedded page reference (e.g. .PageList(1))
--interest-page-action-id	option	No		Action ID of the inner action
--attachments	option	No		NOT ACCEPTED — refresh-shape rejects attachments

Examples

pega cases refresh-view MYAPP-CASE-1 --view Summary

cases stage-go

Move the case to a specific named stage

Usage

pega cases stage-go <caseId> [flags]

Source endpoint: PUT /cases/{caseID}/stages/{stageID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--stage	option	Yes		Stage name

Examples

pega cases stage-go MYAPP-CASE-1 --stage Resolution

cases stage-next

Advance the case to the next stage

Usage

pega cases stage-next <caseId> [flags]

Source endpoint: POST /cases/{caseID}/stages/next — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega cases stage-next MYAPP-CASE-1

cases start-process

Start an optional or stage process on a case

Usage

pega cases start-process <caseId> [flags]

Source endpoint: POST /cases/{caseID}/processes/{processID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--process	option	Yes		Process ID

Examples

pega cases start-process MYAPP-CASE-1 --process pyAddNote