REST API

/{version}/configuration/protocols/{protocolid}

The following operations are supported on this resource:

GET

Displays full details of a specific Protocol in the system. An example of a returned <protocol> is as follows:

<protcnf:protocol xmlns:protstepcnf="http://genologics.com/ri/stepconfiguration" xmlns:protcnf="http://genologics.com/ri/protocolconfiguration" uri="http://localhost:8080/api/v2/configuration/protocols/1" index="2" name="RNA Initial QC">
  <steps>
    <step uri="http://localhost:8080/api/v2/configuration/protocols/1/steps/1" name="Bioanalyzer QC (RNA) 4.0" protocol-uri="http://localhost:8080/api/v2/configuration/protocols/1">
      <protocol-step-index>1</protocol-step-index>
      <process-type uri="http://localhost:8080/api/v2/processtypes/21">NanoDrop QC (DNA) 4.0</process-type>
      <permitted-containers>
        <container-type>BioAnalyzer RNA Nano Chip</container-type>
        <container-type>BioAnalyzer RNA Pico Chip</container-type>
      </permitted-containers>
      <transitions/>
      <queue-fields>
        <queue-field detail="false" attach-to="Analyte" name="Sample Name"/>
        <queue-field detail="false" attach-to="Container" name="Container Name"/>
        <queue-field detail="true" attach-to="Project" name="Project Name"/>
        <queue-field detail="false" attach-to="Container" name="LIMS ID (Container)"/>
        <queue-field detail="true" attach-to="Analyte" name="Waiting"/>
      </queue-fields>
      <step-fields>
        <step-field attach-to="ConfiguredProcess" name="Criteria 1 - Source Data Field"/>
        <step-field attach-to="ConfiguredProcess" name="Criteria 1 - Operator"/>
        <step-field attach-to="ConfiguredProcess" name="Criteria 1 - Threshold Value"/>
        <step-field attach-to="ConfiguredProcess" name="Criteria 2 - Source Data Field"/>
        <step-field attach-to="ConfiguredProcess" name="Criteria 2 - Operator"/>
        <step-field attach-to="ConfiguredProcess" name="Criteria 2 - Threshold Value"/>
      </step-fields>
      <sample-fields>
        <sample-field attach-to="Analyte" name="Sample Name"/>
        <sample-field attach-to="Container" name="Well"/>
        <sample-field attach-to="ResultFile" name="Concentration"/>
        <sample-field attach-to="ResultFile" name="Conc. Units"/>
      </sample-fields>
      <step-properties>
        <step-property value="true" name="qcProtocolStep"/>
        <step-property value="false" name="qcWithPlacement"/>
        <step-property value="false" name="measurementWithFile"/>
        <step-property value="true" name="enableExternalPrograms"/>
        <step-property value="1/{LIST:NanoDrop NDT Result File (required),NanoDrop NDT Parsing Log File (generated),QC Assignment Log File (generated),QC Assignment Report (generated)}|2/{LIST:NanoDrop NDT Result File (required),NanoDrop NDT Parsing Log File (generated),QC Assignment Log File (generated),QC Assignment Report (generated)}|3/{LIST:NanoDrop NDT Result File (required),NanoDrop NDT Parsing Log File (generated),QC Assignment Log File (generated),QC Assignment Report (generated)}" name="autoAttachFiles"/>
        <step-property value="" name="stepDetailsHeading"/>
        <step-property value="" name="sampleDetailsHeading"/>
        <step-property value="([type=Bioanalyzer QC (RNA) 4.0|attachTo=ResultFile|field=QC] != "1")" name="filter"/>
      </step-properties>
      <step-setup>
        <files>
          <file shared-result-file-index="0">
            <message>message 1</message>
          </file>
          <file shared-result-file-index="1">
            <message>message 2</message>
          </file>
        </files>
      </step-setup>
      <epp-triggers>
        <epp-trigger status="RECORD_DETAILS" point="BEFORE" type="AUTOMATIC" name="Auto Parse NanoDrop NDT"/>
        <epp-trigger type="MANUAL" name="Parse NanoDrop NDT and Assign QC flags based upon criteria above"/>
        <epp-trigger type="UNUSED" name="Unused Parse NanoDrop NDT"/>
      </epp-triggers>
    </step>
  </steps>
  <protocol-properties>
    <protocol-property value="false" name="hidden"/>
    <protocol-property value="0" name="capacity"/>
    <protocol-property value="qc" name="type"/>
    </protocol-properties>
</protcnf:protocol>

Parameters

name description type default
protocolid the protocol ID of the protocol to get path

Output Payload

element produceable content type(s)
protocol (XML)
  • application/xml
description
The system returns a response that includes a specific protocol and all relevant properties and steps

/{version}/configuration/protocols/{protocolid}

Home

REST Endpoints

XML Data Elements

XML Data Types