/{version}/artifacts/{limsid}
The following operations are supported on this resource:
Displays the XML representation of a specified artifact.
The system uses a numerical 'state' to track process-level changes made to an artifact.
The state is changed when you run a process on an artifact, either in the client or
through the API. You can locate the state changes made to an artifact using the post-process-uri
and uri attributes within the input-output-map element of a completed process. For more information
about these attributes and elements, please consult the processes (prc) namespace documentation.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the artifact you would like to display.
|
path |
|
| state |
The state of the artifact you would like to display, preceded with a Question Mark ( ? ). If you do not specify a state, the current state of the artifact is displayed.
|
query |
|
Output Payload
| element |
produceable content type(s) |
|
artifact (XML)
|
|
| description |
| The system returns a response that includes the XML representation of the artifact at the specified state. |
Updates the characteristics of a specified artifact.
When submitting a PUT request, you can update the following artifact attributes:
- name: The name attribute must be provided, but can be modified.
- qc-flag: If the qc-flag attribute is not provided, it will be set to UNKNOWN.
- field: The entire set of fields must be provided. Fields can be added or removed.
- reagent-label: Labels can be added or removed. Reagent Labels will not propagate to downstream artifacts of any processes that have already been run on this artifact.
- artifact-group An Artifact can belong to one or more artifact-groups. artifact-group attributes can be added or removed.
For Analyte type artifacts the following attributes can be modified:
- working-flag
The following attributes of a ResultFile artifact can no longer be modified:
- file: files can no longer be modified through the PUT operation and changes will be ignored. The "files" resource should be used instead.
Files attached to a ResultFile Artifact are still visible in the payload returned by a GET.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the artifact you would like to update.
|
path |
|
Input Payload
| element |
consumeable content type(s) |
|
artifact (XML)
|
|
| description |
| The information about the artifact you would like to update. |
Output Payload
| element |
produceable content type(s) |
|
artifact (XML)
|
|
| description |
| When the artifact is successfully updated, the system returns an HTTP 200 (OK) code with a response body that includes the
updated attributes of the artifact. |
This method has been deprecated. For information on how to add files to the system and associate them with artifacts, please refer to the Files resource section of this reference guide..
This method has been deprecated. For information on how to add files to the system and associate them with artifacts,
please refer to the Files resource section of this reference guide.
Updates the file associated with a result file artifact existing in the system.
Parameters
| name |
description |
type |
default |
| limsid |
the LIMS ID of the result file to update
|
path |
|
| Content-Length |
the length of the file provided to replace any existing file associated with the artifact
|
header |
|
| x-original-location |
the original location of the file
|
header |
|
Input Payload
| element |
consumeable content type(s) |
| (custom) |
|
| description |
| the file content |
Output Payload
| element |
produceable content type(s) |
| (custom) |
|
| description |
| The updated representation of the result file artifact. |