social
social delete-message
Delete a Pulse message
Usage
pega social delete-message <messageID> [flags]Source endpoint: DELETE /messages/{messageID} — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
messageID | Yes | Message 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 social delete-message MSG-1social get-feed
Get a Pulse feed list
Usage
pega social get-feed <feedID> [flags]Source endpoint: GET /feeds/{feedID} — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
feedID | Yes | Feed 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 |
--filter-for | option | Yes | contextID or userID (→ ?filterFor=) | |
--older-than | option | No | Only entries older than this datetime (→ ?olderThan=) | |
--page-size | option | No | Max entries (→ ?pageSize=) | |
--feed-class | option | No | Pulse feed rule class (→ ?feedClass=) | |
--filter-by | option | No | Feed source list, comma-separated (→ ?filterBy=) |
Examples
pega social get-feed MyFeed --filter-for MYORG-WORK\!M-1social get-message
Get a Pulse message by ID
Usage
pega social get-message <messageID> [flags]Source endpoint: GET /messages/{messageID} — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
messageID | Yes | Message 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 social get-message MSG-1social get-message-type
Get the create-form view metadata for a Pulse message type
Usage
pega social get-message-type <type> [flags]Source endpoint: GET /message-types/{type} — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
type | Yes | Class ID of Message-type |
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 social get-message-type Pulse-Postsocial like-message
Add a like to a Pulse message
Usage
pega social like-message <messageID> [flags]Source endpoint: POST /messages/{messageID}/likes — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
messageID | Yes | Message 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 social like-message MSG-1social list-likes
List likes on a Pulse message
Usage
pega social list-likes <messageID> [flags]Source endpoint: GET /messages/{messageID}/likes — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
messageID | Yes | Message 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 social list-likes MSG-1social list-mention-types
List Pulse mention types
Usage
pega social list-mention-types [flags]Source endpoint: GET /mention_types — 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 social list-mention-typessocial list-mentions
List mentions for a search string and type
Usage
pega social list-mentions [flags]Source endpoint: GET /mentions — 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 |
--mentions-type | option | Yes | → ?mentionsType= | |
--context | option | No | Pulse gadget context (→ ?context=) | |
--search-for | option | No | → ?searchFor= | |
--list-size | option | No | → ?listSize= |
Examples
pega social list-mentions --mentions-type Operators --search-for jdoesocial list-messages
List Pulse messages for a context
Usage
pega social list-messages [flags]Source endpoint: GET /messages — 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 |
--filter-by | option | Yes | → ?filterBy= | |
--filter-for | option | Yes | → ?filterFor= | |
--page-size | option | No | → ?pageSize= | |
--older-than | option | No | → ?olderThan= |
Examples
pega social list-messages --filter-by Pulse --filter-for MYORG-WORK\!M-1social list-suggested-tags
List suggested + recent tags for a Pulse context
Usage
pega social list-suggested-tags [flags]Source endpoint: GET /suggested_tags — 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 |
--context | option | No | → ?context= |
Examples
pega social list-suggested-tags --context MYORG-WORK\!M-1social post-message
Post a new Pulse message
Usage
pega social post-message [flags]Source endpoint: POST /messages — 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 |
--context | option | Yes | Pulse context ID | |
--message | option | Yes | Message text | |
--route-to-workbasket | option | No | pyRouteToWorkbasket value | |
--message-type | option | No | → ?message-type= (query string, not body) |
Examples
pega social post-message --context MYORG-WORK\!M-1 --message "hello"social search-tags
Search tags by string
Usage
pega social search-tags [flags]Source endpoint: GET /tags — 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 |
--search-for | option | No | → ?searchFor= | |
--list-size | option | No | → ?listSize= |
Examples
pega social search-tags --search-for security --list-size 20social unlike-message
Remove a like from a Pulse message
Usage
pega social unlike-message <messageID> [flags]Source endpoint: DELETE /messages/{messageID}/likes — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
messageID | Yes | Message 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 social unlike-message MSG-1social update-message
Edit a Pulse message
Usage
pega social update-message <messageID> [flags]Source endpoint: PUT /messages/{messageID} — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
messageID | Yes | Message 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 |
--message | option | Yes | New message text | |
--route-to-workbasket | option | No | pyRouteToWorkbasket |
Examples
pega social update-message MSG-1 --message "edited"