Chatter REST API Developer Guide
jNewer Version Available
Communities Moderation Resources
Available resources are:
| Resource | Description |
|---|---|
| /connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/moderation | Get information about a feed element's moderation capability, add a moderation flag to a feed element, or delete all moderation flags from a feed element. |
| /connect/communities/communityId/chatter/comments/commentId/moderation-flags | If the context user is a community moderator, get the number of times community members flagged a comment. Also
flag a comment for moderation and delete all flags on a comment. If the context user isn’t a community moderator, returns whether the user flagged a comment. Also flag a comment for moderation and remove a flag the user previously added. |
| /connect/communities/communityId/files/moderation | Files that
are flagged in a community. If the context user is a community moderator, get the files that community members flagged. |
| /connect/communities/communityId/files/fileId/moderation-flags | If the context user is a community moderator, get the number of times community members flagged a file. Also
flag a file for moderation and delete all flags on a file. If the context user isn’t a community moderator, get whether the user flagged a file. Also flag a file for moderation and remove a flag the user previously added. |
| /connect/communities/communityId/chatter/users/userId/audit-actions/counts | Get audit statistics for a user in a community. |
Moderation Flags on Posts
If the context user is a community moderator with the Moderate Communities Feeds permission, get the number of times community members flagged a post. Also flag a post for moderation and delete all flags on a post.
If the context user isn’t a community moderator, get whether the user flagged a post. Also flag a post for moderation and remove a flag the user previously added.
- Resource
-
1/connect/communities/communityId/chatter/feed-items/feedItemId/moderation-flags - Available versions
- 29.0–31.0
- Requires Chatter
- Yes
- HTTP methods
- GET, DELETE, HEAD, POST
- Request parameters for GET
-
Name Type Description Required or Optional Available Version visibility String Specifies the visibility behavior of a flag for various user types. - ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item.
- SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
Optional 30.0–31.0 - Request body for POST
-
- Root XML tag
- <moderationFlag>
- JSON
-
1{ 2 "note" : "Flagged by moderator as spam on 6.6.16.", 3 "type" : "FlagAsSpam", 4 "visibility" : "ModeratorsOnly" 5} - Properties
-
- Request parameters for POST
-
Name Type Description Required or Optional Available Version visibility String Specifies the visibility behavior of a flag for various user types. - ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item.
- SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
Optional 30.0–31.0 - Request parameters for DELETE
-
Name Type Description Required or Optional Available Version userId String The ID of the context user. If specified, removes the flag the user previously added to the post. If not specified and the context user is a moderator for the community, removes all flags on the post. Optional 29.0–31.0 - Response body for GET and POST
- Moderation Flags
Moderation Flags on Comments
If the context user is a community moderator, get the number of times community members flagged a comment. Also flag a comment for moderation and delete all flags on a comment.
If the context user isn’t a community moderator, returns whether the user flagged a comment. Also flag a comment for moderation and remove a flag the user previously added.
- Resource
-
1/connect/communities/communityId/chatter/comments/commentId/moderation-flags - Available since release
- 29.0
- Requires Chatter
- Yes
- HTTP methods
- GET, DELETE, HEAD, POST
- Request parameters for GET
-
- Request body for POST
-
- Root XML tag
- <moderationFlag>
- JSON
-
1{ 2 "note" : "Flagged by moderator as spam on 6.6.16.", 3 "type" : "FlagAsSpam", 4 "visibility" : "ModeratorsOnly" 5} - Properties
-
- Request parameters for POST
-
Name Type Description Required or Optional Available Version note String A note of up to 4,000 characters about the flag. Optional 38.0 type String Specifies the type of moderation flag. - FlagAsInappropriate—Flag for inappropriate content.
- FlagAsSpam—Flag for spam.
If a type isn’t specified, it defaults to FlagAsInappropriate.
Optional If not specified, FlagAsInappropriate is the default value.
38.0 visibility String Specifies the visibility behavior of a flag for various user types. - ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item.
- SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
Optional 30.0 - Request parameters for DELETE
-
Name Type Description Required or Optional Available Version userId String The ID of the context user. If specified, removes the flag the user previously added to the comment. If not specified and the context user is a moderator for the community, removes all flags on the comment. Optional 29.0 - Response body for GET and POST
- Moderation Flags
Moderation Flags on Files
If the context user is a community moderator, get the number of times community members flagged a file. Also flag a file for moderation and delete all flags on a file.
If the context user isn’t a community moderator, get whether the user flagged a file. Also flag a file for moderation and remove a flag the user previously added.
- Resource
-
1/connect/communities/communityId/files/fileId/moderation-flags - Available since release
- 36.0
- In versions 30.0–35.0, use /connect/communities/communityId/chatter/files/fileId/moderation-flags.
- Requires Chatter
- No
- HTTP methods
- GET, DELETE, HEAD, POST
- Request parameters for GET
-
Name Type Description Required or Optional Available Version page String Specifies the page token to be used to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned. Optional 40.0 pageSize Integer Specifies the number of items per page. Valid values are from 1 through 100. The default size is 0. Optional 40.0 visibility String Specifies the visibility behavior of a flag for various user types. - ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item.
- SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
Optional 30.0 - Request body for POST
-
- Root XML tag
- <moderationFlag>
- JSON
-
1{ 2 "note" : "Flagged by moderator as spam on 6.6.16.", 3 "type" : "FlagAsSpam", 4 "visibility" : "ModeratorsOnly" 5} - Properties
-
- Request parameters for POST
-
Name Type Description Required or Optional Available Version note String A note of up to 4,000 characters about the flag. Optional 38.0 type String Specifies the type of moderation flag. - FlagAsInappropriate—Flag for inappropriate content.
- FlagAsSpam—Flag for spam.
Optional If not specified, FlagAsInappropriate is the default value.
38.0 visibility String Specifies the visibility behavior of a flag for various user types. - ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item.
- SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
Optional 30.0 - Request parameters for DELETE
-
Name Type Description Required or Optional Available Version userId String The ID of the context user. If specified, removes the flag the user previously added to the file. If not specified and the context user is a moderator for the community, removes all flags on the file. Optional 30.0 - Response body for GET and POST
- Moderation Flags
Flagged Files
Files that are flagged in a community.
If the context user is a community moderator, get the files that community members flagged.
- Resource
-
1/connect/communities/communityId/files/moderation - Available since release
- 36.0
- In version 30.0–35.0, use /connect/communities/communityId/chatter/files/moderation.
- Requires Chatter
- No
- HTTP methods
- GET, HEAD
- Request parameters for GET
-
Name Type Description Required or Optional Available Version page Integer Specifies the number of the page you want returned. Optional 30.0 pageSize Integer Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. Optional 30.0 q String A query string to filter the results. The string must contain at least two characters, not including wildcards. For information about wildcards, see Wildcards. Optional 33.0 - Response body
- File Summary