Skip to content

ui-lists

ui-lists create-personalization

Create a personalization on a UI list

Usage

bash
pega ui-lists create-personalization <uiListID> [flags]

Source endpoint: POST /ui_lists/{ui_list_ID}/personalizationsview command source

Arguments

ArgumentRequiredDescription
uiListIDYesUI list ID

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile
--nameoptionYesPersonalization name
--idoptionNoID
--personalization-stateoptionNopersonalizationState (verbatim string)
--mark-as-defaultbooleanNomarkAsDefault
--mark-as-app-defaultbooleanNomarkAsAppDefault
--route-to-workbasketoptionNopyRouteToWorkbasket

Examples

sh
pega ui-lists create-personalization LIST-1 --name "My View"

ui-lists delete-personalization

Delete a personalization on a UI list

Usage

bash
pega ui-lists delete-personalization <uiListID> <personalizationID> [flags]

Source endpoint: DELETE /ui_lists/{ui_list_ID}/personalizations/{personalizationID}view command source

Arguments

ArgumentRequiredDescription
uiListIDYesUI list ID
personalizationIDYesPersonalization ID

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile

Examples

sh
pega ui-lists delete-personalization LIST-1 PERS-1

ui-lists list-personalizations

List personalizations for a UI list

Usage

bash
pega ui-lists list-personalizations <uiListID> [flags]

Source endpoint: GET /ui_lists/{ui_list_ID}/personalizationsview command source

Arguments

ArgumentRequiredDescription
uiListIDYesUI list ID

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile

Examples

sh
pega ui-lists list-personalizations LIST-1

ui-lists move

Move a record within a UI list

Usage

bash
pega ui-lists move <viewName> [flags]

Source endpoint: PATCH /ui_lists/{viewName}/moveview command source

Arguments

ArgumentRequiredDescription
viewNameYesUI list view name

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile
--source-idoptionYessourceID
--destination-idoptionYesdestinationID
--contextoptionNocontext (optional)
--list-classoptionNolistClass (optional)

Examples

sh
pega ui-lists move MyListView --source-id R-1 --destination-id R-2

ui-lists update-personalization

Update a personalization on a UI list

Usage

bash
pega ui-lists update-personalization <uiListID> <personalizationID> [flags]

Source endpoint: PUT /ui_lists/{ui_list_ID}/personalizations/{personalizationID}view command source

Arguments

ArgumentRequiredDescription
uiListIDYesUI list ID
personalizationIDYesPersonalization ID

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile
--nameoptionYesPersonalization name
--idoptionNoID
--personalization-stateoptionNopersonalizationState (verbatim string)
--mark-as-defaultbooleanNomarkAsDefault
--mark-as-app-defaultbooleanNomarkAsAppDefault
--route-to-workbasketoptionNopyRouteToWorkbasket

Examples

sh
pega ui-lists update-personalization LIST-1 PERS-1 --name "Edited"