Skip to content

social

social delete-message

Delete a Pulse message

Usage

bash
pega social delete-message <messageID> [flags]

Source endpoint: DELETE /messages/{messageID}view command source

Arguments

ArgumentRequiredDescription
messageIDYesMessage 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 social delete-message MSG-1

social get-feed

Get a Pulse feed list

Usage

bash
pega social get-feed <feedID> [flags]

Source endpoint: GET /feeds/{feedID}view command source

Arguments

ArgumentRequiredDescription
feedIDYesFeed 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
--filter-foroptionYescontextID or userID (→ ?filterFor=)
--older-thanoptionNoOnly entries older than this datetime (→ ?olderThan=)
--page-sizeoptionNoMax entries (→ ?pageSize=)
--feed-classoptionNoPulse feed rule class (→ ?feedClass=)
--filter-byoptionNoFeed source list, comma-separated (→ ?filterBy=)

Examples

sh
pega social get-feed MyFeed --filter-for MYORG-WORK\!M-1

social get-message

Get a Pulse message by ID

Usage

bash
pega social get-message <messageID> [flags]

Source endpoint: GET /messages/{messageID}view command source

Arguments

ArgumentRequiredDescription
messageIDYesMessage 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 social get-message MSG-1

social get-message-type

Get the create-form view metadata for a Pulse message type

Usage

bash
pega social get-message-type <type> [flags]

Source endpoint: GET /message-types/{type}view command source

Arguments

ArgumentRequiredDescription
typeYesClass ID of Message-type

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 social get-message-type Pulse-Post

social like-message

Add a like to a Pulse message

Usage

bash
pega social like-message <messageID> [flags]

Source endpoint: POST /messages/{messageID}/likesview command source

Arguments

ArgumentRequiredDescription
messageIDYesMessage 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 social like-message MSG-1

social list-likes

List likes on a Pulse message

Usage

bash
pega social list-likes <messageID> [flags]

Source endpoint: GET /messages/{messageID}/likesview command source

Arguments

ArgumentRequiredDescription
messageIDYesMessage 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 social list-likes MSG-1

social list-mention-types

List Pulse mention types

Usage

bash
pega social list-mention-types [flags]

Source endpoint: GET /mention_typesview command source

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 social list-mention-types

social list-mentions

List mentions for a search string and type

Usage

bash
pega social list-mentions [flags]

Source endpoint: GET /mentionsview command source

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
--mentions-typeoptionYes→ ?mentionsType=
--contextoptionNoPulse gadget context (→ ?context=)
--search-foroptionNo→ ?searchFor=
--list-sizeoptionNo→ ?listSize=

Examples

sh
pega social list-mentions --mentions-type Operators --search-for jdoe

social list-messages

List Pulse messages for a context

Usage

bash
pega social list-messages [flags]

Source endpoint: GET /messagesview command source

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
--filter-byoptionYes→ ?filterBy=
--filter-foroptionYes→ ?filterFor=
--page-sizeoptionNo→ ?pageSize=
--older-thanoptionNo→ ?olderThan=

Examples

sh
pega social list-messages --filter-by Pulse --filter-for MYORG-WORK\!M-1

social list-suggested-tags

List suggested + recent tags for a Pulse context

Usage

bash
pega social list-suggested-tags [flags]

Source endpoint: GET /suggested_tagsview command source

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
--contextoptionNo→ ?context=

Examples

sh
pega social list-suggested-tags --context MYORG-WORK\!M-1

social post-message

Post a new Pulse message

Usage

bash
pega social post-message [flags]

Source endpoint: POST /messagesview command source

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
--contextoptionYesPulse context ID
--messageoptionYesMessage text
--route-to-workbasketoptionNopyRouteToWorkbasket value
--message-typeoptionNo→ ?message-type= (query string, not body)

Examples

sh
pega social post-message --context MYORG-WORK\!M-1 --message "hello"

social search-tags

Search tags by string

Usage

bash
pega social search-tags [flags]

Source endpoint: GET /tagsview command source

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
--search-foroptionNo→ ?searchFor=
--list-sizeoptionNo→ ?listSize=

Examples

sh
pega social search-tags --search-for security --list-size 20

social unlike-message

Remove a like from a Pulse message

Usage

bash
pega social unlike-message <messageID> [flags]

Source endpoint: DELETE /messages/{messageID}/likesview command source

Arguments

ArgumentRequiredDescription
messageIDYesMessage 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 social unlike-message MSG-1

social update-message

Edit a Pulse message

Usage

bash
pega social update-message <messageID> [flags]

Source endpoint: PUT /messages/{messageID}view command source

Arguments

ArgumentRequiredDescription
messageIDYesMessage 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
--messageoptionYesNew message text
--route-to-workbasketoptionNopyRouteToWorkbasket

Examples

sh
pega social update-message MSG-1 --message "edited"