/{version}/files/{limsid}

The following operations are supported on this resource:

• DELETE
• GET
• PUT

DELETE

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

Output Payload

GET

Gets the representation of the file.

Parameters

Output Payload

PUT

Updates the modifiable values of a file.

When issuing a PUT request, you can update the following file attributes:

• attached-to: You can update the URI of the resource or artifact that the file is associated with in the system.
• 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.

When working with the attached-to element, the following resources or artifacts can be used:

• Projects
• Processes
• Samples
• File-based artifacts, such as ResultFile, SearchResultFile, and Image.

You can only attach a single file to an artifact. However, you can attach multiple files to project, process, and sample resources.

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)	*/* application/xml
description
The information about the file you would like to update.

Output Payload

element	produceable content type(s)
file (XML)	application/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.