Interface TrashcanApi
-
- All Implemented Interfaces:
@JvmSuppressWildcards() public interface TrashcanApi
-
-
Method Summary
Modifier and Type Method Description abstract UnitdeleteDeletedNode(@Path(value = "nodeId") String nodeId)Permanently delete a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract RenditionEntrygetArchivedNodeRendition(@Path(value = "nodeId") String nodeId, @Path(value = "renditionId") String renditionId)Get rendition information for a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract ResponseBodygetArchivedNodeRenditionContent(@Path(value = "nodeId") String nodeId, @Path(value = "renditionId") String renditionId, @Query(value = "attachment") Boolean attachment, @Header(value = "If-Modified-Since") ZonedDateTime ifModifiedSince, @Header(value = "Range") String range, @Query(value = "placeholder") Boolean placeholder)Get rendition content of a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract DeletedNodeEntrygetDeletedNode(@Path(value = "nodeId") String nodeId, @Query(value = "include") List<String> include)Get a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract ResponseBodygetDeletedNodeContent(@Path(value = "nodeId") String nodeId, @Query(value = "attachment") Boolean attachment, @Header(value = "If-Modified-Since") ZonedDateTime ifModifiedSince, @Header(value = "Range") String range)Get deleted node content Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract RenditionPaginglistDeletedNodeRenditions(@Path(value = "nodeId") String nodeId, @Query(value = "where") String where)List renditions for a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract DeletedNodesPaginglistDeletedNodes(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "include") List<String> include)List deleted nodes Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract NodeEntryrestoreDeletedNode(@Path(value = "nodeId") String nodeId, @Query(value = "fields") List<String> fields, @Body() DeletedNodeBodyRestore deletedNodeBodyRestore)Restore a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. -
-
Method Detail
-
deleteDeletedNode
@Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/deleted-nodes/{nodeId}") abstract Unit deleteDeletedNode(@Path(value = "nodeId") String nodeId)Permanently delete a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Permanently deletes the deleted node nodeId. The endpoint is owned by defaultname service owner
- Parameters:
nodeId- The identifier of a node.
-
getArchivedNodeRendition
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/deleted-nodes/{nodeId}/renditions/{renditionId}") abstract RenditionEntry getArchivedNodeRendition(@Path(value = "nodeId") String nodeId, @Path(value = "renditionId") String renditionId)Get rendition information for a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition information for renditionId of file nodeId. The endpoint is owned by defaultname service owner
- Parameters:
nodeId- The identifier of a node.renditionId- The name of a thumbnail rendition, for example doclib, or pdf.
-
getArchivedNodeRenditionContent
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/deleted-nodes/{nodeId}/renditions/{renditionId}/content") abstract ResponseBody getArchivedNodeRenditionContent(@Path(value = "nodeId") String nodeId, @Path(value = "renditionId") String renditionId, @Query(value = "attachment") Boolean attachment, @Header(value = "If-Modified-Since") ZonedDateTime ifModifiedSince, @Header(value = "Range") String range, @Query(value = "placeholder") Boolean placeholder)Get rendition content of a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition content for renditionId of file nodeId. The endpoint is owned by defaultname service owner
- Parameters:
nodeId- The identifier of a node.renditionId- The name of a thumbnail rendition, for example doclib, or pdf.attachment- true enables a web browser to download the file as an attachment.ifModifiedSince- Only returns the content if it has been modified since the date provided.range- The Range header indicates the part of a document that the server should return.placeholder- If true and there is no rendition for this nodeId and renditionId, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response.
-
getDeletedNode
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/deleted-nodes/{nodeId}") abstract DeletedNodeEntry getDeletedNode(@Path(value = "nodeId") String nodeId, @Query(value = "include") List<String> include)Get a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the specific deleted node nodeId. The endpoint is owned by defaultname service owner
- Parameters:
nodeId- The identifier of a node.include- Returns additional information about the node.
-
getDeletedNodeContent
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/deleted-nodes/{nodeId}/content") abstract ResponseBody getDeletedNodeContent(@Path(value = "nodeId") String nodeId, @Query(value = "attachment") Boolean attachment, @Header(value = "If-Modified-Since") ZonedDateTime ifModifiedSince, @Header(value = "Range") String range)Get deleted node content Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the content of the deleted node with identifier nodeId. The endpoint is owned by defaultname service owner
- Parameters:
nodeId- The identifier of a node.attachment- true enables a web browser to download the file as an attachment.ifModifiedSince- Only returns the content if it has been modified since the date provided.range- The Range header indicates the part of a document that the server should return.
-
listDeletedNodeRenditions
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/deleted-nodes/{nodeId}/renditions") abstract RenditionPaging listDeletedNodeRenditions(@Path(value = "nodeId") String nodeId, @Query(value = "where") String where)List renditions for a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for each rendition of the file nodeId, including the rendition id. Each rendition returned has a status: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested. You can use the where parameter to filter the returned renditions by status. For example, the following where clause will return just the CREATED renditions:
`` (status='CREATED') ``The endpoint is owned by defaultname service owner @param nodeId The identifier of a node. (required) @param where A string to restrict the returned objects by using a predicate. (optional)
-
listDeletedNodes
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/deleted-nodes") abstract DeletedNodesPaging listDeletedNodes(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "include") List<String> include)List deleted nodes Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of deleted nodes for the current user. If the current user is an administrator deleted nodes for all users will be returned. The list of deleted nodes will be ordered with the most recently deleted node at the top of the list. The endpoint is owned by defaultname service owner
- Parameters:
skipCount- The number of entities that exist in the collection before those included in this list.maxItems- The maximum number of items to return in the list.include- Returns additional information about the node.
-
restoreDeletedNode
@Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/deleted-nodes/{nodeId}/restore") abstract NodeEntry restoreDeletedNode(@Path(value = "nodeId") String nodeId, @Query(value = "fields") List<String> fields, @Body() DeletedNodeBodyRestore deletedNodeBodyRestore)Restore a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Attempts to restore the deleted node nodeId to its original location or to a new location. If the node is successfully restored to its former primary parent, then only the primary child association will be restored, including recursively for any primary children. It should be noted that no other secondary child associations or peer associations will be restored, for any of the nodes within the primary parent-child hierarchy of restored nodes, irrespective of whether these associations were to nodes within or outside of the restored hierarchy. Also, any previously shared link will not be restored since it is deleted at the time of delete of each node. The endpoint is owned by defaultname service owner
- Parameters:
nodeId- The identifier of a node.fields- A list of field names.deletedNodeBodyRestore- The targetParentId if the node is restored to a new location.
-
-
-
-