Method Detail

• createRendition

  @Headers(value = {Content-Type: application/json})@POST(value = alfresco/versions/1/nodes/{nodeId}/renditions) abstract Unit createRendition(@Path(value = nodeId) String nodeId, @Body() RenditionBodyCreate renditionBodyCreate)

  Create rendition Note: this endpoint is available in Alfresco 5.2 and newer versions. An asynchronous request to create a rendition for file nodeId. The rendition is specified by name id in the request body: ``JSON { \"id\":\"doclib\" } `` Multiple names may be specified as a comma separated list or using a list format: ``JSON [ { \"id\": \"doclib\" }, { \"id\": \"avatar\" } ] `` The endpoint is owned by defaultname service owner @param nodeId The identifier of a node. (required) @param renditionBodyCreate The rendition \"id\". (required)

• getRendition

  @Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/nodes/{nodeId}/renditions/{renditionId}) abstract RenditionEntry getRendition(@Path(value = nodeId) String nodeId, @Path(value = renditionId) String renditionId)

  Get rendition information 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.

• getRenditionContent

  @Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/nodes/{nodeId}/renditions/{renditionId}/content) abstract ResponseBody getRenditionContent(@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 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.

• listRenditions

  @Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/nodes/{nodeId}/renditions) abstract RenditionPaging listRenditions(@Path(value = nodeId) String nodeId, @Query(value = where) String where)

  List renditions Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for each rendition of the 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)