GET
Provides an entry point for the API, listing the available resources in the system.
Output Payload
| element | produceable content type(s) |
|---|---|
| versions (XML) |
|
| description | |
| The list of links providing URIs for the supported API versions in the system. | |
REST API
/{version}
Home
REST Endpoints
- /{version}
- /{version}/{version}
- /{version}/artifactgroups
- /{version}/artifactgroups/{experimentid}
- /{version}/artifacts
- /{version}/artifacts/{limsid}
- /{version}/artifacts/{limsid}/demux
- /{version}/artifacts/batch/retrieve
- /{version}/artifacts/batch/update
- /{version}/configuration/automations
- /{version}/configuration/automations/{automationid}
- /{version}/configuration/protocols
- /{version}/configuration/protocols/{protocolid}
- /{version}/configuration/protocols/{protocolId}/steps/{stepId}
- /{version}/configuration/udfs
- /{version}/configuration/udfs/{udfid}
- /{version}/configuration/udts
- /{version}/configuration/udts/{udtid}
- /{version}/configuration/workflows
- /{version}/configuration/workflows/{workflowid}
- /{version}/configuration/workflows/{workflowid}/stages/{stageid}
- /{version}/containers
- /{version}/containers/{limsid}
- /{version}/containers/batch/create
- /{version}/containers/batch/retrieve
- /{version}/containers/batch/update
- /{version}/containertypes
- /{version}/containertypes/{containertypeid}
- /{version}/controltypes
- /{version}/controltypes/{controltypeid}
- /{version}/external/{externalid}
- /{version}/files
- /{version}/files/{limsid}
- /{version}/files/{limsid}/download
- /{version}/files/{limsid}/upload
- /{version}/files/batch/retrieve
- /{version}/files/batch/update
- /{version}/glsstorage
- /{version}/instruments
- /{version}/instruments/{instrumentid}
- /{version}/labs
- /{version}/labs/{labid}
- /{version}/permissions
- /{version}/permissions/{permissionId}
- /{version}/processes
- /{version}/processes/{limsid}
- /{version}/processtemplates
- /{version}/processtemplates/{limsid}
- /{version}/processtypes
- /{version}/processtypes/{processtypeid}
- /{version}/projects
- /{version}/projects/{limsid}
- /{version}/projects/{limsid}/samplesheet
- /{version}/queues/{protocolStepId}
- /{version}/reagentkits
- /{version}/reagentkits/{reagentkitid}
- /{version}/reagentlots
- /{version}/reagentlots/{reagentlotid}
- /{version}/reagenttypes
- /{version}/reagenttypes/{reagenttypeid}
- /{version}/researchers
- /{version}/researchers/{researcherid}
- /{version}/roles
- /{version}/roles/{roleId}
- /{version}/route/artifacts
- /{version}/samples
- /{version}/samples/{limsid}
- /{version}/samples/batch/create
- /{version}/samples/batch/retrieve
- /{version}/samples/batch/update
- /{version}/steps
- /{version}/steps/{limsid}
- /{version}/steps/{limsid}/actions
- /{version}/steps/{limsid}/advance
- /{version}/steps/{limsid}/details
- /{version}/steps/{limsid}/placements
- /{version}/steps/{limsid}/pools
- /{version}/steps/{limsid}/programstatus
- /{version}/steps/{limsid}/reagentlots
- /{version}/steps/{limsid}/reagents
- /{version}/steps/{limsid}/setup
- /{version}/steps/{limsid}/trigger/{programid}
XML Data Elements
- actions (stp)
- artifact (art)
- artifactgroup (artgr)
- artifactgroups (artgr)
- artifacts (art)
- automation (aut)
- automations (aut)
- container (con)
- containers (con)
- container-type (ctp)
- container-types (ctp)
- control-type (ctrltp)
- control-types (ctrltp)
- demux (art)
- demux-details (art)
- details (art)
- details (con)
- details (file)
- details (smp)
- details (stp)
- exception (exc)
- field (cnf)
- file (file)
- files (file)
- index (ri)
- instrument (inst)
- instruments (inst)
- instrument-type (itp)
- instrument-types (itp)
- lab (lab)
- labs (lab)
- links (ri)
- lots (stp)
- permission (perm)
- permissions (perm)
- placements (stp)
- pools (stp)
- process (prc)
- process (prx)
- processes (prc)
- process-template (ptm)
- process-templates (ptm)
- process-type (ptp)
- process-types (ptp)
- program-status (stp)
- project (prj)
- projects (prj)
- properties (prop)
- protocol (protcnf)
- protocols (protcnf)
- queue (que)
- reagent-kit (kit)
- reagent-kits (kit)
- reagent-lot (lot)
- reagent-lots (lot)
- reagents (stp)
- reagent-type (rtp)
- reagent-types (rtp)
- researcher (res)
- researchers (res)
- role (role)
- roles (role)
- routing (rt)
- sample (smp)
- samplecreation (smp)
- samples (smp)
- setup (stp)
- stage (stg)
- step (stp)
- step (protstepcnf)
- step-creation (stp)
- type (cnf)
- udfconfig-link (cnf)
- udfs (cnf)
- udtconfig-link (cnf)
- udts (cnf)
- version (ver)
- versions (ver)
- workflow (wkfcnf)
- workflows (wkfcnf)
XML Data Types
- actions (stp)
- actions-link (stp)
- action-type (stp)
- address (ri)
- artifact (art)
- artifact (prc)
- artifact (rt)
- artifact (smp)
- artifact (stp)
- artifactbase (prx)
- artifactgroup (art)
- artifactgroup (artgr)
- artifactgroup-link (artgr)
- artifactgroups (artgr)
- artifact-link (art)
- artifact-link (que)
- artifacts (art)
- artifacts (artgr)
- attribute (rtp)
- automatic-next-step-link (stp)
- automation (aut)
- automation-link (aut)
- automations (aut)
- available-program (stp)
- biosource (smp)
- calibrant-well (ctp)
- container (ri)
- container (con)
- container (stp)
- container-link (con)
- containers (con)
- container-type (con)
- container-type (ctp)
- container-type-link (ctp)
- container-type-link (ptp)
- container-types (ctp)
- context (aut)
- controlType (smp)
- control-type (art)
- control-type (ctrltp)
- control-type-link (ctrltp)
- control-type-link (ptp)
- control-type-link (protstepcnf)
- control-types (ctrltp)
- creation-input (stp)
- credentials (res)
- demux (art)
- demux-artifact (art)
- demux-artifact-sample (art)
- demux-details (art)
- demux-link (art)
- demux-source-artifact (art)
- details (art)
- details (con)
- details (file)
- details (smp)
- details (stp)
- details-link (stp)
- dimension (ctp)
- epp-trigger (ptp)
- epp-trigger (protstepcnf)
- escalated-artifact (stp)
- escalation (stp)
- escalation-request (stp)
- escalation-review (stp)
- exception (exc)
- extArtifactAssignments (rt)
- externalid (ri)
- field (cnf)
- field (ptp)
- field (protstepcnf)
- field (udf)
- field-link (cnf)
- field-type (cnf)
- file (file)
- file (ptp)
- file (stp)
- file (protstepcnf)
- file-link (file)
- files (file)
- generic-type-link (protstepcnf)
- icebucketfield (ptp)
- icebucketfield (protstepcnf)
- index (ri)
- input (prx)
- input (stp)
- input-output-map (prc)
- input-output-map (prx)
- input-output-map (stp)
- instrument (inst)
- instrument (prc)
- instrument (prx)
- instrument (ptm)
- instrument (stp)
- instrument-link (inst)
- instruments (inst)
- instrument-type (itp)
- instrument-type-link (itp)
- instrument-type-process-type (itp)
- instrument-types (itp)
- invocation-type (ptp)
- lab (lab)
- lab (res)
- lab-link (lab)
- labs (lab)
- link (ri)
- links (ri)
- location (ri)
- lockable-setting (protstepcnf)
- next-action (stp)
- next-step (protstepcnf)
- output (prx)
- output (stp)
- output-generation-type (prc)
- output-generation-type (ptp)
- output-generation-type (stp)
- output-placement (stp)
- page (ri)
- parameter (prc)
- parameter (prx)
- parameter (ptm)
- parameter (ptp)
- parent-process (art)
- parent-process (prc)
- permission (perm)
- permission-link (perm)
- permission-link (role)
- permissions (perm)
- placement (con)
- placements (stp)
- placements-link (stp)
- pooled-inputs (stp)
- pools (stp)
- pools-link (stp)
- pool-step (art)
- process (prc)
- process (prx)
- processes (prc)
- process-input (ptp)
- process-link (prc)
- process-output (ptp)
- process-template (ptm)
- process-template-link (ptm)
- process-templates (ptm)
- process-type (aut)
- process-type (prc)
- process-type (ptm)
- process-type (ptp)
- process-type (protstepcnf)
- process-type-attribute (ptp)
- process-type-link (ptp)
- process-types (ptp)
- program-status (stp)
- program-status-link (stp)
- project (prj)
- project (smp)
- project-link (prj)
- projects (prj)
- properties (prop)
- property-link (prop)
- protocol (protcnf)
- protocol (stg)
- protocol-link (protcnf)
- protocol-link (wkfcnf)
- protocol-property (protcnf)
- protocols (protcnf)
- qc-flag (art)
- qc-flag (prx)
- queue (que)
- queuefield (ptp)
- queuefield (protstepcnf)
- reagent-kit (kit)
- reagent-kit-link (ptp)
- reagent-kit-link (kit)
- reagent-kit-link (lot)
- reagent-kit-link (protstepcnf)
- reagent-kits (kit)
- reagent-label (art)
- reagent-label (stp)
- reagent-lot (lot)
- reagent-lot-link (lot)
- reagent-lot-link (stp)
- reagent-lots (lot)
- reagent-lots-link (stp)
- reagents (stp)
- reagents-link (stp)
- reagents-lots (stp)
- reagent-type (rtp)
- reagent-type-link (rtp)
- reagent-types (rtp)
- researcher (prj)
- researcher (lot)
- researcher (res)
- researcher-link (res)
- researcher-link (role)
- researchers (res)
- role (res)
- role (role)
- role-link (role)
- roles (role)
- routing (rt)
- sample (art)
- sample (smp)
- samplebase (smp)
- samplecreation (smp)
- sample-link (smp)
- samples (smp)
- setup (stp)
- setup-link (stp)
- special-type (rtp)
- stage (stg)
- stage-link (wkfcnf)
- status (art)
- status (stp)
- status (wkfcnf)
- step (stg)
- step (stp)
- step (protstepcnf)
- step-configuration (stp)
- step-creation (stp)
- step-property (ptp)
- step-property (protstepcnf)
- step-setup (ptp)
- step-setup (protstepcnf)
- style (ptp)
- style (protstepcnf)
- submitter (smp)
- technician (prc)
- technician (prx)
- technician (ptm)
- trigger-point (ptp)
- trigger-point (protstepcnf)
- trigger-status (ptp)
- trigger-status (protstepcnf)
- trigger-type (ptp)
- trigger-type (protstepcnf)
- type (cnf)
- type (udf)
- type-definition (cnf)
- type-definition (ptp)
- udfconfig-link (cnf)
- udfs (cnf)
- udtconfig-link (cnf)
- udts (cnf)
- unavailable-well (ctp)
- user (stp)
- variability-type (ptp)
- version (ver)
- versions (ver)
- workflow (stg)
- workflow (wkfcnf)
- workflow-link (wkfcnf)
- workflows (wkfcnf)
- workflow-stage (art)