DeletedObject

DeletedObject Service

Web services for finding content, people, and places that have been deleted. You cannot recover the actual deleted object using these services; you can view basic information about a deleted object such as object type, delete date, and the original URI for the item before it was deleted.

The Deleted Object Entity contains examples on how to use these endpoints.

Since: 3.12

Get Deleted Contents

GET /deletedObjects/contents

Return a paginated list of entities, each representing a content object that has been deleted.

This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

Filter Params Example
since Restricts results to contain entities representing deleted objects removed on or after this date. ?filter=since(2015-05-04T15:16:55Z)
type One or more content object types, separated by commas ?filter=type(discussion,file)
?filter=type(post)

This service supports the following sort types.

Sort Description
eventDateAsc Sort by the date the content object was removed, in ascending order
eventDateDesc Sort by the date the content object was removed, in descending order. Default if none was specified.

The returned list may contain entities representing various deleted content types. On any returned entity, use the objectType field to determine the type of the deleted content object.

Query Parameters:
NameTypeRequiredDescription
filterObject[]falseFilter criteria used to select deleted content objects
sortStringfalseSort order; default returns the most recently deleted objects first
startIndexIntegerfalseZero-relative index of the first entity to be returned
countIntegerfalseMaximum number of entities to be returned
fieldsStringfalseFields to be returned in the selected entities
Retrieves:
  • DeletedObject[]
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    Since: 3.12

    Get Deleted Object

    GET /deletedObjects/{deletedObjectID}

    Return the specified deleted object entity with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    deletedObjectIDStringtrueUUID of the deleted object entity to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • DeletedObject
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    404 (Not Found)The specified deleted object entity does not exist
    Since: 3.12

    Get Deleted People

    GET /deletedObjects/people

    Return a paginated list of entities, each representing a person object that has been deleted.

    This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

    Filter Params Example
    since Restricts results to contain entities representing deleted objects removed on or after this date. ?filter=since(2015-05-04T15:16:55Z)

    This service supports the following sort types.

    Sort Description
    eventDateAsc Sort by the date the person object was removed, in ascending order
    eventDateDesc Sort by the date the person object was removed, in descending order. Default if none was specified.

    Query Parameters:
    NameTypeRequiredDescription
    filterObject[]falseFilter criteria used to select deleted person object
    sortStringfalseSort order; default returns the most recently deleted objects first
    startIndexIntegerfalseZero-relative index of the first entity to be returned
    countIntegerfalseMaximum number of entities to be returned
    fieldsStringfalseFields to be returned in the selected entities
    Retrieves:
  • DeletedObject[]
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    Since: 3.12

    Get Deleted Places

    GET /deletedObjects/places

    Return a paginated list of entities, each representing a place object that has been deleted.

    This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

    Filter Params Example
    since Restricts results to contain entities representing deleted objects removed on or after this date. ?filter=since(2015-05-04T15:16:55Z)
    type One or more place object types, separated by commas ?filter=type(group,project)
    ?filter=type(space)

    This service supports the following sort types.

    Sort Description
    eventDateAsc Sort by the date the place object was removed, in ascending order
    eventDateDesc Sort by the date the place object was removed, in descending order. Default if none was specified.

    The returned list may contain entities representing various deleted place types. On any returned entity, use the objectType field to determine the type of the deleted place object.

    Query Parameters:
    NameTypeRequiredDescription
    filterObject[]falseFilter criteria used to select deleted place object
    sortStringfalseSort order; default returns the most recently deleted objects first
    startIndexIntegerfalseZero-relative index of the first entity to be returned
    countIntegerfalseMaximum number of entities to be returned
    fieldsStringfalseFields to be returned in the selected entities
    Retrieves:
  • DeletedObject[]
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    Since: 3.12