assignments

assignments get

Get a Pega assignment by ID

Usage

pega assignments get <assignmentId> [flags]

Source endpoint: GET /assignments/{assignmentID} — view command source

Arguments

Argument	Required	Description
assignmentId	Yes	Full assignment 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 assignments get ASSIGN-WORKLIST X-1!FLOW

assignments get-action

Get the action/view details for a specific action on an assignment

Usage

pega assignments get-action <assignmentId> [flags]

Source endpoint: GET /assignments/{assignmentID}/actions/{actionID} — view command source

Arguments

Argument	Required	Description
assignmentId	Yes	Full assignment 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
--action	option	Yes		Flow action ID

Examples

pega assignments get-action ASSIGN-1 --action Submit

assignments get-next

Get the next assignment from the worklist

Usage

pega assignments get-next [flags]

Source endpoint: GET /assignments/next — 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

Examples

pega assignments get-next

assignments navigate-back

Navigate back to the previous step in a multi-step assignment

Usage

pega assignments navigate-back <assignmentId> [flags]

Source endpoint: PATCH /assignments/{assignmentID}/navigation_steps/previous — view command source

Arguments

Argument	Required	Description
assignmentId	Yes	Assignment 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
--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 assignments navigate-back ASSIGN-1

pega assignments navigate-back ASSIGN-1 --data '{"x":1}'

assignments navigate-to-step

Navigate to a specific step in a multi-step assignment

Usage

pega assignments navigate-to-step <assignmentId> [flags]

Source endpoint: PATCH /assignments/{assignmentID}/navigation_steps/{stepID} — view command source

Arguments

Argument	Required	Description
assignmentId	Yes	Assignment 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
--step	option	Yes		Step ID
--data	option	No		JSON content (inline, @file, or -)
--page-instructions	option	No		JSON page-instructions array
--attachments	option	No		JSON attachments array

Examples

pega assignments navigate-to-step ASSIGN-1 --step Step3

assignments perform

Perform an assignment action (auto-fetches eTag)

Usage

pega assignments perform <assignmentId> [flags]

Source endpoint: PATCH /assignments/{assignmentID}/actions/{actionID} — view command source

Arguments

Argument	Required	Description
assignmentId	Yes	Assignment 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	No		Action ID (required unless --interactive)
--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 -)
--interactive	boolean	No		Walk through action + required fields via prompts (TTY only)

Examples

pega assignments perform ASSIGN-1 --action Submit --data @form.json

pega assignments perform ASSIGN-1 --interactive

assignments recalculate

Recalculate calculated fields and when conditions for an assignment action

Usage

pega assignments recalculate <assignmentId> [flags]

Source endpoint: PATCH /assignments/{assignmentID}/actions/{actionID}/recalculate — view command source

Arguments

Argument	Required	Description
assignmentId	Yes	Assignment 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		Action ID
--data	option	Yes		JSON: {calculations:{fields:[{name:".X",context:"content"}]}} (inline, @file, or -)

Examples

pega assignments recalculate ASSIGN-1 --action Submit --data '{"calculations":{"fields":[{"name":".Total","context":"content"}]}}'

assignments refresh-action

Refresh a field after a value change

Usage

pega assignments refresh-action <assignmentId> [flags]

Source endpoint: PATCH /assignments/{assignmentID}/actions/{actionID}/refresh — view command source

Arguments

Argument	Required	Description
assignmentId	Yes	Assignment 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		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 (e.g. .OrderItems(1)). Infinity '25+
--interest-page-action-id	option	No		Action ID of the inner ('interest page') action. Infinity '25+
--attachments	option	No		NOT ACCEPTED for refresh (use perform-action or save instead). Errors with INVALID_ARGS.

Examples

pega assignments refresh-action ASSIGN-1 --action Submit --data '{"field":"new"}'

pega assignments refresh-action ASSIGN-1 --action Submit --interest-page .OrderItems(1) --interest-page-action-id EmbeddedAction

assignments save

Save a draft of an in-progress assignment

Usage

pega assignments save <assignmentId> [flags]

Source endpoint: PATCH /assignments/{assignmentID}/actions/{actionID}/save — view command source

Arguments

Argument	Required	Description
assignmentId	Yes	Assignment 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		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 assignments save ASSIGN-1 --action Submit --data @draft.json