data

data count

Get count of records in a data view by POSTing to /data_views/{dataViewId}/count

Usage

pega data count <dataViewId> [flags]

Source endpoint: POST /data_views/{data_view_ID}/count — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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
--params	option	No		JSON object of data view parameters → dataViewParameters
-d, --data	option	No		Full request body as JSON (mutually exclusive with --params)

Examples

pega data count D_MyDataView

pega data count D_MyDataView --params '{"employeeID":"E1"}'

pega data count D_MyDataView --data '{"dataViewParameters":{"employeeID":"E1"}}'

data create

Create a new data record

Usage

pega data create <dataViewId> [flags]

Source endpoint: POST /data/{data_view_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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	Yes		JSON body (inline, @file, or -)

Examples

pega data create D_MyDataView --data '{"field":"value"}'

data delete

Delete a data record

Usage

pega data delete <dataViewId> [flags]

Source endpoint: DELETE /data/{data_view_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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
--params	option	No		JSON object of query parameters identifying the record to delete

Examples

pega data delete D_MyDataView --params '{"id":101}'

data get

Get a data view by ID

Usage

pega data get <dataViewId> [flags]

Source endpoint: GET /data_views/{data_view_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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 data get D_MyDataView

data get-action

Get a specific action for a data record

Usage

pega data get-action <dataViewId> [flags]

Source endpoint: POST /data/{data_view_ID}/actions/{action_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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 -)

Examples

pega data get-action D_MyDataView --action myAction

pega data get-action D_MyDataView --action myAction --data '{"field":"value"}'

data get-metadata

Get metadata for a data view by ID

Usage

pega data get-metadata <dataViewId> [flags]

Source endpoint: GET /data_views/{data_view_ID}/metadata — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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 data get-metadata D_MyDataView

data list-actions

List available actions for a data record

Usage

pega data list-actions <dataViewId> [flags]

Source endpoint: POST /data/{data_view_ID}/actions — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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 data list-actions D_MyDataView

data list-objects

List all data objects available in the application

Usage

pega data list-objects [flags]

Source endpoint: GET /data_objects — 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 data list-objects

data list-pages

List data pages available in the application

Usage

pega data list-pages [flags]

Source endpoint: GET /data_pages — 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	No	all	Data page request type

Examples

pega data list-pages

pega data list-pages --type explorable

data patch

Patch a data record (PATCH with eTag)

Usage

pega data patch <dataViewId> [flags]

Source endpoint: PATCH /data/{data_view_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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	Yes		JSON body (inline, @file, or -)

Examples

pega data patch D_MyDataView --data '{"field":"value"}'

data perform-action

Perform an action on a data record

Usage

pega data perform-action <dataViewId> [flags]

Source endpoint: PATCH /data/{data_view_ID}/actions/{action_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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 data perform-action D_MyDataView --action myAction

pega data perform-action D_MyDataView --action myAction --data '{"field":"value"}'

pega data perform-action D_MyDataView --action myAction --data @form.json --page-instructions @pi.json

data query

Query a data view by POSTing to /data_views/

Usage

pega data query <dataViewId> [flags]

Source endpoint: POST /data_views/{data_view_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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
--params	option	No		JSON object of data view parameters → dataViewParameters
--max	option	No		Maximum results to fetch → paging.maxResultsToFetch
--page	option	No		Page number → paging.pageNumber
--include-total	boolean	No		Include total count in response → paging.includeTotalCount
-d, --data	option	No		Full request body as JSON (mutually exclusive with --params/--max/--page/--include-total)

Examples

pega data query D_MyDataView --max 10 --include-total

pega data query D_MyDataView --params '{"employeeID":"E1"}'

pega data query D_MyDataView --data '{"query":{"select":["X"]}}'

data query-metadata

Get metadata for a data view by POSTing to /data_views/{dataViewId}/metadata

Usage

pega data query-metadata <dataViewId> [flags]

Source endpoint: POST /data_views/{data_view_ID}/metadata — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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
--params	option	No		JSON object of data view parameters → dataViewParameters
-d, --data	option	No		Full request body as JSON (mutually exclusive with --params)

Examples

pega data query-metadata D_MyDataView

pega data query-metadata D_MyDataView --params '{"employeeID":"E1"}'

pega data query-metadata D_MyDataView --data '{"dataViewParameters":{"employeeID":"E1"}}'

data query-view

Query a specific view of a data view by POSTing to /data_views/{dataViewId}/views/

Usage

pega data query-view <dataViewId> [flags]

Source endpoint: POST /data_views/{data_view_ID}/views/{view_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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 ID within the data view
--params	option	No		JSON object of data view parameters → dataViewParameters
--max	option	No		Maximum results to fetch → paging.maxResultsToFetch
--page	option	No		Page number → paging.pageNumber
--include-total	boolean	No		Include total count in response → paging.includeTotalCount
-d, --data	option	No		Full request body as JSON (mutually exclusive with --params/--max/--page/--include-total)

Examples

pega data query-view D_MyDataView --view myView

pega data query-view D_MyDataView --view myView --max 10 --include-total

pega data query-view D_MyDataView --view myView --params '{"employeeID":"E1"}'

data update

Update a data record (PUT with eTag)

Usage

pega data update <dataViewId> [flags]

Source endpoint: PUT /data/{data_view_ID} — view command source

Arguments

Argument	Required	Description
dataViewId	Yes	Data view 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	Yes		JSON body (inline, @file, or -)

Examples

pega data update D_MyDataView --data '{"field":"value"}'