Moderation

A Moderation item contains information related to moderating content, person registration, or profile images. An administrator can control which items must be moderated from the Admin Console. For an item that is under moderation, it will not be publicly visible until a moderator approves this item, either from the UI or with this API. Content that has been flagged for abuse must also be moderated. Refer to Abuse Report Entity for information about abuse reports.

Refer to the Moderation Service for a list of all related endpoints.

Examples:

Get Pending Moderation Items

To get all pending moderation items, perform a GET to /api/core/v3/moderation/pending. A sample response:

 {
     "itemsPerPage" : 25,
     "list" : [ {
         "id" : "1003",
         "resources" : {
             "abuseReports" : {
                 "allowed" : [ "GET" ],
                 "ref" : "https://example.jiveon.com/api/core/v3/contents/2373/abuseReports"
             },
             "self" : {
                 "allowed" : [ "GET", "PUT" ],
                 "ref" : "http://example.jiveon.com/api/core/v3/moderation/1003"
             }
         },
         "object" : {
             "displayName" : "My Favorite Document",
             "summary" : "Documents",
             "objectType" : "document",
             "url" : "https://example.jiveon.com/api/core/v3/contents/2373",
             "html" : "https://example.jiveon.com/docs/DOC-1013",
             "image" : "https://example.jiveon.com/people/user23/avatar?file=av.png"
         },
         "resolution" : "pending",
         "abuseCount" : 0,
         "type" : "moderation"
     }, {
         "id" : "1002",
         "resources" : {
             "abuseReports" : {
                 "allowed" : [ "GET" ],
                 "ref" : "https://example.jiveon.com/api/core/v3/contents/2372/abuseReports"
             },
             "self" : {
                 "allowed" : [ "GET", "PUT" ],
                 "ref" : "http://example.jiveon.com/api/core/v3/moderation/1002"
             }
         },
         "object" : {
             "displayName" : "My Least Favorite Document",
             "summary" : "Documents",
             "objectType" : "document",
             "url" : "https://example.jiveon.com/api/core/v3/contents/2372",
             "html" : "https://example.jiveon.com/docs/DOC-1012",
             "image" : "https://example.jiveon.com/people/user23/avatar?file=av.png"
         },
         "resolution" : "pending",
         "abuseCount" : 0,
         "type" : "moderation"
     } ],
     "startIndex" : 0
 }

Get Pending Abuse Reports

To get all pending abuse reports, perform a GET to /api/core/v3/moderation/pending?filter=moderationType(abuse). Note that this is the same endpoint as above, but now we're using a filter on the moderation type. The response format is the same as the previous example.

Get Moderation Item

To get an existing moderation item, perform a GET to /api/core/v3/moderation/123 where "123" is the ID for the moderation item you want. A sample response:

 {
     "id" : "123",
     "resources" : {
         "abuseReports" : {
             "allowed" : [ "GET" ],
             "ref" : "https://example.jiveon.com/api/core/v3/contents/6666/abuseReports"
         },
         "self" : {
             "allowed" : [ "GET", "PUT" ],
             "ref" : "http://example.jiveon.com/api/core/v3/moderation/123"
         }
     },
     "object" : {
         "displayName" : "My Controversial Document",
         "summary" : "Documents",
         "objectType" : "document",
         "url" : "https://example.jiveon.com/api/core/v3/contents/6666",
         "html" : "https://example.jiveon.com/docs/DOC-1023",
         "image" : "https://example.jiveon.com/people/user29/avatar?file=av.png"
     },
     "resolution" : "pending",
     "abuseCount" : 5,
     "type" : "moderation"
 }

Approve Moderation Item

To update an existing moderation item, perform a PUT to /api/core/v3/moderation/123 where "123" is the ID for the moderation item being updated. A sample set of fields included in the JSON payload:

 {
     "id": "123",
     "message": "Content Approved",
     "resolution": "approved"
 }

This example can be expressed using cURL:


 curl -X PUT -u USER -H "Content-Type: application/json" --data '{ "id": "123", "message": "Content Approved", "resolution": "approved" }' http://example.jiveon.com/api/core/v3/moderation/123

Since: 3.12

Fields

Field	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	Number of abuse reports associated with the moderation item. This field will only be present when this item is in moderation due to reported abuse.
`created`	`ISO 8601 Date`	read-only	Date and time when this moderation item entered moderation.
`id`	`String`	read-only	Identifier (unique within an object type and Jive instance) of this object.
`message`	`String`	optional	Message to include when approving or rejecting a moderation item. This message is not visible to the end user.
`object`	`ModerationObject`	read-only	Information about the object being moderated.
`resolution`	`String`	required	The current resolution state of this moderation item. Possible values are: approved rejected pending
`resources`	`Object`	read-only	Resource links (and related permissions for the requesting person) relevant to this object.
`type`	`String`	required	The type of moderation item. Will always be moderation.

Resources

Resource	Method	Description
`abuseReports`	`GET`	Get a list of abuse reports for this moderation item. Refer to AbuseReport for more information.
`self`	`GET`	Get information about this moderation item.
`self`	`PUT`	Update information about this moderation item.