GET
Displays a list of artifacts stored in the system. If the number of artifacts returned exceeds the display maximum, the results are paged.
When submitting a GET request, you can use the following query parameters to filter the results. For more information about using query parameters, please refer to [REST:Filtering list resources].
Parameters
| name | description | type | default |
|---|---|---|---|
| start-index | When working with large lists of results, displays the results from a set point. If omitted, the first page of results is returned. | query | 0 |
| name | Displays only artifacts with names that match the specified value. When configuring a process in the client, this is known as the artifact's Display Name. When filtering results, you can repeat this parameter. | query | |
| type | Displays only artifacts whose type matches the specified value, such as Analyte or ResultFile. When filtering results, you can repeat this parameter. | query | |
| udf.UDFNAME\[OPERATOR\]=UDFVALUE | Displays only artifacts that include the specified UDF value. The system will only return artifacts with standalone UDFs; it will not return artifacts with UDFs that belong to a UDT. When filtering results, you can repeat this parameter. | query | |
| process-type | Displays only the artifacts that were produced by the specified process type (the name of the process in the client). When filtering results, you can repeat this parameter. | query | |
| working-flag | Displays only the artifacts that have had their working flag (the working status in the client) set to the specified value. You can specify true or false. | query | |
| qc-flag | Displays only the artifacts containing the specified QC flag value (which is applied by running a process). You can use one of the following values: UNKNOWN, PASSED, FAILED, CONTINUE. UNKNOWN indicates that a quality control (QC) step has not been performed. PASSED indicates that the artifact has successfully passed a QC step. FAILED indicates that the artifact has failed a QC step. CONTINUE is a legacy system value that is no longer applied to artifacts. When filtering results, you can repeat this parameter. | query | |
| sample-name | Displays only the artifacts that are related to the specified submitted sample name. When filtering results, you can repeat this parameter. | query | |
| artifactgroup | Displays only the artifacts that belong to the specified artifact group (the name of the experiment in the client). When filtering results, you can repeat this parameter. | query | |
| containername | Displays only the artifacts that reside in containers whose name (identifier) matches the specified value. When filtering results, you can repeat this parameter. | query | |
| containerlimsid | Displays only the artifacts that reside in containers whose LIMS ID matches the specified value. When filtering results, you can repeat this parameter. | query | |
| reagent-label | Displays only the artifacts with attached reagent labels whose name (identifier) matches the specified values. When filtering results, you can repeat this parameter. | query |
Output Payload
| element | produceable content type(s) |
|---|---|
| artifacts (XML) |
|
| description | |
| The system returns a response that includes a list of artifacts and URI links, starting from the start-index offset. | |