/{version}/artifacts/batch/retrieve
The following operations are supported on this resource:
Displays the XML representation of the specified artifacts.
An example <links> is as follows:
<ri:links xmlns:ri="http://genologics.com/ri">
<link uri="http://localhost:8080/api/v2/artifacts/LUN3A1PA1" rel="artifacts"/>
<link uri="http://localhost:8080/api/v2/artifacts/LEU9A1PA1" rel="artifacts"/>
</ri:links>
Example response <details>:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<art:details xmlns:ri="http://genologics.com/ri" xmlns:udf="http://genologics.com/ri/userdefined" xmlns:file="http://genologics.com/ri/file" xmlns:art="http://genologics.com/ri/artifact" xmlns:con="http://genologics.com/ri/container">
<art:artifact uri="http://localhost:8080/api/v2/artifacts/LUN3A1PA1?state=1088" limsid="LUN3A1PA1">
<name>Cancer Sample-1</name>
<type>Analyte</type>
<output-type>Analyte</output-type>
<qc-flag>UNKNOWN</qc-flag>
<location>
<container uri="http://localhost:8080/api/v2/containers/65-1" limsid="65-1"/>
<value>A:1</value>
</location>
<working-flag>false</working-flag>
<sample uri="http://localhost:8080/api/v2/samples/LUN3A1" limsid="LUN3A1"/>
</art:artifact>
<art:artifact uri="http://localhost:8080/api/v2/artifacts/LEU9A1PA1?state=1131" limsid="LEU9A1PA1">
...
</art:artifact>
</art:details>
Input Payload
element |
consumeable content type(s) |
links (XML)
|
|
description |
A series of links, each containing the URI of an artifact you would like to retrieve. The artifact URIs must be unique and must correspond to valid artifact URIs in the system. Mixed resource links will result in an HTTP 400 error. Similarly, the request will be rejected if any URI does not resolve to an artifact in the system.
|
Output Payload
element |
produceable content type(s) |
details (XML)
|
|
description |
The system returns a response that includes the XML representations of the requested artifacts, wrapped in a <details> parent.
Please refer to the GET documentation for artifacts(single) in the REST resources documentation for
more information about the artifact XML representation that will be returned in the details.
|