REST API

/{version}/controltypes

The following operations are supported on this resource:

GET

Displays a list of control types stored in the system.

Output Payload

element produceable content type(s)
control-types (XML)
  • application/xml
description
The system returns a response that includes a list of control types and URI links.

POST

Creates a new control type in the system. When creating a control type, you must specify the name of the control type you want to add. Unless your XML specifies a particular archived state, the system will automatically set the archived state to false. An example of a submitted <control-type> is as follows:

<ctrltp:control-type xmlns:ctrltp="http://genologics.com/ri/controltype" name="E. coli genomic DNA">
  <supplier>ATCC</supplier>
  <catalogue-number>11229D-5</catalogue-number>
  <website>http://www.atcc.org/Products/All/11229D-5.aspx</website>
  <archived>false</archived>
  <single-step>false</single-step>
</ctrltp:control-type>

Input Payload

element consumeable content type(s)
control-type (XML)
  • */*
  • application/xml
description
The information about the control type you want to add to the system.

Output Payload

element produceable content type(s)
control-type (XML)
  • application/xml
description
When the control type is successfully created, the system returns an HTTP 201 (Created) code with a response body that includes information about the new control type.

GET

Gets a paged list of process type links. <p/>

The list of process type links can be filtered by providing query parameters. The resulting list of process type links will match a value for all the provided query parameters.

Parameters

name description type default
start-index An offset parameter that enables paging of the results. If omitted, the system returns the first page of process type links. query 0
displayname Limits the list of process type links to only those process types with the specified display name. query

Output Payload

element produceable content type(s)
process-types (XML)
  • application/xml
description
the list of process type links starting from the paging offset start-index.

/{version}/controltypes

Home

REST Endpoints

XML Data Elements

XML Data Types