REST API

/{version}/containers/batch/create

The following operations are supported on this resource:

POST

Creates a batch of containers, as specified in the request details. Rules for creating individual containers apply.

Input Payload

element consumeable content type(s)
details (XML)
  • application/xml
description
The information about the containers you want to add to the system, wrapped in a <details> parent. All request details must be valid container XML representations. Mixed requests will result in an HTTP 400 error. Please refer to the POST documentation for containers (list) in the REST resources documentation for the container XML representation and a description of what elements/attributes are necessary at creation.
An example of <details> to POST as follows:

<con: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">
  <con:container uri="http://localhost:8080/api/v2/containers">
   <name>test container 1</name>
   <type uri="http://localhost:8080/api/v2/containertypes/1"/>
  </con:container>
  <con:container uri="http://localhost:8080/api/v2/containers">
   ...
  </con:container>
</con:details>

Output Payload

element produceable content type(s)
links (XML)
  • application/xml
description
When the containers have been successfully created, the system returns an HTTP 200 (OK) code. The response body includes a list of URI links to the new containers.
For example:

<ri:links xmlns:ri="http://genologics.com/ri">
  <link uri="http://localhost:8080/api/v2/containers/65-1" rel="containers"/>
  <link uri="http://localhost:8080/api/v2/containers/65-2" rel="containers"/>
</ri:links>

/{version}/containers/batch/create

Home

REST Endpoints

XML Data Elements

XML Data Types