REST API

/{version}/artifacts/batch/update

The following operations are supported on this resource:

POST

Updates the characteristics of the specified artifacts. Rules for updating individual artifacts apply.

Example <details>:
<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> Example <links> response:
<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>

Input Payload

element consumeable content type(s)
details (XML)
  • application/xml
description
The XML representations of all the artifacts you want to update, wrapped in a <details> parent. You can only update the most recent state of an artifact. Artifacts with different states provided in the details will be considered as duplicate requests and will result in an HTTP 400 error. Please refer to the PUT documentation for artifacts (single) in the REST resources documentation for the artifact XML representation and a description of what elements/attributes can be updated.

Output Payload

element produceable content type(s)
details (XML)
  • application/xml
description
When artifacts have been successfully updated, the system returns an HTTP 200 (OK) code. The response body includes a list of URI links to all updated artifacts. The URIs do not explicitly include state; by default, this returns the most recent state of each artifact.

/{version}/artifacts/batch/update

Home

REST Endpoints

XML Data Elements

XML Data Types