Constructor Detail

Method Detail

• cancelDownload

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/downloads/{downloadId}") abstract Unit cancelDownload(@Path(value = "downloadId") String downloadId)

  Cancel a download Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Cancels the creation of a download request. Note: The download node can be deleted using the DELETE /nodes/{downloadId} endpoint By default, if the download node is not deleted it will be picked up by a cleaner job which removes download nodes older than a configurable amount of time (default is 1 hour) Information about the existing progress at the time of cancelling can be retrieved by calling the GET /downloads/{downloadId} endpoint The cancel operation is done asynchronously. The endpoint is owned by defaultname service owner

  Parameters:

  downloadId - The identifier of a download node.

• createDownload

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/downloads") abstract DownloadEntry createDownload(@Body() DownloadBodyCreate downloadBodyCreate, @Query(value = "fields") List<String> fields)

  Create a new download Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Creates a new download node asynchronously, the content of which will be the zipped content of the nodeIds specified in the JSON body like this: ``JSON { \"nodeIds\": [ \"c8bb482a-ff3c-4704-a3a3-de1c83ccd84c\", \"cffa62db-aa01-493d-9594-058bc058eeb1\" ] } `` Note: The content of the download node can be obtained using the GET /nodes/{downloadId}/content endpoint The endpoint is owned by defaultname service owner @param downloadBodyCreate The nodeIds the content of which will be zipped, which zip will be set as the content of our download node. (required) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. (optional)

• getDownload

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/downloads/{downloadId}") abstract DownloadEntry getDownload(@Path(value = "downloadId") String downloadId, @Query(value = "fields") List<String> fields)

  Get a download Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Retrieve status information for download node downloadId The endpoint is owned by defaultname service owner

  Parameters:

  downloadId - The identifier of a download node.

  fields - A list of field names.