REST API

/{version}/files/{limsid}/download

The following operations are supported on this resource:

GET

Downloads the file found in the content-location specified by the file single resource. The Content-Type header will match the file's mime-type for common mime-types. The Content-Type header defaults to application/octet-stream if the mime-type is not known. The Content-Disposition header has the value: 'attachment; filename="fileName.txt"' where fileName.txt is the actual name of the file. The Content-Length header indicates the size of the file contained in the response body (in bytes).

Parameters

name description type default
limsid The LIMS ID of the file whose content-location will be the download source. path

Output Payload

element produceable content type(s)
(custom)
  • */*
  • application/xml
description
When the file is successfully downloaded, the system returns an HTTP 200 (OK) code with a response body that contains the file in binary form.

/{version}/files/{limsid}/download

Home

REST Endpoints

XML Data Elements

XML Data Types