REST API

/{version}/controltypes/{controltypeid}

The following operations are supported on this resource:

GET

Displays the XML representation of a specified control type.

Parameters

name description type default
controltypeid The control type ID of the control type you would like to display. path

Output Payload

element produceable content type(s)
control-type (XML)
  • application/xml
description
The system returns a response that includes the XML representation of the control type.

PUT

Updates the control type in the system.

When updating a control type, you must specify the name of the control type you want to update. Unless your XML specifies a particular archived state, the system will not update the archived state of the control type.

An example of a submitted <control-type> is as follows:
<ctrltp:control-type xmlns:ctrltp="http://genologics.com/ri/controltype" uri="http://localhost:8080/api/v2/controltypes/{controlTypeId}" 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>

Parameters

name description type default
controltypeid The control type ID of the control type you would like to display. path

Input Payload

element consumeable content type(s)
control-type (XML)
  • */*
  • application/xml
description
The information about the control type you would like to update.

Output Payload

element produceable content type(s)
control-type (XML)
  • application/xml
description
When the control type is successfully updated, the system returns an HTTP 200 (OK) code with a response body that includes the updated attributes of the control type.

/{version}/controltypes/{controltypeid}

Home

REST Endpoints

XML Data Elements

XML Data Types