Moderation

Moderation Service

REST endpoints for managing Moderation tasks within a Jive instance. With this service, you can view and update moderation items available to you.

The Moderation Entity contains examples on how to use these endpoints.

Since: 3.12

Get Counts

GET /moderation/pending/counts

Return counting information about the moderation queue of the person making the request.

Field Description
pendingCount Indicates number of pending moderation items for the person making the request.
Query Parameters:
NameTypeRequiredDescription
filterObject[]falseFilter expression(s) used to select matching results
Retrieves:
  • counting information about the inbox of the person making the request
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)an error happened while building the JSON reply
    Since: 3.4

    Get Moderation

    GET /moderation/{moderationID}
    Gets the specified Moderation item.
    Path Parameters:
    NameTypeRequiredDescription
    moderationIDStringtrueThe identifier for the moderation item
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned for each item
    Retrieves:
  • Moderation of the requested moderation item
    • Return Status:
    HTTP Status CodeDescription
    404 (Not Found)If the moderation item cannot be found for the current user
    400 (Bad Request)If the request has malformed parameters

    Get Pending Moderation

    GET /moderation/pending

    Gets the pending Moderation items (e.g. profile images and new user accounts), including content flagged for abuse.

    This service supports the following filters:

    Filter Params Example
    objectType One or more of the object types being moderated, separated by commas. Possible values are:
    • announcement
    • comment
    • discussion
    • document
    • event
    • externalActivity
    • file
    • idea
    • message
    • person
    • photo
    • photoAlbum
    • poll
    • post
    • profileImage
    • update
    • url
    • video
    		 ?filter=type(document,person)
    place A place URI. Only one place can be specified. Place and author filters are mutually exclusive. ?filter=place(https://example.jiveon.com/api/core/v3/places/1006)
    author A person URI representing the author under review. Only one author can be specified. Place and author filters are mutually exclusive. ?filter=author(https://example.jiveon.com/api/core/v3/people/12)
    moderationType The type of moderation. Can either be moderation or abuse. Refer to AbuseReport for information about abuse reports. Default value is moderation. ?filter=moderationType(moderation)
    Query Parameters:
    NameTypeRequiredDescription
    filterObject[]falseFilters the criteria used to select moderation items
    startIndexIntegerfalseZero-relative index of the first matching content to be returned
    countIntegerfalseMaximum number of items to return
    fieldsStringfalseFields to be returned for each item
    Retrieves:
  • Moderation[] containing the matched items
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)If the request contains malformed parameters
    403 (Forbidden)If the requesting user is not authorized to view an object specified by a filter
    404 (Not Found)If an object specified by a filter does not exist

    Update Moderation

    PUT /moderation/{moderationID}
    Updates an existing Moderation item.
    Path Parameters:
    NameTypeRequiredDescription
    moderationIDStringtrueThe identifier for the moderation item
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned for each item
    Return Status:
    HTTP Status CodeDescription
    404 (Not Found)If the moderation item cannot be found for the current user
    400 (Bad Request)If the request has malformed parameters or content
    403 (Forbidden)If the requesting user is not authorized to perform this action