Shares Resource

GET /admin/shares

Lists Shares in the system.

Request Parameters
name type description default constraints
include_expired query Controls whether or not expired shares are returned in the results. false boolean
shared_by query Return only the items that were shared by the user with the specified ID   long
shared_with query Return only the items that were shared with the user or group with the specified ID   long
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of Share objects.
application/xml searchResultList (XML)

GET /admin/shares/public

Lists all of the public shares in the system

Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of Share objects.
application/xml searchResultList (XML)

DELETE /admin/shares/{id}

Deletes a Share

Request Parameters
name type description constraints
id path The ID of the share to delete long
Response Codes
code condition
204 The share was deleted successfully
404 (SHAREITEM_NOT_FOUND) No share exists with the specified ID.

GET /admin/shares/{id}

Gets a share by ID.

Request Parameters
name type description constraints
id path The ID of the share to get long
Response Codes
code condition
404 (SHAREITEM_NOT_FOUND) No share exists with the specified ID.
Response Body
media type data type description
application/json Share (JSON) The Share with the given ID
application/xml share (XML)