REST API

/{version}/configuration/protocols

The following operations are supported on this resource:

GET

Displays a list of stored Protocols in the system.

An example of returned <protocols> is as follows:
<protcnf:protocols xmlns:protcnf="http://genologics.com/ri/protocolconfiguration">   <protocol uri="http://localhost:8080/api/v2/configuration/protocols/1" name="RNA Initial QC"/>   <protocol uri="http://localhost:8080/api/v2/configuration/protocols/13" name="Preconfig Minimum Steps"/>   <protocol uri="http://localhost:8080/api/v2/configuration/protocols/7" name="TruSeq Amplicon Library Prep"/>   <protocol uri="http://localhost:8080/api/v2/configuration/protocols/4" name="Nextera DNA Library Prep"/>   <protocol uri="http://localhost:8080/api/v2/configuration/protocols/2" name="TruSeq RNA Library Prep"/>   <protocol uri="http://localhost:8080/api/v2/configuration/protocols/5" name="TruSeq DNA Library Prep"/> </protcnf:protocols>
When submitting a GET request, you can use the following query parameters to filter the results. For more information about using query parameters, please refer to the Filtering list resources section under REST General Concepts.

Parameters

name description type default
name the name of the protocol to get query

Output Payload

element produceable content type(s)
protocols (XML)
  • application/xml
description
The system returns a response that includes a list of protocol and URI links, starting from the start-index offset.

/{version}/configuration/protocols

Home

REST Endpoints

XML Data Elements

XML Data Types