/{version}/files/{limsid}
The following operations are supported on this resource:
Removes all references to a file.
When using the DELETE operation, files remain on the server (which is referred to by the content-location
element). However, any links to the files are removed within the system, and the related resources referenced
by the files' attached-to elements will no longer contain a reference to the files, thereby severing
their relationship.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the file you want to remove.
|
path |
|
Output Payload
| element |
produceable content type(s) |
|
file (XML)
|
|
| description |
| When the file is successfully removed, the system returns an HTTP 204 (No Content) code with an empty
response body. |
Gets the representation of the file.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the file to retrieve.
|
path |
|
Output Payload
| element |
produceable content type(s) |
|
file (XML)
|
|
| description |
| The representation of the file. |
Updates the modifiable values of a file.
When issuing a PUT request, you can update the following file attributes:
- is-published: You can update whether the file is displayed within LabLink. To publish a file to LabLink,
use 'true'. To remove a file from LabLink, leaving it viewable only within the client,
use 'false'.
If you attempt to update attributes that cannot be modified, the system will ignore those elements of the PUT request.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the file you would like to update.
|
path |
|
Input Payload
| element |
consumeable content type(s) |
|
file (XML)
|
|
| description |
| The information about the file you would like to update. |
Output Payload
| element |
produceable content type(s) |
|
file (XML)
|
|
| description |
| When the file is successfully updated, the system returns an HTTP 200 (Ok) code with a response body that
includes the updated attributes of the file. |