Ion Torrent SDK

Release v5.12.

This document reviews all the points of interest for programmatically interfacing with Torrent Suite™ Software.

Torrent Suite™ Software Plugin System

This section describes the plugin framework and explains how to create plugins using all the available features. To understand this section, we recommend that you have at a minimum a working knowledge of python, object-oriented programming and HTML/javascript.

Getting Started with Plugins

The plugin framework is primarily an extension of the analysis pipeline and executes custom python modules (plugins) at different points in the pipeline process. There are three reasons for writing a plugin:

  1. Data Management: The transfer or backup of data to a secondary file server or remote site.
  2. Quality Assurance/Quality Control: These plugins check the quality of the data and give you access to some of the larger and transient data used in signal processing, which are eventually deleted.
  3. Application Analysis: This is broadest and most useful category which bridges the gap between general pipeline workflow and application-specific analysis and reporting.

There is nothing strict about these categories. They have no technical bearing on the functioning of the plugins other than a conceptual framework for deciding whether to use a plugin or not.

Quick Start

Enter the following python code into a file called MyPlugin.py inside a new directory called MyPlugin.

import subprocess
from ion.plugin import *


class MyPlugin(IonPlugin):
    version = "1.0.0.0"

    def launch(self, data=None):
        output = subprocess.check_output(['ls', '-l'])
        with open("status_block.html", "w") as html_fp:
            html_fp.write("<html><body><pre>")
            html_fp.write(output)
            html_fp.write("</pre></body></html>")


if __name__ == "__main__":
    PluginCLI()

Compress the MyPlugin directory (ZIP file format). See Packaging & Installation for help. Click Install or Upgrade Plugin to upload the archive on the Torrent Suite™ Software plugins page. Navigate to an existing Torrent Suite™ Software run report, click Select Plugins to Run, then select MyPlugin. The plugin code executes and the output displays in an iframe on the report.

Pipeline Overview

Plugins are fundamentally an ability to extend the functionality of the analysis pipeline. At certain stages of the pipeline execution, each of these stages is represented as a “Run Level”.

Configuration

Occasionally, you need to configure plugins before their execution. To do this, the Plugin Framework offers three different caches for storing the configurations for the two different workflows for executing a plugin.

Automated Pipeline Workflow

  • 1st Priority: Plan Configuration
  • 2nd Priority: Global Configuration

Manual Plugin Execution

  • 1st Priority: Instance Configuration
  • 2nd Priority: Global Configuration
Run Levels

One of the key attributes of any given plugin is the run level that directs the pipeline to execute the plugin at each of these stages specified in the module. It is important to remember that the same method is called in the plugin no matter what run level is currently being executed. So if you are going to use more than one run level, write the plugin code so it is conditionally based on the Run Levels.

When employing run levels, use one of the two following strategies. The conventional workflow covers almost all situations; therefore, it is the default approach.

Block Levels

When you use block-based run levels, we recommend that you use a combination of the three following run levels:

  • PRE: This stage occurs before any significant processing happens, and is sufficient for preparation.
  • BLOCK: Plugins are triggered once per block on the chip. This run level is never executed for runs that do not have block-level processing.
  • POST: This stage occurs after the analysis pipeline is completely executed. When executed, the plugin results output directory is a child directory of the normal plugin output directory named “post”.

Conventional Workflow

This strategy is the default for non-block-level specific run levels and is used in a more conventional workflow.

  • DEFAULT: Plugins are triggered at the end of pipeline processing after the four usual steps (see pipeline documentation for details).
  • LAST: Plugins are executed after all other plugins that are not “LAST” have been executed. If there is more than one, all “LAST” run level plugins run concurrently.

Internal Use Only

  • SEPARATOR: Do not use.
Run Types

Run Types define which type of data the plugin is capable of running on. This controls whether the plugin is executed on a specific report type when it is selected during planning. If no run types are defined, the plugin will be launched for thumbnail and Ion PGM™ System reports only. In order to auto-run on Ion GeneStudio™ S5 System/Ion Proton™ System reports, the plugin must include COMPOSITE in its runtypes specification.

  • COMPOSITE: Plugin will run on Ion GeneStudio™ S5 System/Ion Proton™ System report.
  • THUMB: Plugin will run on Ion GeneStudio™ S5 System/Ion Proton™ System thumbnail report.
  • FULLCHIP: Plugin will run on Ion PGM™ System report.
Dependencies

The term “dependency” is not quite accurate. This attribute ensures that when a plugin with a “dependency” is set to run at a run level, it is scheduled to run after the declared dependency that also shares that run level. If the declared dependency is not scheduled to run at the same run level, then the plugin runs without any special scheduling.

OIA Integration

Currently, the “On Instrument Analysis” (OIA) is responsible for the first two portions of the pipeline execution. The OIA does not normally interfere with plugin execution. However, if you select the PRE run level, any OIA-based workflows are executed after the signal processing step. A pure Torrent Suite™ Software implementation’s PRE step is executed before the signal processing step.

Plugin Code

You must write the code for all plugins in python, therefore a basic understanding of both python and object oriented programming is required.

In order for the plugin to function, it must inherit from the base class IonPlugin contained in the module at ion.plugin. At a minimum, the version attribute and launch method need to be overridden.

Legacy Note

Legacy plugins that use a bash script called “launch.sh” are obsolete and should not be replicated.

Naming Your Plugin

It is important to include the name of your plugin in the following:

  • The directory containing the python plugin file

  • The name of the python plugin file (not including the required .py file extension)

  • The name of the class declared within the python plugin file that derives the IonPlugin base class

    NOTE: All are case-sensitive.

Plugin Version

The version of the plugin must be a string that has the standard four-number formatting as follows:

<Major>.<Minor>.<Revision>.<Build>

Launch Method

The one required override method to implement in the plugin class is the launch method, which has only the self argument, and an unused “Data” argument with the “None” default. This method performs all the required actions to achieve the goal of the plugin as well as to produce all the results files.

Packaging & Installation

There are two supported methods for packaging and installing plugins into the system: the debian packaging system and a simple zip archive method. This section describes only the zip archive method. The debian packaging system is described elsewhere because it is more advanced.

When you create a zip package, the contents must use a file structure with a root folder that has the same name as the plugin. All other contents are a child of this root folder:

Linux Bash Shell: ‘zip -r –exclude=*.git* PluginName.zip PluginDirectory’

After you create the archive, go to http://TS_hostname/configure/plugins/ on the Torrent Suite™ Software, then click “Install or Upgrade Plugin” to submit your new archive.

Plugin Reference

Plugin Files

  • Plugin Python File: The primary file for implementing the logic contained in the plugin. The name of this file must be <PluginName>.py and be contained in the top level directory, which also has the same name as the plugin. Names are case-sensitive.
  • Configuration Interfaces: There are three different configuration interfaces, all of which are optional. If your plugin does not require any configuration to execute, you do not need to implement all of the following:
    • instance.html: If present, this page appears when a plugin is run from the Manual Launch button on the Run Report page.
    • plan.html: When you create a plan in the Plugin chevron, you have the option of launching a configuration interface for that plan. If not present, you can still select the plugin to run, but there will be no configuration data.
    • config.html: This interface is presented in the plugin configuration interface and sets up the default configuration, which is used if neither of the other two configuration caches are present.
  • Static Files: HTML files included in or generated by a plugin may need to load static assets (JS/CSS/Images). Include these files in a directory called pluginMedia in the root plugin directory. Reference the static files using the following URL pattern: /pluginMedia/<PluginName>/example.css
  • Documentation:
    • about.html: If present, this information is accessible from the plugins manage menu on the plugin page.

Base Class

All plugins must create one and only one class that inherits from the IonPlugin base class. The IonPlugin base class requires that the following attributes and methods be overridden, although some are optional.

Attributes & Properties
Attribute Name Required Type Default Description
name No string Empty Stores the name of the plugin in addition to the name of the class itself for logging.
version Yes string Empty The four number version number for the plugin.
runtypes No list(string) Empty Indicates if this plugin is used for wholechip and/or thumbnails.
features No list(string) Empty Holds a list of current features enabled for this plugin.
runlevels Yes list(string) Empty Holds a list for each run level that this plugin executes during the pipeline execution.
depends No list(string) Empty Lists all plugins which are executed before this one, if present.
major_block No boolean False If true, indicates that this plugin’s output is presented as part of the run report.
requires No list(string) [‘BAM’] Currently unused.
output No dictionary Empty Currently unused.
results No dictionary Empty Currently unused.
exit_status No int Empty Currently unused.
context No dictionary Empty Currently unused.
blockcount No int 0 Currently unused.
plugin No Plugin None Currently unused.
analysis No Result None Currently unused.
pluginresult No PluginResult None Currently unused.
startplugin No dictionary None This returns “an” in the memory dictionary of the startplugin.json.
Methods
Method Name Required Return Type Description
launch_wrapper No None Do not use.
generate_output No None Currently unused.
pre_block No None Currently unused.
post_block No None Currently unused.
pre_launch No boolean Run prior to launch. Return False if you do not want the plugin to execute.
post_launch No None Currently unused.
launch Yes boolean If true, this indicates that this plugin’s output is presented as part of the run report.
getUserInput No None Currently unused.
barcodetable_columns No list This method returns a list of columns to be used to generate the plugin barcodes table ui.
barcodetable_data No dictionary This returns a dictionary to populate the contents of the plugin barcodes table ui.
get_restobj No dictionary This method returns a dictionary based on a REST API function call.
Enums

Import the enumerations from the ion.plugin.constants module. Since enumerations are not supported in python 2, you implement them by creating a type with static members according to the following scheme.

  • Feature
    • EXPORT: Used to indicate that this plugin is run last because it exports data.
  • Run Types
    • COMPOSITE: Block based chip runs.
    • THUMB: A thumbnail result.
    • FULLCHIP: Ion PGM™ System Full chip results.
  • Run Levels
    • PRE
    • DEFAULT
    • BLOCK
    • POST
    • SEPARATOR
    • LAST

Execution Environment

When you execute plugins, they are controlled with a script which is written to the results output directory call ion_plugin_*<Plugin Name>*_launch.sh. The plugin framework creates this file and directs the Grid Engine to execute this as the entry point for the plugin execution. The file handles the following:

  • Updating the status in the database to be reflected in the run results page
  • Setting up environmental variables (these are used in legacy plugins)
  • Setting the umask to 0000
  • Preventing core files from being written from core dumps
  • Implementing the use of the output.json to create output (currently incomplete)
Run Levels

To use the run levels, you must assign them to your plugin class. If none are assigned the plugin will use DEFAULT runlevel. The run levels, block and conventional, are described in the Getting Started section. While it is technically possible, we do not recommend that you assign run levels from both groups concurrently.

Clusters

To accommplish clustering, the execution of the plugins is queued through a grid engine which, for single servers, is executed on the same computer as the one hosting the web site. In a cluster, the plugins are run only on the computer nodes and never on the head node. Consider the following when writing a plugin:

  • The plugin is not run on the head node, so any references to “localhost” are incorrect. For example, if you are making a REST call and you have hard-coded the domain name of the url to be localhost, this attempts to call the REST API from the compute node, which results in an error. Instead, ensure that any REST API calls use the protocol and domain name in the startplugin.json contents runinfo->net_location.
  • To distribute the executable code to the compute nodes, the system piggy-backs on the commonly shared NFS mount “/results” by creating a child folder at “/results/plugins/”. This means that the stability of the plugin framework is going to be intimately tied to the stability of the network. Ensure that the connection to the results folder is as stable and redundant as reasonably possible.
Dependencies

Due to the method of distribution of plugin logic over NFS mounts, there are very few libraries on the compute nodes during run time. To work around this, package all dependencies (beyond the standard python libraries) into the install file with the core logic so they are also installed into the /results/plugins/<Plugin Name> directory on the NFS mount to be redistributed out to the compute nodes.

REST API Extensions

The plugin framework currently gives you an option of extending the REST API with custom endpoints by implementing a python file in the root of the plugin folder, which must have the name “extend.py”. By implementing a method in this module with a single dictionary argument named “bucket”, which is described below, the extension is exposed through the REST API for execution using the following url:

http(s)://{HOSTNAME}/rundb/api/v1/plugin/{PLUGIN}/extend/{METHOD_NAME}

bucket["request_get"] = request.GET
# assume json
if request.method == "POST":
    bucket["request_post"] = json.loads(request.body)
bucket["user"] = request.user
bucket["request_method"] = request.method
bucket["name"] = plugin.name
bucket["version"] = plugin.version
# not sure if we want this or not, keep it for now
bucket["config"] = plugin.config

Configuration

In many situations for plugins, there needs to be some sort of configuration declared before the plugin run time. This means that the plugin needs to implement an interface to allow users to configure it. Users can select from three configuration options in Torrent Suite™ Software: global, plan, and manual. The HTML pages can reference static assets, see Plugin Files.

Global Configuration

Include an HTML file named config.html in your root plugin directory to enable global configuration. This HTML window appears in an iframe on the global plugin configuration page at /configure/plugins/. Click the gear_icon (Settings) next to a plugin, then select “Configure”.

Reading Configuration

Read from the plugin api endpoint. “/rundb/api/v1/plugin/” + TB_plugin.pk + “/” Or Read the window.TB_plugin js variable.

Writing Configuration

Write to the plugin api endpoint with a PUT request. “/rundb/api/v1/plugin/” + TB_plugin.pk + “/”

Plan Configuration

Include an HTML file named plan.html in your root plugin directory to enable plan configuration. This HTML window appears in an iframe on the planning screen plugin configuration page at /plan/page_plan_plugins/. Click the checkbox next to a plugin, then select “Configure”.

Reading Configuration

Read the window.TB_plugin js variable, then wait for window.restoreForm to be called with the last data passed to serializeForm.

Writing Configuration

window.serializeForm is called by the parent frame to gather the current configuration when users click “Save” in the parent frame.

Manual Configuration

Include an HTML file named instance.html in your root plugin directory to enable manual configuration. The HTML window appears in an iframe on the report page at /report/<ID>/. Click “Select Plugins To Run”, then select a plugin.

Reading Configuration

Read the window. TB_plugin js variable.

Writing Configuration

Write to the results endpoint with a POST request. “/rundb/api/v1/results/” + TB_result + “/plugin/” Then call the following to close the iframe. window.parent.$.colorbox.close()

Barcode Table UI

Plugin Barcode Table UI is an optional service provided by the plugin framework. It allows plugins to generate a simple GUI that can be used to select which barcodes to process and specify per-barcode parameters. The table is similar to the barcode sample table in plan screen with one row per barcode and columns specified by the plugin. This UI is provided for manual plugin launch only and is an opt-in service for plugins to use if desired.

Defining table columns

def barcodetable_columns(self):
    # plugin class method to specify which columns to display
    # inputs: none
    # outputs: list of columns and options to show
    columns_list = [
        {
            "field": "selected",
            "editable": True
        },
        {
            "field": "barcode_name",
            "editable": False
        },
        {
            "field": "sample",
            "editable": False
        },
        ...
    ]
    return columns_list

List of available columns can be retrieved from framework by executing the following command line:

python /results/plugins/<myPlugin>/<myPlugin>.py --bctable-columns

Providing default table contents (optional)

Plugin barcode table will be populated on page load from existing samples information entered during run planning. Additionally, the plugin can modify or augment this initial data if it specifies the following function:

def barcodetable_data(self, data, planconfig={}, globalconfig={}):
    # plugin class method to specify default table contents
    # inputs:
    #    data - same structure as in barcodes.json
    #    planconfig - plugin configuration from planning (plan.html)
    #    globalconfig - plugin global configuration (config.html)
    # outputs:
    #    data, modified as needed
    return data

Changing instance.html

The plugin’s instance.html must add the contents of barcodes table to the plugin data before POSTing it to the results API. This data will be written to startplugin.json file at plugin runtime under “pluginconfig” section.

Helper TB_plugin_functions js variable is available to interact with the barcode table UI:

  • TB_plugin_functions.get_plugin_barcodetable()
    returns table data as json object
  • TB_plugin_functions.update_plugin_barcodetable(data)
    can be used to update the table with data json object
  • TB_plugin_functions.plugin_barcodetable_div
    barcode table DIV element

Input Files

The plugin framework creates two different files for general plugin consumption as its inputs. The variables, which are communicated to the plugin from the framework, are spread across two separate JSON files.

barcodes.json

This file has all the references required for iterating through all of the barcodes for a particular run.

Developer Option

By default all the barcodes where the filtered key is true are not included in the barcodes.json file. You can overwrite this behavior by adding “PLUGINS_INCLUDE_FILTERED_BARCODES = True” to the local_settings.py and restarting the ionPlugin service.

nonbarcoded: {
    aligned <bool>: Flags if the reads in bam_file are aligned to the reference genome.
    bam_file <string>: Name of reads file. (May or may not be be aligned to the reference.)
    bam_filepath <string>: Full file path to bam_file on the local torrent server. (File may not exist if read_count is 0.)
    control_sequence_type <string>: Currently either ERCC Mix 1 or ERCC Mix 2 and only defined in plan screen for RNA Sequencing. (Purpose unspecified.)
    filtered <bool>: Flags if the barcode passed the |TS| analysis pipeline filtering criteria.
    hotspot_filepath <string>: Full file path to HotSpot target regions (BED) file on the local torrent server. ("" if not used.)
    genome_urlpath <string>: URL path used to specify the genome for applications like IGV. Typically the path to the FASTA file on the local torrent server.
    nucleotide_type <string>: Currently either DNA or RNA depending on application. Primarily used to distinguish barcodes with AmpliSeq DNA+RNA runs.
    read_count <int>: Total number of barcode-assigned reads in bam_file (prior to alignment).
    reference <string>: Common (short) name of the reference genome used in the pipeline for this barcode, e.g. hg19
    reference_fullpath <string>: Full file path to the to the reference sequences in FASTA format on the local torrent server. (May be "" for unaligned reads.)
    sample <string>: Name of the sample associated with this barcode. (May be associated with multiple barcodes.)
    sample_id <string>: Sample identification code associated with sample.
    target_region_filepath <string>: Full file path to target regions (BED) file on the local torrent server. ("" if not used.)
}
barcode_name: {
    aligned <bool>: Flags if the reads in bam_file are aligned to the reference genome.
    bam_file <string>: Name of reads file. (May or may not be be aligned to the reference.)
    bam_filepath <string>: Full file path to bam_file on the local torrent server.
    barcode_adapter <string>: DNA adapter sequence used to separate barcode_sequence from sequenced read.
    barcode_annotation <string>: User-specified annotation for this barcode.
    barcode_description <string>: Description text associated with this barcode.
    barcode_index <int>: Index of barcode in the barcode set, starting at 1.
    barcode_name <string>: Name of the barcode in the barcode set (barcode_name).
    barcode_sequence <string>: DNA sequence used to identify this barcode.
    barcode_type <string>: User-specified type for this barcode.
    control_sequence_type <string>: Currently either ERCC Mix 1 or ERCC Mix 2 and only defined in plan screen for RNA Sequencing. (Purpose unspecified.)
    filtered <bool>: Flags if the barcode passed the |TS| analysis pipeline filtering criteria.
    hotspot_filepath <string>: Full file path to HotSpot target regions (BED) file on the local torrent server. ("" if not used.)
    genome_urlpath <string>: URL path used to specify the genome for applications like IGV. Typically the path to the FASTA file on the local torrent server.
    nucleotide_type <string>: Currently either DNA or RNA depending on application. Primarily used to distinguish barcodes with AmpliSeq DNA+RNA runs.
    read_count <int>: Total number of barcode-assigned reads in bam_file (prior to alignment).
    reference <string>: Common (short) name of the reference genome used in the pipeline for this barcode, e.g. hg19
    reference_fullpath <string>: Full file path to the to the reference sequences in FASTA format on the local torrent server. (May be "" for unaligned reads.)
    sample <string>: Name of the sample associated with this barcode. (May be associated with multiple barcodes.)
    sample_id <string>: Sample identification code associated with sample.
    target_region_filepath <string>: Full file path to target regions (BED) file on the local torrent server. ("" if not used.)
}

Example barcodes.json for a barcoded run (TSS v5.0.3)
{
   "IonXpress_001":{
      "aligned":true,
      "bam_file":"IonXpress_001_rawlib.bam",
      "bam_filepath":"/results/analysis/output/Local/with_many_samples_017/IonXpress_001_rawlib.bam",
      "barcode_adapter":"GAT",
      "barcode_annotation":"",
      "barcode_description":"",
      "barcode_index":1,
      "barcode_name":"IonXpress_001",
      "barcode_sequence":"CTAAGGTAAC",
      "barcode_type":"",
      "control_sequence_type":"",
      "filtered":false,
      "genome_urlpath":"/auth/output/tmap-f3/hg19/hg19.fasta",
      "hotspot_filepath":"",
      "nucleotide_type":"DNA",
      "read_count":20,
      "reference":"hg19",
      "reference_fullpath":"/results/referenceLibrary/tmap-f3/hg19/hg19.fasta",
      "sample":"First Sample name",
      "sample_id":"",
      "target_region_filepath":""
   },
   "IonXpress_033":{
      "aligned":true,
      "bam_file":"IonXpress_033_rawlib.bam",
      "bam_filepath":"/results/analysis/output/Local/with_many_samples_017/IonXpress_033_rawlib.bam",
      "barcode_adapter":"GAT",
      "barcode_annotation":"",
      "barcode_description":"",
      "barcode_index":33,
      "barcode_name":"IonXpress_033",
      "barcode_sequence":"TTCTCATTGAAC",
      "barcode_type":"",
      "control_sequence_type":"",
      "filtered":false,
      "genome_urlpath":"/auth/output/tmap-f3/hg19/hg19.fasta",
      "hotspot_filepath":"",
      "nucleotide_type":"DNA",
      "read_count":231321,
      "reference":"hg19",
      "reference_fullpath":"/results/referenceLibrary/tmap-f3/hg19/hg19.fasta",
      "sample":"Second Sample Name",
      "sample_id":"",
      "target_region_filepath":""
   },
   "IonXpress_034":{
      "aligned":true,
      "bam_file":"IonXpress_034_rawlib.bam",
      "bam_filepath":"/results/analysis/output/Local/with_many_samples_017/IonXpress_034_rawlib.bam",
      "barcode_adapter":"GAT",
      "barcode_annotation":"",
      "barcode_description":"",
      "barcode_index":34,
      "barcode_name":"IonXpress_034",
      "barcode_sequence":"TCGCATCGTTC",
      "barcode_type":"",
      "control_sequence_type":"",
      "filtered":false,
      "genome_urlpath":"/auth/output/tmap-f3/hg19/hg19.fasta",
      "hotspot_filepath":"",
      "nucleotide_type":"",
      "read_count":267041,
      "reference":"hg19",
      "reference_fullpath":"/results/referenceLibrary/tmap-f3/hg19/hg19.fasta",
      "sample":"",
      "sample_id":"",
      "target_region_filepath":""
   }
}

Usage Notes

  1. For consistency, we recommend that you iterate and present barcodes in order of increasing barcode_index value.
  2. For default plugin configurations, barcodes with filtered == true are not output. (A plugin option to include these may become available soon.)
  3. Barcodes with a sample name provided (i.e. not “”) are represented with filtered == false, regardless of read_count value.
  4. The bam_filepath value is set to the expected location of the bam_file on the Torrent Server. Barcodes with read_count == 0 may not have a bam_file saved, so you can expect a failure to find the bam_file at bam_filepath. If read_count > 0 then a missing bam_file should be treated as an unexpected error. (This would most likely be a result of automated deletion of old files to make space on the server.)
  5. Although control_sequence_type and nucleotide_type appear to be general attributes, at 5.0.3 these are only defined for barcodes that were specified (associated with samples) in the plan. For nonbarcoded elements or barcodes with no sample data that had sufficient reads. these attributes have the value “”.
startplugin.json

This is the primary file to get all of the information regarding the file.

{
    chefSummaary <dictionary> : This optional section will convey information regarding the chef parameters used. {
    }
    datamanagement <dictionary>: Holds information regarding the data management state of the run. {
        Basecalling Input <bool>: This will indicate if the basecalling information is available for use.
        Intermediate Files <bool>: This will indicate if the intermediate files are available for use.
        Output Files <bool>: This will indicate if the output files are available for use.
        Signal Processing Input <bool>: This will indicate if the signal processing information is available for use.
    }
    expmeta <dictionary>: This is an aggregate of data contained in the expMeta.dat file and the ion_params_00.json file. {
        analysis_date <date>: Gets the time of results analysis based on the last modified time stamp on the ion_params_00.json file.
        barcodeId <string>: The barcode kit name from the experiment analysis settings.
        chipBarcode <string>: The barcode of the chip derived from the ion_params_00.json->exp_json->chipBarcode... mostly.
        chiptype <string>: This is the chip which was used to do the run.
        flowOrder <string>: The flow order used to sequence the run.
        instrument <string>: The name (not type) of the instrument which was used to do the sequencing.
        notes <string>: Any notes which may have been included in the experiment.
        project <string>: A list of all of the projects which this result may belong to.
        results_name <string>: The name of the results that will be processed.
        run_date <datetime>: The date/time stamp of the experiment.
        run_flows <int>: The number of flows used in the run.
        run_name <string>: The name of the run as opposed to the name of the result.
        runid <string>: A short identifies for each id.
        sample <string>: This is the name of the first sample which is associated with this run.
        output_file_name_stem <string>: This is a merger of the experiment name and the results name.
    }
    globalconfig <dictionary>: This section is for the global environment of the result. {
        MEM_MAX <string>: Hardcoded to always read "15G".
        debug <int>: Hardcoded to always read 0.
    }
    plan <dictionary>: This section is where all of the elements of the experiment plan are stored. {
        barcodeId <string>: The barcode kit name from the experiment analysis settings.
        barcodedSamples <dictionary>: This is a dictionary of all of the samples information and the barcodes they are associated with. {
            -Sample Name- <dictionary>: The name of the sample {
                barcodeSampleInfo <dictionary>: Contains the information for the barcodes. {
                    -Barcode ID- <dictionary>: {
                        controlSequenceType <string>: The name of the kit used for the controls for specific per Sample applications.
                        controlType <string>: The experimental control used for this sample. eg (No Template Control)
                        description <string>: Free form description field.
                        externalId <string>: Free form id from any external sources
                        hotSpotRegionBedFile <string>: The name of the hotspot data used for this sample.
                        nucleotideType <string>: This will be the nucleotideType used for this barcode (DNA/RNA/Fusions).
                        reference <string>: The name of the reference
                        sseBedFile <string>: The SSE Bed file reference.
                        targetRegionBedFile <string>: The name of the target region data used for this sample.
                    }
                }
                barcodes <list>: A list of strings which should only have one entry equal to the single dictionary key for barcodeSampleInfo.
            }
        }
        bedfile <string>: The name of a bed file used in this plan.
        controlSequencekitname <string, nullable>: The name of the kit used for the controls.
        librarykitname <string>: The name of the library kit used in the plan.
        planName <string>: The name of the plan used in the run.
        regionfile <string>: The file to define regions for this plan.
        reverse_primer <string>: The reverse primer used in the plan.
        runMode <string>: The run mode value of 'SingleRead', 'PairedEnd' or 'Undefined'
        runType <string>: The type of sequencing for this plan, for example "GENS"
        runTypeDescription <string> : A plain english description of the run type, for example "Generic Sequencing".
        sampleGrouping <dictionary>: A representation of the sample group.
        samplePrepKitName <string>: The name of the sample prep kit.
        sampleSet_name <string>: The name of the sample set.
        sampleSet_planIndex <int>: deprecated
        sampleSet_planTotal <int>: deprecated
        sampleSet_uid <string>: deprecated
        sampleTubeLabel <string>: The barcode sample prep label on the sample tube.
        sequencekitname <string>: The name of the kit used for sequencing.
        templatingKitName <string>: The name of the kit used for templating.
        threePrimeAdapter <string>: The sequence of the three prime adapter being used.
        username <string>: The name of the user who created the plan.
    }
    runinfo <dictionary>: Information regarding the sequencing run. {
        alignment_dir <string>: The path of the directory with the alignment data.
        analysis_dir <string>: The path of the directory using the Analysis data.
        api_key <string>: The api key which can be used to access the
        api_url <string>: The base directory url for *most* of the rest api calls.
        barcodeId <string>: The identifier for the barcoding kit.
        basecaller_dir <string>: The path to the directory with the basecaller information.
        chipDescription <string>: The description of the chip used for sequencing.
        chipType <string>: The type of the chip used for sequencing.
        library <string>: The reference library used.
        library_key <string>: The key sequence to the library.
        net_location <string>: The url to the master node used for the run.
        pk <int>: The primary key for this run in the database.
        platform <string>: The type of sequencer being used.
        plugin <dictionary>: This section describes the run parameters for this plugin in this run. {
            depends <list>: The list of dependency plugins for this run.
            features <list>: The list of features for this plugin.
            hold_jid <list>: A list of SGE job id's which this process was asked to hold on.
            id <int>: The database pk for the id of the plugin.
            name <string>: The name of this plugin.
            path <string>: The path to the plugin executable directory.
            pluginconfig <dictionary>: This is a freeform dictionary which contains the global configuration used for this plugin run.
            pluginresult <int>:  The database primary key for the plugin results entry.
            results_dir <string>: The directory path to the plugin result output.
            runlevel <list>: The list of run levels this plugin has been asked to run at.
            runtype <list>: This list of run types that this plugin can be run on.
            userInput <dictionary>: This is a freeform dictionary which contains the run configuration used for this plugin run.
            version <string>: The version of the plugin running.
        }
        plugin_dir <string>: The path to the plugin executable directory.
        plugin_name <string>: The name of this plugin.
        pluginresult <int>: The database primary key for the plugin results entry.
        raw_data_dir <string>: The path to the directory which contains the raw observational data.
        report_root_dir <string>: The path to the directory of the report.
        results_dir <string>: The path to the directory of the plugin results.
        sigproc_dir <string>: The path to the directory of the signal processing data.
        systemType <string>: The type of sequencer being used.
        testfrag_key <string>: The sequence key to the test fragments.
        tmap_version <string>: The version of the tmap program being used.
        url_root <string>: The file path to the directory of the results data. (not a url)
        username <string>: The user who is performing the run.
    {
    runplugin <dictionary>: The exact parameters used for this plugin run. {
        blockId <string>: The id for the block currently being processed.  Blank if not a block process.
        block_dirs <list>: A list of all of the directories of all of the block data.
        numBlocks <int>: The total number of blocks processed.
        run_mode <string>: The run mode that this is being processed in, either 'pipeline' or 'manual'.
        run_type <string>: The type of the run.  Thumbnail, wholechip or composite.
        runlevel <string>: The current run level being run.
    }
    sampleinfo <dictionary>: A dictionary of information used to convey information regarding the samples. {
        SampleName <dictionary>: The name of the sample. {
            attributes <dictionary>: Any attributes {
            }
            description <????>: A free form description of the sample.
            displayedName <string>: The name of the sample.
            externalId <string>: Any remote identifier used for the sample.
            name <string>: The name of the sample without whitespace.
        }
    pluginconfig <dictionary>: This is a freeform dictionary which contains the run configuration used for this plugin run. {
    }
}

Example
{
    "datamanagement": {
        "Basecalling Input": true,
        "Intermediate Files": true,
        "Output Files": true,
        "Signal Processing Input": true
    },
    "expmeta": {
        "analysis_date": "2015-09-02",
        "barcodeId": "",
        "chipBarcode": "AA0026665",
        "chiptype": "\"314R\"",
        "flowOrder": "TACGTACGTCTGAGCATCGATCGATGTACAGC",
        "instrument": "PGM_test",
        "notes": "",
        "project": "SampleData",
        "results_name": "Auto_user_CB1-42-r9723-314wfa-tl_36",
        "run_date": "2011-04-07T12:44:38Z",
        "run_flows": 260,
        "run_name": "R_2011_04_07_12_44_38_user_CB1-42-r9723-314wfa-tl",
        "runid": "ZN2MB",
        "sample": "e5272-wfa-l165"
    },
    "globalconfig": {
        "MEM_MAX": "15G",
        "debug": 0
    },
    "plan": {
        "barcodeId": "",
        "barcodedSamples": {},
        "bedfile": "",
        "controlSequencekitname": null,
        "librarykitname": "Ion Xpress Plus Fragment Library Kit",
        "planName": "CopyOfSystemDefault_R_2011_04_07_12_44_38_user_CB1-42-r9723-314wfa-tl",
        "regionfile": "",
        "reverse_primer": null,
        "runMode": "single",
        "runType": "GENS",
        "runTypeDescription": "",
        "sampleGrouping": null,
        "samplePrepKitName": null,
        "sampleSet_name": null,
        "sampleSet_planIndex": 0,
        "sampleSet_planTotal": 0,
        "sampleSet_uid": null,
        "sampleTubeLabel": null,
        "sequencekitname": "IonPGM200Kit-v2",
        "templatingKitName": "Ion PGM Template OT2 200 Kit",
        "threePrimeAdapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
        "username": string
    },
    "pluginconfig": {},
    "runinfo": {
        "alignment_dir": "/results/analysis/output/Disabled/Auto_user_CB1-42-r9723-314wfa-tl_36_001",
        "analysis_dir": "/results/analysis/output/Disabled/Auto_user_CB1-42-r9723-314wfa-tl_36_001",
        "api_key": "9516e00c170496012b6df5810431aca7ac558163",
        "api_url": "http://ion-ts-vm/rundb/api",
        "barcodeId": "",
        "basecaller_dir": "/results/analysis/output/Disabled/Auto_user_CB1-42-r9723-314wfa-tl_36_001/basecaller_results",
        "chipDescription": "",
        "chipType": "\"314R\"",
        "library": "e_coli_dh10b",
        "library_key": "TCAG",
        "net_location": "http://ion-ts-vm",
        "pk": 1,
        "platform": "pgm",
        "plugin": {
            "depends": [],
            "features": [],
            "hold_jid": [],
            "id": 11,
            "name": "FilterDuplicates",
            "path": "/results/plugins/FilterDuplicates",
            "pluginconfig": {},
            "pluginresult": 5,
            "results_dir": "/results/analysis/output/Disabled/Auto_user_CB1-42-r9723-314wfa-tl_36_001/plugin_out/FilterDuplicates_out.5",
            "runlevel": [],
            "runtype": [
                "composite",
                "wholechip",
                "thumbnail"
            ],
            "userInput": "",
            "version": "5.0.0.0"
        },
        "plugin_dir": "/results/plugins/FilterDuplicates",
        "plugin_name": "FilterDuplicates",
        "pluginresult": 5,
        "raw_data_dir": "/results/PGM_test/cropped_CB1-42",
        "report_root_dir": "/results/analysis/output/Disabled/Auto_user_CB1-42-r9723-314wfa-tl_36_001",
        "results_dir": "/results/analysis/output/Disabled/Auto_user_CB1-42-r9723-314wfa-tl_36_001/plugin_out/FilterDuplicates_out.5",
        "sigproc_dir": "/results/analysis/output/Disabled/Auto_user_CB1-42-r9723-314wfa-tl_36_001/sigproc_results",
        "systemType": "pgm",
        "testfrag_key": "ATCG",
        "tmap_version": "tmap-f3",
        "url_root": "/output/Disabled/Auto_user_CB1-42-r9723-314wfa-tl_36_001",
        "username": "ionadmin"
    },
    "runplugin": {
        "blockId": "",
        "block_dirs": [
            "."
        ],
        "numBlocks": 1,
        "run_mode": "manual",
        "run_type": "wholechip",
        "runlevel": "default"
    },
    "sampleinfo": {
        "e5272-wfa-l165": {
            "attributes": {},
            "description": null,
            "displayedName": "e5272-wfa-l165",
            "externalId": "",
            "name": "e5272-wfa-l165"
        }
    }
}
Seq Files (BAMs)

The actual sequence information is a critical portion of all of the plugins running information. When you attempt to access them, refer to the barcodes.json file for references to their path in the “bam_filepath” key.

Output Files

The primary output of all of the plugins is the report HTML file, which is produced by the plugin. Name this file *_block.html or *_block.php. There can be any number of them, and they are all displayed in separate iFrames. If plugin output doesn’t contain a _block.html or _block.php file then all HTML/PHP files in the plugin result folder will be shown as links in the plugin section.

Additionally, the SGE produces a log file for recording the standard output of the plugin execution, which is called drmaa_stdout.txt. This contains all the information printed from the controlling script, including the standard output of the plugin itself, and is a primary source of information for debugging.

See Rendering Templates for an example using HTML templates. This usually results in cleaner code than assembling large strings or multiple-file writes.

File Permissions

The SGE executes all of the plugins as the user ‘ionian’ to perform the execution. All files produced have both the owner and group of ionian and full read/write access to the plugin result directory. This also includes the ability to create new directories. The plugins have only read access to all other files, most notably the file in the run results directory.

Upgrades

When upgrading the plugins, after all of the changes have been made to the logic of plugin, all you need to do is to increment the version of the plugin and repackage the plugin for deployment.

Plugin Examples

This section has a very basic example plugin and its code.

Basic Plugin

This plugin goes through the explog and presents a few entries in the plugin output. It produces an HTML output but does not take any parameters.

#!/usr/bin/python
# Copyright (C) 2018 Thermo Fisher Scientific, Inc. All Rights Reserved

#
# Samples: LogParser
# plugin demonstrating simple log parsing ability
#

import json
import os
from django.utils.functional import cached_property
from ion.plugin import *


class LogParser(IonPlugin):
    # The version number for this plugin
    version = "5.4.0.0"

    # this plugin can run on fullchip runs, thumbnail runs, and composite (merged via project page) runs
    # when this plugin is manually launched, only the 'launch' method is called
    runtypes = [RunType.FULLCHIP, RunType.THUMB, RunType.COMPOSITE]

    # specify when the plugin is called.  For log parsing, stay simple and just get called when the run completes.
    # the plugin can also be called before the run starts, at the block level, or after all other default plugins run
    runlevels = [RunLevel.DEFAULT]

    # a simple cached version of the start plugin property
    @cached_property
    def startplugin_json(self):
        return self.startplugin

    def read_explog(self):
        """This method reads and outputs an array of colon-delimited key/value pairs from the explog_final.txt"""

        path = os.path.join(self.startplugin_json['runinfo']['raw_data_dir'], "explog_final.txt")
        if not os.path.exists(path):
            raise Exception("explog_final.txt missing")

        # parse the log file for all of the values in a colon-delimited parameter
        data = dict()
        for line in open(path):
            # accommodates formatting issues in explog
            datum = line.split(":", 1)
            if len(datum) == 2:
                key, value = datum
                data[key.strip()] = value.strip()

        return data

    def launch(self, data=None):
        """This is the primary launch method for the plugin."""

        na = '<strong>NA</strong>'
        # creates a results object that is written out later.  This holds data that can be scrapped by a LIMS system,
                    and will be part of the |TS| database
        exp_log_data = self.read_explog()
        results_json = {
            'Project': exp_log_data.get('Project', None) or na,
            'Sample': exp_log_data.get('Sample', None) or na,
            'Library': exp_log_data.get('Library', None) or na,
        }

        # open up an HTML file to dump interesting log file findings to
        with open(self.startplugin_json['runinfo']['results_dir'] + '/LogParser_block.html', 'w') as html_handle:
            html_handle.write('<html><body>')
            html_handle.write("Project is: %s<br \>" % results_json['Project'])
            html_handle.write("Sample is: %s<br \>" % results_json['Sample'])
            html_handle.write("Library is: %s<br \>" % results_json['Library'])
            html_handle.write('</body></hmtl>')

        # write out our results json object
        with open(self.startplugin_json['runinfo']['results_dir'] + '/results.json', 'w') as results_handle:
            json.dump(results_json, results_handle, indent=4)

        return True

# Devel use - running directly
if __name__ == "__main__":
    PluginCLI()
Plugin which uses a subprocess
#!/usr/bin/python
# Copyright (C) 2018 Thermo Fisher Scientific, Inc. All Rights Reserved

#
# Samples: LogParser
# plugin demonstrating simple log parsing ability
#

import json
import os
from django.utils.functional import cached_property
from ion.plugin import *
from subprocess import check_output


class CallSubprocessExample(IonPlugin):
    # The version number for this plugin
    version = "5.4.0.0"

    # this plugin can run on fullchip runs, thumbnail runs, and composite (merged via project page) runs
    # note that when the plugin is manually launched, only the 'launch' method will be called
    runtypes = [RunType.FULLCHIP, RunType.THUMB, RunType.COMPOSITE]

    # specify when the plugin is called.  For log parsing, stay simple and just get called when the run completes.
    # but can also be called before the run starts, at the block level, or after all other default plugins run
    runlevels = [RunLevel.DEFAULT]

    # a simple cached version of the start plugin property
    @cached_property
    def startplugin_json(self):
        return self.startplugin

    def launch(self, data=None):
        """This is the primary launch method for the plugin."""

        path_to_executable = "MyExecutable"
        arg1 = 'First Argument'
        arg2 = 'Second Argument'
        results = check_output([path_to_executable, arg1, arg2], cwd=self.startplugin_json['runinfo']['plugin']['path'])

        return True

# Devel use - running directly
if __name__ == "__main__":
    PluginCLI()

Accessing Barcode Data

#!/usr/bin/python
# Copyright (C) 2018 Thermo Fisher Scientific, Inc. All Rights Reserved

#
# Samples: LogParser
# plugin demonstrating simple log parsing ability
#

import json
import os
from django.utils.functional import cached_property
from ion.plugin import *
from subprocess import check_output


class BarcodesExample(IonPlugin):
    # The version number for this plugin
    version = "5.4.0.0"

    # this plugin can run on fullchip runs, thumbnail runs, and composite (merged via project page) runs
    # note that when the plugin is manually launched, only the 'launch' method will be called
    runtypes = [RunType.FULLCHIP, RunType.THUMB, RunType.COMPOSITE]

    # specify when the plugin is called.  For log parsing, stay simple and just get called when the run completes.
    # but can also be called before the run starts, at the block level, or after all other default plugins run
    runlevels = [RunLevel.DEFAULT]

    # a simple cached version of the start plugin property
    @cached_property
    def startplugin_json(self):
        return self.startplugin

    @cached_property
    def barcodes_json:
        with open('barcodes.json', 'r') as barcodes_handle:
            return json.load(barcodes_handle)

    def launch(self, data=None):
        """This is the primary launch method for the plugin."""

        for barcode_name, barcode_values in self.barcodes_json.iteritems():
            # do you work per barcode here!
            print("Barcode Name: " + barcode_name)
            print("Bam File: " + barcode_values['bam_file']

        return True

# Devel use - running directly
if __name__ == "__main__":
    PluginCLI()

Using the REST API

import json
import requests
api_response = requests.get('http://HOSTNAME/APPNAME/api/v1/APIENDPOINT/?ARG1=VAL1&pluginresult=self.startplugin['runinfo']['pluginresult']&api_key=' + self.startplugin['runinfo']['api_key'])
api_response.raise_for_status()
api_json_response = json.loads(api_response.content)

Note: api-key is tied to the specific plugin run so the system must also get which “pluginresult” is sending the API request.

Example 1: How to get the installed annotation files during the plugin execution?

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (C) 2018 Thermo Fisher Scientific, Inc. All Rights Reserved

import os
import sys
import requests
import json

from ion.plugin import RunType, PluginCLI, IonPlugin

API_VER = '/v1'

class PluginApiTest(IonPlugin):
    """
       This will make REST api call to get the installed annotation files
       with 'api_key' corresponding to the specific plugin run
    """

    version = "1.0"
    runtypes = [RunType.THUMB, RunType.FULLCHIP]

    def launch(self):
        sp_json_fpath = os.path.join(
            os.environ.get('RESULTS_DIR', ''),
            'startplugin.json'
        )

        with open(sp_json_fpath, 'r') as sp_fh:
            sp_json = json.load(sp_fh)

        endpoint = '/content'
        auth_params = {
            'api_key': sp_json['runinfo']['api_key'],
            'pluginresult': sp_json['runinfo']['pluginresult'],
        }
        query_params = {
            'type': 'Annotation'
        }
        request_params = {}
        request_params.update(auth_params)
        request_params.update(query_params)

        url = sp_json['runinfo']['api_url'] + API_VER + endpoint
        resp = requests.get(url, params=request_params)
        if resp:
            print(resp.url)
            print(resp.json())
            sys.exit(0)
        else:
            print(resp.status_code)
            sys.exit(1)


if __name__ == "__main__":
    PluginCLI()

Example 2: Use the below query_params to list all the files of mm10 auxiliary references for RNASeqAnalysis. Please note the type of camelcase, AuxiliaryReference.

...
query_params = {
    'application_tags__icontains' : 'RNA',
    'extra':'mm10',
    'type' :'AuxiliaryReference'
}
...

Displaying Progress

When displaying progress, this needs to be manually updated by re-writing the *_block.html file intermittently during the process. Here is a simple example of how to construct a method to do this.

...
def update_progress(self, current_progress, max_progress)
    with open(self.startplugin['runinfo']['results_dir'] + '/progress_block.html', 'w') as html_handle:
            html_handle.write('<html><body>')
            html_handle.write("The current progress is %d of %d" %(current_progress, max_progress))
            html_handle.write('</body></hmtl>')
...

Rendering Templates

When outputting HTML files, using templates can be cleaner than assembling long strings. Below is an example of using Django templates. This example uses an HTML template named progress_block_template.html inside a templates directory inside the plugins root directory.

from django.conf import settings
from django.template.loader import render_to_string

settings.configure(TEMPLATE_DIR=self.startplugin["runinfo"]["plugin"]["path"] + '/templates')

with open(self.startplugin['runinfo']['results_dir'] + '/progress_block.html', 'w') as html_handle:
    html_handle.write(render_to_string("progress_block_template.html", {"current_progress": 54}))

Torrent Suite™ Software REST API

This section describes all of the REST API end points that Torrent Suite™ Software makes available and the ways in which you access them.

Getting Started with the API

API Overview

Our API is RESTful and HTTP based. All resources use HTTP standard verbs return JSON data.

The main API endpoint for Torrent Suite™ Software is /rundb/api/v1/. This endpoint returns a JSON object containing information for each resource available from the API. To see each resource’s list endpoint, go to /rundb/api/v1/resource-name/ . To see each resource’s schema, go to /rundb/api/v1/resource-name/schema/.

Authentication

To use the API you need to authenticate as an existing Torrent Suite™ Software user. To see API keys for each Torrent Suite™ Software user, go to /admin/tastypie/apikey/ . You must include an API key with every API request. There are two methods:

As a header. Format is Authorization: ApiKey <username>:<api_key> Authorization: ApiKey daniel:204db7bcfafb2deb7506b89eb3b9b715b09905c8

As GET params http://127.0.0.1:8000/api/v1/entries/?username=daniel&api_key=204db7bcfafb2deb7506b89eb3b9b715b09905c8

Sorting

Use the order_by GET param to specify a field to sort returned objects. Add a - character in front of the field name to switch the sort direction from ascending order (the default) to descending order. You can use most fields of an object to sort.

Filtering

Perform basic filtering by using a GET param with the same name as an object field. Using name=alexander only returns objects with a name field of “alexander”.

Use more advanced filters by appending the correct suffix to the GET param. The suffix consists of __ plus one of the filters that follow. Using name__startswith=alex only returns objects with a name field starting with “alex”.

Filter Description
exact Exact match.
iexact Case-insensitive exact match.
contains Case-sensitive containment test.
icontains Case-insensitive containment test.
in In a given list. Comma delimited.
gt Greater than.
gte Greater than or equal to.
lt Less than.
lte Less than or equal to.
startswith Case-sensitive starts-with.
istartswith Case-insensitive starts-with.
endswith Case-sensitive ends-with.
iendswith Case-insensitive ends-with.
range Range test (inclusive).
year Exact year match (date fields).
month Exact month number match (date fields).
day Exact day number match (date fields).
week_day Exact week day number match. 1-7. Sunday=1 (date fields).
hour Exact hour match. 0-23. (date fields).
minute Exact minute match. 0-59. (date fields).
second Exact second match. 0-59. (date fields).
isnull Null check. True or False.
regex Case-sensitive regular expression match.
iregex Case-insensitive regular expression match.

API Reference

This section has automatically generated reference pages for each endpoint the REST API provides.

Active Ion Chef Library Prep Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/activeioncheflibraryprepkitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/activeioncheflibraryprepkitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/activeioncheflibraryprepkitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "applicationType": "AMPS",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "filter_s5HidKit",
            "chipTypes": "",
            "defaultCartridgeUsageCount": null,
            "description": "Precision ID Chef DL8",
            "flowCount": 0,
            "id": 20105,
            "instrumentType": "",
            "isActive": true,
            "kitType": "LibraryPrepKit",
            "libraryReadLength": 0,
            "name": "Ion Chef HID Library V2",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A32926C",
                    "id": 20245,
                    "kit": "/rundb/api/v1/kitinfo/20105/",
                    "resource_uri": "/rundb/api/v1/kitpart/20245/"
                },
                {
                    "barcode": "A33212",
                    "id": 20261,
                    "kit": "/rundb/api/v1/kitinfo/20105/",
                    "resource_uri": "/rundb/api/v1/kitpart/20261/"
                }
            ],
            "resource_uri": "/rundb/api/v1/activeioncheflibraryprepkitinfo/20105/",
            "runMode": "",
            "samplePrep_instrumentType": "IC",
            "uid": "LPREP0003"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Active Ion Chef Prep Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/activeionchefprepkitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/activeionchefprepkitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/activeionchefprepkitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 9
    },
    "objects": [
        {
            "applicationType": "",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": 30,
            "cartridgeExpirationDayLimit": 8,
            "categories": "s5v1Kit;",
            "chipTypes": "550;560;GX7v1",
            "defaultCartridgeUsageCount": 2,
            "description": "Ion 550 Kit-Chef",
            "flowCount": 500,
            "id": 20113,
            "instrumentType": "S5",
            "isActive": true,
            "kitType": "IonChefPrepKit",
            "libraryReadLength": 200,
            "name": "Ion Chef S550 V1",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A34540",
                    "id": 20264,
                    "kit": "/rundb/api/v1/kitinfo/20113/",
                    "resource_uri": "/rundb/api/v1/kitpart/20264/"
                },
                {
                    "barcode": "A34540C",
                    "id": 20265,
                    "kit": "/rundb/api/v1/kitinfo/20113/",
                    "resource_uri": "/rundb/api/v1/kitpart/20265/"
                }
            ],
            "resource_uri": "/rundb/api/v1/activeionchefprepkitinfo/20113/",
            "runMode": "",
            "samplePrep_instrumentType": "IC",
            "uid": "ICPREP0014"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Active Library Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/activelibrarykitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/activelibrarykitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/activelibrarykitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 24
    },
    "objects": [
        {
            "applicationType": "AMPS",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "carrierSeq",
            "chipTypes": "550",
            "defaultCartridgeUsageCount": null,
            "description": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "flowCount": 0,
            "id": 20118,
            "instrumentType": "",
            "isActive": true,
            "kitType": "LibraryKit",
            "libraryReadLength": 0,
            "name": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A43587",
                    "id": 20269,
                    "kit": "/rundb/api/v1/kitinfo/20118/",
                    "resource_uri": "/rundb/api/v1/kitpart/20269/"
                }
            ],
            "resource_uri": "/rundb/api/v1/activelibrarykitinfo/20118/",
            "runMode": "",
            "samplePrep_instrumentType": "",
            "uid": "LIB0030"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Active Pgm Library Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/activepgmlibrarykitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/activepgmlibrarykitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/activepgmlibrarykitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 21
    },
    "objects": [
        {
            "applicationType": "AMPS",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "carrierSeq",
            "chipTypes": "550",
            "defaultCartridgeUsageCount": null,
            "description": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "flowCount": 0,
            "id": 20118,
            "instrumentType": "",
            "isActive": true,
            "kitType": "LibraryKit",
            "libraryReadLength": 0,
            "name": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A43587",
                    "id": 20269,
                    "kit": "/rundb/api/v1/kitinfo/20118/",
                    "resource_uri": "/rundb/api/v1/kitpart/20269/"
                }
            ],
            "resource_uri": "/rundb/api/v1/activepgmlibrarykitinfo/20118/",
            "runMode": "",
            "samplePrep_instrumentType": "",
            "uid": "LIB0030"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Active Pgm Sequencing Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/activepgmsequencingkitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/activepgmsequencingkitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
defaultFlowOrder A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/activepgmsequencingkitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 4
    },
    "objects": [
        {
            "applicationType": "",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "flowOverridable;readLengthDerivableFromFlows;",
            "chipTypes": "",
            "defaultCartridgeUsageCount": null,
            "defaultFlowOrder": null,
            "description": "Ion PGM Hi-Q View Sequencing Kit",
            "flowCount": 500,
            "id": 20090,
            "instrumentType": "pgm",
            "isActive": true,
            "kitType": "SequencingKit",
            "libraryReadLength": 0,
            "name": "IonPGMHiQView",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A30044",
                    "id": 20203,
                    "kit": "/rundb/api/v1/kitinfo/20090/",
                    "resource_uri": "/rundb/api/v1/kitpart/20203/"
                },
                {
                    "barcode": "A30043",
                    "id": 20204,
                    "kit": "/rundb/api/v1/kitinfo/20090/",
                    "resource_uri": "/rundb/api/v1/kitpart/20204/"
                },
                {
                    "barcode": "A30275",
                    "id": 20205,
                    "kit": "/rundb/api/v1/kitinfo/20090/",
                    "resource_uri": "/rundb/api/v1/kitpart/20205/"
                },
                {
                    "barcode": "A25590",
                    "id": 20206,
                    "kit": "/rundb/api/v1/kitinfo/20090/",
                    "resource_uri": "/rundb/api/v1/kitpart/20206/"
                }
            ],
            "resource_uri": "/rundb/api/v1/activepgmsequencingkitinfo/20090/",
            "runMode": "",
            "samplePrep_instrumentType": "OT_IC_IA",
            "uid": "SEQ0024"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Active Proton Library Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/activeprotonlibrarykitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/activeprotonlibrarykitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/activeprotonlibrarykitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 22
    },
    "objects": [
        {
            "applicationType": "AMPS",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "carrierSeq",
            "chipTypes": "550",
            "defaultCartridgeUsageCount": null,
            "description": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "flowCount": 0,
            "id": 20118,
            "instrumentType": "",
            "isActive": true,
            "kitType": "LibraryKit",
            "libraryReadLength": 0,
            "name": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A43587",
                    "id": 20269,
                    "kit": "/rundb/api/v1/kitinfo/20118/",
                    "resource_uri": "/rundb/api/v1/kitpart/20269/"
                }
            ],
            "resource_uri": "/rundb/api/v1/activeprotonlibrarykitinfo/20118/",
            "runMode": "",
            "samplePrep_instrumentType": "",
            "uid": "LIB0030"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Active Proton Sequencing Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/activeprotonsequencingkitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/activeprotonsequencingkitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
defaultFlowOrder A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/activeprotonsequencingkitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 5
    },
    "objects": [
        {
            "applicationType": "",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "readLengthDerivableFromFlows;",
            "chipTypes": "900;P1.0.19;P1.0.20;P1.1.17;P1.1.541;P1.2.18;P2.0.1;P2.1.1;P2.1.2;P2.3.1",
            "defaultCartridgeUsageCount": null,
            "defaultFlowOrder": null,
            "description": "Ion PI Hi-Q Sequencing 200 Kit",
            "flowCount": 520,
            "id": 20071,
            "instrumentType": "proton",
            "isActive": true,
            "kitType": "SequencingKit",
            "libraryReadLength": 0,
            "name": "IonProtonIHiQ",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A26433",
                    "id": 20154,
                    "kit": "/rundb/api/v1/kitinfo/20071/",
                    "resource_uri": "/rundb/api/v1/kitpart/20154/"
                },
                {
                    "barcode": "A26430",
                    "id": 20155,
                    "kit": "/rundb/api/v1/kitinfo/20071/",
                    "resource_uri": "/rundb/api/v1/kitpart/20155/"
                },
                {
                    "barcode": "A26431",
                    "id": 20156,
                    "kit": "/rundb/api/v1/kitinfo/20071/",
                    "resource_uri": "/rundb/api/v1/kitpart/20156/"
                },
                {
                    "barcode": "A26432",
                    "id": 20157,
                    "kit": "/rundb/api/v1/kitinfo/20071/",
                    "resource_uri": "/rundb/api/v1/kitpart/20157/"
                }
            ],
            "resource_uri": "/rundb/api/v1/activeprotonsequencingkitinfo/20071/",
            "runMode": "",
            "samplePrep_instrumentType": "OT_IC_IA",
            "uid": "SEQ0020"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Active Sequencing Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/activesequencingkitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/activesequencingkitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
defaultFlowOrder A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/activesequencingkitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 13
    },
    "objects": [
        {
            "applicationType": "AMPS",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "filter_s5HidKit",
            "chipTypes": "",
            "defaultCartridgeUsageCount": null,
            "defaultFlowOrder": null,
            "description": "Precision ID S5 Sequencing Kit",
            "flowCount": 650,
            "id": 20111,
            "instrumentType": "S5",
            "isActive": true,
            "kitType": "SequencingKit",
            "libraryReadLength": 0,
            "name": "precisionIDS5Kit",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "100041073B",
                    "id": 20236,
                    "kit": "/rundb/api/v1/kitinfo/20111/",
                    "resource_uri": "/rundb/api/v1/kitpart/20236/"
                },
                {
                    "barcode": "100041074B",
                    "id": 20237,
                    "kit": "/rundb/api/v1/kitinfo/20111/",
                    "resource_uri": "/rundb/api/v1/kitpart/20237/"
                },
                {
                    "barcode": "A33208",
                    "id": 20260,
                    "kit": "/rundb/api/v1/kitinfo/20111/",
                    "resource_uri": "/rundb/api/v1/kitpart/20260/"
                },
                {
                    "barcode": "100049484",
                    "id": 20263,
                    "kit": "/rundb/api/v1/kitinfo/20111/",
                    "resource_uri": "/rundb/api/v1/kitpart/20263/"
                }
            ],
            "resource_uri": "/rundb/api/v1/activesequencingkitinfo/20111/",
            "runMode": "",
            "samplePrep_instrumentType": "",
            "uid": "SEQ0028"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Analysis Args Resource

Resource URL http://mytorrentserver/rundb/api/v1/analysisargs/
Schema URL http://mytorrentserver/rundb/api/v1/analysisargs/schema/

Resource Fields
field help text default nullable readonly blank unique type
active Boolean data. Ex: True true false false true false boolean
alignmentargs Unicode string data. Ex: “Hello World”   false false true false string
analysisargs Unicode string data. Ex: “Hello World”   false false true false string
applCategory Unicode string data. Ex: “Hello World” n/a true false false false string
applGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
applType A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
basecallerargs Unicode string data. Ex: “Hello World”   false false true false string
beadfindargs Unicode string data. Ex: “Hello World”   false false true false string
calibrateargs Unicode string data. Ex: “Hello World”   false false true false string
chipType Unicode string data. Ex: “Hello World”   false false false false string
chip_default Boolean data. Ex: True false false false true false boolean
creationDate A date & time as a string. Ex: “2010-11-10T03:07:43” true true false false false datetime
creator A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
description Unicode string data. Ex: “Hello World” n/a true false false true string
id Integer data. Ex: 2673   false false true true integer
ionstatsargs Unicode string data. Ex: “Hello World”   false false true false string
isSystem Boolean data. Ex: True false false false true false boolean
lastModifiedDate A date & time as a string. Ex: “2010-11-10T03:07:43” true true false false false datetime
lastModifiedUser A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
libraryKitName Unicode string data. Ex: “Hello World”   false false true false string
name Unicode string data. Ex: “Hello World” n/a false false false true string
prebasecallerargs Unicode string data. Ex: “Hello World”   false false true false string
prethumbnailbasecallerargs Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
samplePrepKitName Unicode string data. Ex: “Hello World”   false false true false string
sequenceKitName Unicode string data. Ex: “Hello World”   false false true false string
templateKitName Unicode string data. Ex: “Hello World”   false false true false string
thumbnailalignmentargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailanalysisargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailbasecallerargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailbeadfindargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailcalibrateargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailionstatsargs Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/analysisargs/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 106
    },
    "objects": [
        {
            "active": false,
            "alignmentargs": "",
            "analysisargs": "",
            "applCategory": null,
            "applGroup": null,
            "applType": null,
            "basecallerargs": "",
            "beadfindargs": "",
            "calibrateargs": "",
            "chipType": "",
            "chip_default": false,
            "creationDate": "2019-11-08T21:40:55.000156+00:00",
            "creator": null,
            "description": "All System args will use lower pks",
            "id": 10000,
            "ionstatsargs": "",
            "isSystem": false,
            "lastModifiedDate": "2019-11-08T21:40:55.000156+00:00",
            "lastModifiedUser": null,
            "libraryKitName": "",
            "name": "system_placeholder",
            "prebasecallerargs": "",
            "prethumbnailbasecallerargs": "",
            "resource_uri": "/rundb/api/v1/analysisargs/10000/",
            "samplePrepKitName": "",
            "sequenceKitName": "",
            "templateKitName": "",
            "thumbnailalignmentargs": "",
            "thumbnailanalysisargs": "",
            "thumbnailbasecallerargs": "",
            "thumbnailbeadfindargs": "",
            "thumbnailcalibrateargs": "",
            "thumbnailionstatsargs": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Analysis Metrics Resource

Resource URL http://mytorrentserver/rundb/api/v1/analysismetrics/
Schema URL http://mytorrentserver/rundb/api/v1/analysismetrics/schema/

Resource Fields
field help text default nullable readonly blank unique type
adjusted_addressable Integer data. Ex: 2673 0 false false false false integer
amb Integer data. Ex: 2673 n/a false false false false integer
bead Integer data. Ex: 2673 n/a false false false false integer
dud Integer data. Ex: 2673 n/a false false false false integer
empty Integer data. Ex: 2673 n/a false false false false integer
excluded Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
ignored Integer data. Ex: 2673 n/a false false false false integer
keypass_all_beads Integer data. Ex: 2673 n/a false false false false integer
lib Integer data. Ex: 2673 n/a false false false false integer
libFinal Integer data. Ex: 2673 n/a false false false false integer
libKp Integer data. Ex: 2673 n/a false false false false integer
libLive Integer data. Ex: 2673 n/a false false false false integer
libMix Integer data. Ex: 2673 n/a false false false false integer
lib_pass_basecaller Integer data. Ex: 2673 n/a false false false false integer
lib_pass_cafie Integer data. Ex: 2673 n/a false false false false integer
live Integer data. Ex: 2673 n/a false false false false integer
loading Floating point numeric data. Ex: 26.73 0 false false false false float
pinned Integer data. Ex: 2673 n/a false false false false integer
report A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sysCF Floating point numeric data. Ex: 26.73 n/a false false false false float
sysDR Floating point numeric data. Ex: 26.73 n/a false false false false float
sysIE Floating point numeric data. Ex: 26.73 n/a false false false false float
tf Integer data. Ex: 2673 n/a false false false false integer
tfFinal Integer data. Ex: 2673 n/a false false false false integer
tfKp Integer data. Ex: 2673 n/a false false false false integer
tfLive Integer data. Ex: 2673 n/a false false false false integer
tfMix Integer data. Ex: 2673 n/a false false false false integer
total Integer data. Ex: 2673 0 false false false false integer
washout Integer data. Ex: 2673 n/a false false false false integer
washout_ambiguous Integer data. Ex: 2673 n/a false false false false integer
washout_dud Integer data. Ex: 2673 n/a false false false false integer
washout_library Integer data. Ex: 2673 n/a false false false false integer
washout_live Integer data. Ex: 2673 n/a false false false false integer
washout_test_fragment Integer data. Ex: 2673 n/a false false false false integer
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/analysismetrics/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 6
    },
    "objects": [
        {
            "adjusted_addressable": 2709,
            "amb": 0,
            "bead": 2195,
            "dud": 0,
            "empty": 499,
            "excluded": 7291,
            "id": 6,
            "ignored": 9,
            "keypass_all_beads": 0,
            "lib": 2170,
            "libFinal": 1526,
            "libKp": 0,
            "libLive": 0,
            "libMix": 0,
            "lib_pass_basecaller": 0,
            "lib_pass_cafie": 0,
            "live": 2195,
            "loading": 81.0262089331857,
            "pinned": 6,
            "report": "/rundb/api/v1/results/6/",
            "resource_uri": "/rundb/api/v1/analysismetrics/6/",
            "sysCF": 0.902389362454414,
            "sysDR": 0.0903240870684385,
            "sysIE": 1.01652704179287,
            "tf": 25,
            "tfFinal": 25,
            "tfKp": 0,
            "tfLive": 0,
            "tfMix": 0,
            "total": 10000,
            "washout": 0,
            "washout_ambiguous": 0,
            "washout_dud": 0,
            "washout_library": 0,
            "washout_live": 0,
            "washout_test_fragment": 0
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Application Group Resource

Resource URL http://mytorrentserver/rundb/api/v1/applicationgroup/
Schema URL http://mytorrentserver/rundb/api/v1/applicationgroup/schema/

Resource Fields
field help text default nullable readonly blank unique type
applications Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false false false related
description Unicode string data. Ex: “Hello World” n/a true false false false string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
name Unicode string data. Ex: “Hello World” n/a false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/applicationgroup/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 12
    },
    "objects": [
        {
            "applications": [
                {
                    "alternate_name": "AmpliSeq HD - Fusions",
                    "applicationGroups": [
                        "/rundb/api/v1/applicationgroup/12/"
                    ],
                    "barcode": "",
                    "description": "AmpliSeq HD - Fusions",
                    "id": 13,
                    "isActive": true,
                    "meta": {},
                    "nucleotideType": "rna",
                    "resource_uri": "/rundb/api/v1/runtype/13/",
                    "runType": "AMPS_HD_RNA"
                }
            ],
            "description": "Fusions",
            "id": 12,
            "isActive": true,
            "name": "Fusions",
            "resource_uri": "/rundb/api/v1/applicationgroup/12/",
            "uid": "APPLGROUP_0012"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Appl Product Resource

Resource URL http://mytorrentserver/rundb/api/v1/applproduct/
Schema URL http://mytorrentserver/rundb/api/v1/applproduct/schema/

Resource Fields
field help text default nullable readonly blank unique type
appl A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
applicationGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
barcodeKitSelectableType Unicode string data. Ex: “Hello World”   false false true false string
categories Unicode string data. Ex: “Hello World”   true false false false string
defaultBarcodeKitName Unicode string data. Ex: “Hello World” n/a true false false false string
defaultChipType Unicode string data. Ex: “Hello World” n/a true false false false string
defaultControlSeqKit A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
defaultFlowCount Integer data. Ex: 2673 0 false false false false integer
defaultGenomeRefName Unicode string data. Ex: “Hello World” n/a true false false false string
defaultHotSpotRegionBedFileName Unicode string data. Ex: “Hello World” n/a true false false false string
defaultIonChefPrepKit A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
defaultIonChefSequencingKit A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
defaultLibKit A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
defaultSamplePrepKit A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
defaultSeqKit A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
defaultTargetRegionBedFileName Unicode string data. Ex: “Hello World” n/a true false false false string
defaultTemplateKit A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
description Unicode string data. Ex: “Hello World”   false false true false string
dualBarcodingRule Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
isBarcodeKitSelectionRequired Boolean data. Ex: True false false false true false boolean
isControlSeqTypeBySampleSupported Boolean data. Ex: True false false false true false boolean
isDefault Boolean data. Ex: True false false false true false boolean
isDefaultBarcoded Boolean data. Ex: True false false false true false boolean
isDefaultForInstrumentType Boolean data. Ex: True false false false true false boolean
isDualBarcodingBySampleSupported Boolean data. Ex: True false false false true false boolean
isDualNucleotideTypeBySampleSupported Boolean data. Ex: True false false false true false boolean
isHotSpotBEDFileBySampleSupported Boolean data. Ex: True false false false true false boolean
isHotspotRegionBEDFileSuppported Boolean data. Ex: True true false false true false boolean
isReferenceBySampleSupported Boolean data. Ex: True false false false true false boolean
isReferenceSelectionSupported Boolean data. Ex: True true false false true false boolean
isSamplePrepKitSupported Boolean data. Ex: True true false false true false boolean
isTargetRegionBEDFileBySampleSupported Boolean data. Ex: True false false false true false boolean
isTargetRegionBEDFileSelectionRequiredForRefSelection Boolean data. Ex: True false false false true false boolean
isTargetRegionBEDFileSupported Boolean data. Ex: True true false false true false boolean
isTargetTechniqueSelectionSupported Boolean data. Ex: True true false false true false boolean
isVisible Boolean data. Ex: True false false false true false boolean
productCode Unicode string data. Ex: “Hello World” any false false false true string
productName Unicode string data. Ex: “Hello World” n/a false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/applproduct/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 59
    },
    "objects": [
        {
            "appl": {
                "alternate_name": "AmpliSeq HD - DNA and Fusions (Single Library)",
                "applicationGroups": [
                    "/rundb/api/v1/applicationgroup/11/"
                ],
                "barcode": "",
                "description": "AmpliSeq HD - DNA and Fusions (Single Library)",
                "id": 15,
                "isActive": true,
                "meta": {},
                "nucleotideType": "dna",
                "resource_uri": "/rundb/api/v1/runtype/15/",
                "runType": "AMPS_HD_DNA_RNA_1"
            },
            "applicationGroup": {
                "applications": [
                    {
                        "alternate_name": "AmpliSeq HD - DNA and Fusions (Single Library)",
                        "applicationGroups": [
                            "/rundb/api/v1/applicationgroup/11/"
                        ],
                        "barcode": "",
                        "description": "AmpliSeq HD - DNA and Fusions (Single Library)",
                        "id": 15,
                        "isActive": true,
                        "meta": {},
                        "nucleotideType": "dna",
                        "resource_uri": "/rundb/api/v1/runtype/15/",
                        "runType": "AMPS_HD_DNA_RNA_1"
                    }
                ],
                "description": "DNA and Fusions (Single Library)",
                "id": 11,
                "isActive": true,
                "name": "DNA + RNA 1",
                "resource_uri": "/rundb/api/v1/applicationgroup/11/",
                "uid": "APPLGROUP_0011"
            },
            "barcodeKitSelectableType": "all",
            "categories": "",
            "defaultBarcodeKitName": null,
            "defaultChipType": "540",
            "defaultControlSeqKit": null,
            "defaultFlowCount": 500,
            "defaultGenomeRefName": "hg19",
            "defaultHotSpotRegionBedFileName": "",
            "defaultIonChefPrepKit": "/rundb/api/v1/kitinfo/20083/",
            "defaultIonChefSequencingKit": null,
            "defaultLibKit": {
                "applicationType": "AMPS_HD_DNA;AMPS_HD_RNA;AMPS_HD_DNA_RNA;AMPS_HD_DNA_RNA_1",
                "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
                "cartridgeExpirationDayLimit": null,
                "categories": "",
                "chipTypes": "",
                "defaultCartridgeUsageCount": null,
                "defaultFlowOrder": null,
                "description": "Ion AmpliSeq HD Library Kit",
                "flowCount": 0,
                "id": 20114,
                "instrumentType": "",
                "isActive": true,
                "kitType": "LibraryKit",
                "libraryReadLength": 0,
                "name": "Ion AmpliSeq HD Library Kit",
                "nucleotideType": "",
                "parts": [],
                "resource_uri": "/rundb/api/v1/kitinfo/20114/",
                "runMode": "",
                "samplePrep_instrumentType": "",
                "uid": "LIB0027"
            },
            "defaultSamplePrepKit": null,
            "defaultSeqKit": {
                "applicationType": "",
                "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
                "cartridgeExpirationDayLimit": null,
                "categories": "s5v1Kit;flowOverridable;",
                "chipTypes": "",
                "defaultCartridgeUsageCount": null,
                "defaultFlowOrder": null,
                "description": "Ion S5 Sequencing Kit",
                "flowCount": 500,
                "id": 20088,
                "instrumentType": "S5",
                "isActive": true,
                "kitType": "SequencingKit",
                "libraryReadLength": 0,
                "name": "Ion S5 Sequencing Kit",
                "nucleotideType": "",
                "parts": [
                    {
                        "barcode": "100031412",
                        "id": 20173,
                        "kit": "/rundb/api/v1/kitinfo/20088/",
                        "resource_uri": "/rundb/api/v1/kitpart/20173/"
                    },
                    {
                        "barcode": "100031090",
                        "id": 20174,
                        "kit": "/rundb/api/v1/kitinfo/20088/",
                        "resource_uri": "/rundb/api/v1/kitpart/20174/"
                    },
                    {
                        "barcode": "100031096",
                        "id": 20175,
                        "kit": "/rundb/api/v1/kitinfo/20088/",
                        "resource_uri": "/rundb/api/v1/kitpart/20175/"
                    },
                    {
                        "barcode": "A27767",
                        "id": 20195,
                        "kit": "/rundb/api/v1/kitinfo/20088/",
                        "resource_uri": "/rundb/api/v1/kitpart/20195/"
                    },
                    {
                        "barcode": "A27768",
                        "id": 20196,
                        "kit": "/rundb/api/v1/kitinfo/20088/",
                        "resource_uri": "/rundb/api/v1/kitpart/20196/"
                    },
                    {
                        "barcode": "100033230",
                        "id": 20202,
                        "kit": "/rundb/api/v1/kitinfo/20088/",
                        "resource_uri": "/rundb/api/v1/kitpart/20202/"
                    },
                    {
                        "barcode": "100031091B",
                        "id": 20238,
                        "kit": "/rundb/api/v1/kitinfo/20088/",
                        "resource_uri": "/rundb/api/v1/kitpart/20238/"
                    },
                    {
                        "barcode": "INS1012841B",
                        "id": 20239,
                        "kit": "/rundb/api/v1/kitinfo/20088/",
                        "resource_uri": "/rundb/api/v1/kitpart/20239/"
                    }
                ],
                "resource_uri": "/rundb/api/v1/kitinfo/20088/",
                "runMode": "",
                "samplePrep_instrumentType": "",
                "uid": "SEQ0023"
            },
            "defaultTargetRegionBedFileName": "",
            "defaultTemplateKit": null,
            "description": "",
            "dualBarcodingRule": "",
            "id": 20059,
            "instrumentType": "s5",
            "isActive": true,
            "isBarcodeKitSelectionRequired": false,
            "isControlSeqTypeBySampleSupported": false,
            "isDefault": true,
            "isDefaultBarcoded": false,
            "isDefaultForInstrumentType": false,
            "isDualBarcodingBySampleSupported": false,
            "isDualNucleotideTypeBySampleSupported": false,
            "isHotSpotBEDFileBySampleSupported": true,
            "isHotspotRegionBEDFileSuppported": true,
            "isReferenceBySampleSupported": true,
            "isReferenceSelectionSupported": true,
            "isSamplePrepKitSupported": true,
            "isTargetRegionBEDFileBySampleSupported": true,
            "isTargetRegionBEDFileSelectionRequiredForRefSelection": true,
            "isTargetRegionBEDFileSupported": true,
            "isTargetTechniqueSelectionSupported": true,
            "isVisible": true,
            "productCode": "AMPS_HD_DNA_RNA_1",
            "productName": "AMPS_HD_DNA_RNA_1_default",
            "resource_uri": "/rundb/api/v1/applproduct/20059/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Available Ion Chef Planned Experiment Resource

Resource URL http://mytorrentserver/rundb/api/v1/availableionchefplannedexperiment/
Schema URL http://mytorrentserver/rundb/api/v1/availableionchefplannedexperiment/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
categories Unicode string data. Ex: “Hello World”   true false false false string
chipType Unicode string data. Ex: “Hello World” n/a true true true false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
metaData Unicode string data. Ex: “Hello World” {} false false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/availableionchefplannedexperiment/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "chipType": "540",
            "date": "2018-04-13T22:17:13.000108+00:00",
            "experiment": "/rundb/api/v1/experiment/136/",
            "id": 143,
            "isPlanGroup": false,
            "isReverseRun": false,
            "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA",
            "planShortID": "SP1XE",
            "planStatus": "pending",
            "samplePrepProtocol": "",
            "samplePrepProtocolName": "",
            "sampleTubeLabel": "",
            "templatingKitName": "Ion Chef S540 V1",
            "username": "ionadmin"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Available Ion Chef Planned Experiment Summary Resource

Resource URL http://mytorrentserver/rundb/api/v1/availableionchefplannedexperimentsummary/
Schema URL http://mytorrentserver/rundb/api/v1/availableionchefplannedexperimentsummary/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
categories Unicode string data. Ex: “Hello World”   true false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
metaData Unicode string data. Ex: “Hello World” {} false false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/availableionchefplannedexperimentsummary/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "date": "2018-04-13T22:17:13.000108+00:00",
            "experiment": "/rundb/api/v1/experiment/136/",
            "id": 143,
            "isPlanGroup": false,
            "isReverseRun": false,
            "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA",
            "planShortID": "SP1XE",
            "planStatus": "pending",
            "samplePrepProtocol": "",
            "sampleTubeLabel": "",
            "templatingKitName": "Ion Chef S540 V1",
            "username": "ionadmin"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Available Onetouch Planned Experiment Resource

Resource URL http://mytorrentserver/rundb/api/v1/availableonetouchplannedexperiment/
Schema URL http://mytorrentserver/rundb/api/v1/availableonetouchplannedexperiment/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
applicationCategoryDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
applicationGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
applicationGroupDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
autoAnalyze Boolean data. Ex: True n/a false false false false boolean
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
barcodeId Unicode string data. Ex: “Hello World”   true false true false string
barcodedSamples Unicode string data. Ex: “Hello World”   true false true false string
base_recalibration_mode Unicode string data. Ex: “Hello World”   true false true false string
bedfile Unicode string data. Ex: “Hello World”   false false true false string
categories Unicode string data. Ex: “Hello World”   true false false false string
chefInfo A dictionary of data. Ex: {‘price’: 26.73, ‘name’: ‘Daniel’} {} false false false false dict
childPlans A list of data. Ex: [‘abc’, 26.73, 8] [] false false false false list
chipBarcode Unicode string data. Ex: “Hello World”   false false false false string
chipType Unicode string data. Ex: “Hello World”   false false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
earlyDatFileDeletion Boolean data. Ex: True false false true false false boolean
endBarcodeKitName Unicode string data. Ex: “Hello World”   true false true false string
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
flows Integer data. Ex: 2673 0 false false false false integer
flowsInOrder Unicode string data. Ex: “Hello World”   true false true false string
forward3primeadapter Unicode string data. Ex: “Hello World”   true false true false string
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isDuplicateReads Boolean data. Ex: True n/a false false false false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
library Unicode string data. Ex: “Hello World”   true false true false string
libraryKey Unicode string data. Ex: “Hello World”   false false true false string
libraryPrepType Unicode string data. Ex: “Hello World”   true true true false string
libraryPrepTypeDisplayedName Unicode string data. Ex: “Hello World”   true true true false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
librarykitname Unicode string data. Ex: “Hello World”   true false true false string
metaData Unicode string data. Ex: “Hello World” {} false false true false string
mixedTypeRNA_hotSpotRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
mixedTypeRNA_reference Unicode string data. Ex: “Hello World”   true false true false string
mixedTypeRNA_targetRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
notes Unicode string data. Ex: “Hello World”   true false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
parentPlan Unicode string data. Ex: “Hello World” None false false true false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
platform Unicode string data. Ex: “Hello World” n/a true false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
project Unicode string data. Ex: “Hello World” n/a false true true false string
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
qcValues Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
realign Boolean data. Ex: True n/a false false false false boolean
regionfile Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse3primeadapter Unicode string data. Ex: “Hello World”   false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
reverselibrarykey Unicode string data. Ex: “Hello World”   false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
sample Unicode string data. Ex: “Hello World”   true false true false string
sampleDisplayedName Unicode string data. Ex: “Hello World”   true false true false string
sampleGrouping A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleGroupingName Unicode string data. Ex: “Hello World” n/a true true true false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleSetDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
sampleSets Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
selectedPlugins Unicode string data. Ex: “Hello World”   true false true false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
sequencekitname Unicode string data. Ex: “Hello World”   true false true false string
sseBedFile Unicode string data. Ex: “Hello World”   false false true false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
tfKey Unicode string data. Ex: “Hello World”   false false true false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
variantfrequency Unicode string data. Ex: “Hello World”   false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/availableonetouchplannedexperiment/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "adapter": null,
            "alignmentargs": "tmap mapall ... stage1 map4",
            "analysisargs": "Analysis --args-json /opt/ion/config/args_P1.1.17_analysis.json",
            "applicationCategoryDisplayedName": "",
            "applicationGroup": "/rundb/api/v1/applicationgroup/2/",
            "applicationGroupDisplayedName": "RNA",
            "autoAnalyze": true,
            "autoName": null,
            "barcodeId": "IonXpress",
            "barcodedSamples": {
                "Sample 1": {
                    "barcodeSampleInfo": {
                        "IonXpress_001": {
                            "controlSequenceType": "",
                            "controlType": "",
                            "description": "",
                            "endBarcode": "",
                            "externalId": "",
                            "hotSpotRegionBedFile": "",
                            "nucleotideType": "RNA",
                            "reference": "AmpliSeq_Mouse_Transcriptome_v1",
                            "sseBedFile": "",
                            "targetRegionBedFile": ""
                        }
                    },
                    "barcodes": [
                        "IonXpress_001"
                    ],
                    "dualBarcodes": []
                }
            },
            "base_recalibration_mode": "standard_recal",
            "basecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --max-phasing-levels 2 --num-unfiltered 1000 --barcode-filter-postpone 1",
            "beadfindargs": "justBeadFind --args-json /opt/ion/config/args_P1.1.17_beadfind.json",
            "bedfile": "",
            "calibrateargs": "Calibration",
            "categories": "",
            "chefInfo": {},
            "childPlans": [],
            "chipBarcode": "",
            "chipType": "P1.1.17",
            "controlSequencekitname": null,
            "custom_args": false,
            "cycles": null,
            "date": "2018-08-02T18:54:44.000297+00:00",
            "earlyDatFileDeletion": false,
            "endBarcodeKitName": "",
            "expName": "",
            "experiment": "/rundb/api/v1/experiment/137/",
            "flows": 500,
            "flowsInOrder": "",
            "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
            "id": 144,
            "ionstatsargs": "ionstats alignment",
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isDuplicateReads": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": false,
            "isReverseRun": false,
            "isSystem": false,
            "isSystemDefault": false,
            "libkit": null,
            "library": "AmpliSeq_Mouse_Transcriptome_v1",
            "libraryKey": "TCAG",
            "libraryPrepType": "",
            "libraryPrepTypeDisplayedName": "",
            "libraryReadLength": 0,
            "librarykitname": "Ion AmpliSeq Library Kit Plus",
            "metaData": {
                "fromTemplate": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression_Panel_OT2-Proton",
                "fromTemplateSource": "ION"
            },
            "mixedTypeRNA_hotSpotRegionBedFile": "",
            "mixedTypeRNA_reference": "",
            "mixedTypeRNA_targetRegionBedFile": "",
            "notes": "",
            "origin": "gui|5.10.0",
            "pairedEndLibraryAdapterName": "",
            "parentPlan": null,
            "planDisplayedName": "Ion AmpliSeq Transcriptome Mouse Gene Expression ",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "685ac1ca-9a42-4d9c-af2f-29a97706cb8e",
            "planName": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression",
            "planPGM": null,
            "planShortID": "YEN8M",
            "planStatus": "planned",
            "platform": "",
            "preAnalysis": true,
            "prebasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --max-phasing-levels 2",
            "prethumbnailbasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0",
            "project": "",
            "projects": [],
            "qcValues": [
                {
                    "id": 409,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 1,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Bead Loading (%)",
                        "resource_uri": "/rundb/api/v1/qctype/1/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/409/",
                    "threshold": 30
                },
                {
                    "id": 410,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 2,
                        "maxThreshold": 100,
                        "minThreshold": 1,
                        "qcName": "Key Signal (1-100)",
                        "resource_uri": "/rundb/api/v1/qctype/2/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/410/",
                    "threshold": 30
                },
                {
                    "id": 411,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 3,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Usable Sequence (%)",
                        "resource_uri": "/rundb/api/v1/qctype/3/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/411/",
                    "threshold": 30
                }
            ],
            "realign": false,
            "regionfile": "",
            "resource_uri": "/rundb/api/v1/availableonetouchplannedexperiment/144/",
            "reverse3primeadapter": "",
            "reverse_primer": null,
            "reverselibrarykey": "",
            "runMode": "single",
            "runType": "AMPS_RNA",
            "runname": null,
            "sample": "",
            "sampleDisplayedName": "",
            "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/2/",
            "sampleGroupingName": "Self",
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleSetDisplayedName": "",
            "sampleSets": [],
            "sampleTubeLabel": "",
            "selectedPlugins": {
                "ampliSeqRNA": {
                    "features": [],
                    "id": 48,
                    "name": "ampliSeqRNA",
                    "userInput": {},
                    "version": "5.10.0.1"
                }
            },
            "seqKitBarcode": null,
            "sequencekitname": "ProtonI200Kit-v3",
            "sseBedFile": "",
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion PI Template OT2 200 Kit v3",
            "tfKey": "ATCG",
            "thumbnailalignmentargs": "tmap mapall ... stage1 map4",
            "thumbnailanalysisargs": "Analysis --args-json /opt/ion/config/args_P1.1.17_analysis.json --thumbnail true",
            "thumbnailbasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0",
            "thumbnailbeadfindargs": "justBeadFind --args-json /opt/ion/config/args_P1.1.17_beadfind.json --thumbnail true",
            "thumbnailcalibrateargs": "Calibration",
            "thumbnailionstatsargs": "ionstats alignment",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": "ionadmin",
            "variantfrequency": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Available Onetouch Planned Experiment Summary Resource

Resource URL http://mytorrentserver/rundb/api/v1/availableonetouchplannedexperimentsummary/
Schema URL http://mytorrentserver/rundb/api/v1/availableonetouchplannedexperimentsummary/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
categories Unicode string data. Ex: “Hello World”   true false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
expName Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
metaData Unicode string data. Ex: “Hello World” {} false false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/availableonetouchplannedexperimentsummary/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "adapter": null,
            "autoName": null,
            "categories": "",
            "controlSequencekitname": null,
            "cycles": null,
            "date": "2018-08-02T18:54:44.000297+00:00",
            "expName": "",
            "id": 144,
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": false,
            "isReverseRun": false,
            "isSystem": false,
            "isSystemDefault": false,
            "libkit": null,
            "libraryReadLength": 0,
            "metaData": {
                "fromTemplate": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression_Panel_OT2-Proton",
                "fromTemplateSource": "ION"
            },
            "origin": "gui|5.10.0",
            "pairedEndLibraryAdapterName": "",
            "planDisplayedName": "Ion AmpliSeq Transcriptome Mouse Gene Expression ",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "685ac1ca-9a42-4d9c-af2f-29a97706cb8e",
            "planName": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression",
            "planPGM": null,
            "planShortID": "YEN8M",
            "planStatus": "planned",
            "preAnalysis": true,
            "resource_uri": "/rundb/api/v1/availableonetouchplannedexperimentsummary/144/",
            "reverse_primer": null,
            "runMode": "single",
            "runType": "AMPS_RNA",
            "runname": null,
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleTubeLabel": "",
            "seqKitBarcode": null,
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion PI Template OT2 200 Kit v3",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": "ionadmin"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Available Planned Experiment Summary Resource

Resource URL http://mytorrentserver/rundb/api/v1/availableplannedexperimentsummary/
Schema URL http://mytorrentserver/rundb/api/v1/availableplannedexperimentsummary/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
applicationCategoryDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
applicationGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
applicationGroupDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
autoAnalyze Boolean data. Ex: True n/a false false false false boolean
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
barcodeId Unicode string data. Ex: “Hello World”   true false true false string
barcodedSamples Unicode string data. Ex: “Hello World”   true false true false string
base_recalibration_mode Unicode string data. Ex: “Hello World”   true false true false string
bedfile Unicode string data. Ex: “Hello World”   false false true false string
categories Unicode string data. Ex: “Hello World”   true false false false string
chefInfo A dictionary of data. Ex: {‘price’: 26.73, ‘name’: ‘Daniel’} {} false false false false dict
childPlans A list of data. Ex: [‘abc’, 26.73, 8] [] false false false false list
chipBarcode Unicode string data. Ex: “Hello World”   false false false false string
chipType Unicode string data. Ex: “Hello World”   false false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
earlyDatFileDeletion Boolean data. Ex: True false false true false false boolean
endBarcodeKitName Unicode string data. Ex: “Hello World”   true false true false string
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
flows Integer data. Ex: 2673 0 false false false false integer
flowsInOrder Unicode string data. Ex: “Hello World”   true false true false string
forward3primeadapter Unicode string data. Ex: “Hello World”   true false true false string
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isDuplicateReads Boolean data. Ex: True n/a false false false false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
library Unicode string data. Ex: “Hello World”   true false true false string
libraryKey Unicode string data. Ex: “Hello World”   false false true false string
libraryPrepType Unicode string data. Ex: “Hello World”   true true true false string
libraryPrepTypeDisplayedName Unicode string data. Ex: “Hello World”   true true true false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
librarykitname Unicode string data. Ex: “Hello World”   true false true false string
metaData Unicode string data. Ex: “Hello World” {} false false true false string
mixedTypeRNA_hotSpotRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
mixedTypeRNA_reference Unicode string data. Ex: “Hello World”   true false true false string
mixedTypeRNA_targetRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
notes Unicode string data. Ex: “Hello World”   true false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
parentPlan Unicode string data. Ex: “Hello World” None false false true false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
platform Unicode string data. Ex: “Hello World” n/a true false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
project Unicode string data. Ex: “Hello World” n/a false true true false string
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
qcValues Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
realign Boolean data. Ex: True n/a false false false false boolean
regionfile Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse3primeadapter Unicode string data. Ex: “Hello World”   false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
reverselibrarykey Unicode string data. Ex: “Hello World”   false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
sample Unicode string data. Ex: “Hello World”   true false true false string
sampleDisplayedName Unicode string data. Ex: “Hello World”   true false true false string
sampleGrouping A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleGroupingName Unicode string data. Ex: “Hello World” n/a true true true false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleSetDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
sampleSets Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
selectedPlugins Unicode string data. Ex: “Hello World”   true false true false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
sequencekitname Unicode string data. Ex: “Hello World”   true false true false string
sseBedFile Unicode string data. Ex: “Hello World”   false false true false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
tfKey Unicode string data. Ex: “Hello World”   false false true false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
variantfrequency Unicode string data. Ex: “Hello World”   false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/availableplannedexperimentsummary/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "adapter": null,
            "alignmentargs": "tmap mapall ... stage1 map4",
            "analysisargs": "Analysis --args-json /opt/ion/config/args_P1.1.17_analysis.json",
            "applicationCategoryDisplayedName": "",
            "applicationGroup": "/rundb/api/v1/applicationgroup/2/",
            "applicationGroupDisplayedName": "RNA",
            "autoAnalyze": true,
            "autoName": null,
            "barcodeId": "IonXpress",
            "barcodedSamples": {
                "Sample 1": {
                    "barcodeSampleInfo": {
                        "IonXpress_001": {
                            "controlSequenceType": "",
                            "controlType": "",
                            "description": "",
                            "endBarcode": "",
                            "externalId": "",
                            "hotSpotRegionBedFile": "",
                            "nucleotideType": "RNA",
                            "reference": "AmpliSeq_Mouse_Transcriptome_v1",
                            "sseBedFile": "",
                            "targetRegionBedFile": ""
                        }
                    },
                    "barcodes": [
                        "IonXpress_001"
                    ],
                    "dualBarcodes": []
                }
            },
            "base_recalibration_mode": "standard_recal",
            "basecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --max-phasing-levels 2 --num-unfiltered 1000 --barcode-filter-postpone 1",
            "beadfindargs": "justBeadFind --args-json /opt/ion/config/args_P1.1.17_beadfind.json",
            "bedfile": "",
            "calibrateargs": "Calibration",
            "categories": "",
            "chefInfo": {},
            "childPlans": [],
            "chipBarcode": "",
            "chipType": "P1.1.17",
            "controlSequencekitname": null,
            "custom_args": false,
            "cycles": null,
            "date": "2018-08-02T18:54:44.000297+00:00",
            "earlyDatFileDeletion": false,
            "endBarcodeKitName": "",
            "expName": "",
            "experiment": "/rundb/api/v1/experiment/137/",
            "flows": 500,
            "flowsInOrder": "",
            "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
            "id": 144,
            "ionstatsargs": "ionstats alignment",
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isDuplicateReads": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": false,
            "isReverseRun": false,
            "isSystem": false,
            "isSystemDefault": false,
            "libkit": null,
            "library": "AmpliSeq_Mouse_Transcriptome_v1",
            "libraryKey": "TCAG",
            "libraryPrepType": "",
            "libraryPrepTypeDisplayedName": "",
            "libraryReadLength": 0,
            "librarykitname": "Ion AmpliSeq Library Kit Plus",
            "metaData": {
                "fromTemplate": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression_Panel_OT2-Proton",
                "fromTemplateSource": "ION"
            },
            "mixedTypeRNA_hotSpotRegionBedFile": "",
            "mixedTypeRNA_reference": "",
            "mixedTypeRNA_targetRegionBedFile": "",
            "notes": "",
            "origin": "gui|5.10.0",
            "pairedEndLibraryAdapterName": "",
            "parentPlan": null,
            "planDisplayedName": "Ion AmpliSeq Transcriptome Mouse Gene Expression ",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "685ac1ca-9a42-4d9c-af2f-29a97706cb8e",
            "planName": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression",
            "planPGM": null,
            "planShortID": "YEN8M",
            "planStatus": "planned",
            "platform": "",
            "preAnalysis": true,
            "prebasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --max-phasing-levels 2",
            "prethumbnailbasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0",
            "project": "",
            "projects": [],
            "qcValues": [
                {
                    "id": 409,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 1,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Bead Loading (%)",
                        "resource_uri": "/rundb/api/v1/qctype/1/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/409/",
                    "threshold": 30
                },
                {
                    "id": 410,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 2,
                        "maxThreshold": 100,
                        "minThreshold": 1,
                        "qcName": "Key Signal (1-100)",
                        "resource_uri": "/rundb/api/v1/qctype/2/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/410/",
                    "threshold": 30
                },
                {
                    "id": 411,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 3,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Usable Sequence (%)",
                        "resource_uri": "/rundb/api/v1/qctype/3/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/411/",
                    "threshold": 30
                }
            ],
            "realign": false,
            "regionfile": "",
            "resource_uri": "/rundb/api/v1/availableplannedexperimentsummary/144/",
            "reverse3primeadapter": "",
            "reverse_primer": null,
            "reverselibrarykey": "",
            "runMode": "single",
            "runType": "AMPS_RNA",
            "runname": null,
            "sample": "",
            "sampleDisplayedName": "",
            "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/2/",
            "sampleGroupingName": "Self",
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleSetDisplayedName": "",
            "sampleSets": [],
            "sampleTubeLabel": "",
            "selectedPlugins": {
                "ampliSeqRNA": {
                    "features": [],
                    "id": 48,
                    "name": "ampliSeqRNA",
                    "userInput": {},
                    "version": "5.10.0.1"
                }
            },
            "seqKitBarcode": null,
            "sequencekitname": "ProtonI200Kit-v3",
            "sseBedFile": "",
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion PI Template OT2 200 Kit v3",
            "tfKey": "ATCG",
            "thumbnailalignmentargs": "tmap mapall ... stage1 map4",
            "thumbnailanalysisargs": "Analysis --args-json /opt/ion/config/args_P1.1.17_analysis.json --thumbnail true",
            "thumbnailbasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0",
            "thumbnailbeadfindargs": "justBeadFind --args-json /opt/ion/config/args_P1.1.17_beadfind.json --thumbnail true",
            "thumbnailcalibrateargs": "Calibration",
            "thumbnailionstatsargs": "ionstats alignment",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": "ionadmin",
            "variantfrequency": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Chip Resource

Resource URL http://mytorrentserver/rundb/api/v1/chip/
Schema URL http://mytorrentserver/rundb/api/v1/chip/schema/

Resource Fields
field help text default nullable readonly blank unique type
description Unicode string data. Ex: “Hello World”   false false false false string
earlyDatFileDeletion Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
name Unicode string data. Ex: “Hello World” n/a false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
slots Integer data. Ex: 2673 n/a false false false false integer
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/chip/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 15
    },
    "objects": [
        {
            "alignmentargs": "tmap mapall ... stage1 map4",
            "analysisargs": "Analysis --args-json /opt/ion/config/args_520_analysis.json",
            "basecallerargs": "BaseCaller --trim-qual-cutoff 15 --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --num-unfiltered 1000 --barcode-filter-postpone 1 --qual-filter true --qual-filter-slope 0.040 --qual-filter-offset 1.0 --wells-normalization on",
            "beadfindargs": "justBeadFind --args-json /opt/ion/config/args_520_beadfind.json",
            "calibrateargs": "Calibration --num-calibration-regions 1,1",
            "description": "510",
            "earlyDatFileDeletion": "",
            "id": 28,
            "instrumentType": "S5",
            "ionstatsargs": "ionstats alignment",
            "isActive": true,
            "name": "510",
            "prebasecallerargs": "BaseCaller --trim-qual-cutoff 15 --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --wells-normalization on",
            "prethumbnailbasecallerargs": "BaseCaller --trim-qual-cutoff 15 --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --wells-normalization on",
            "resource_uri": "/rundb/api/v1/chip/28/",
            "slots": 1,
            "thumbnailalignmentargs": "tmap mapall ... stage1 map4",
            "thumbnailanalysisargs": "Analysis --args-json /opt/ion/config/args_520_analysis.json --thumbnail true",
            "thumbnailbasecallerargs": "BaseCaller --trim-qual-cutoff 15 --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --qual-filter true --qual-filter-slope 0.040 --qual-filter-offset 1.0 --wells-normalization on",
            "thumbnailbeadfindargs": "justBeadFind --args-json /opt/ion/config/args_520_beadfind.json --thumbnail true",
            "thumbnailcalibrateargs": "Calibration",
            "thumbnailionstatsargs": "ionstats alignment"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Cluster Info History Resource

Resource URL http://mytorrentserver/rundb/api/v1/clusterinfohistory/
Schema URL http://mytorrentserver/rundb/api/v1/clusterinfohistory/schema/

Resource Fields
field help text default nullable readonly blank unique type
created A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
id Integer data. Ex: 2673   false false true true integer
name Unicode string data. Ex: “Hello World” n/a true true false false string
object_pk Integer data. Ex: 2673 n/a false false false false integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
text Unicode string data. Ex: “Hello World”   false false false false string
username Unicode string data. Ex: “Hello World” ION false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 0
    },
    "objects": []
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Common Cv Resource

Resource URL http://mytorrentserver/rundb/api/v1/common_cv/
Schema URL http://mytorrentserver/rundb/api/v1/common_cv/schema/

Resource Fields
field help text default nullable readonly blank unique type
categories Unicode string data. Ex: “Hello World”   true false false false string
cv_type Unicode string data. Ex: “Hello World” n/a false false false false string
description Unicode string data. Ex: “Hello World” n/a true false false false string
displayedValue Unicode string data. Ex: “Hello World” n/a false false false true string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
isDefault Boolean data. Ex: True true false false true false boolean
isVisible Boolean data. Ex: True true false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
sequencing_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
value Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/common_cv/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 16
    },
    "objects": [
        {
            "categories": "AMPS;AMPS_RNA;AMPS_DNA_RNA;AMPS_HD_DNA;AMPS_HD_RNA;AMPS_HD_DNA_RNA;AMPS_HD_DNA_RNA_1",
            "cv_type": "applicationCategory",
            "description": "Oncomine Tumor Specific Panels",
            "displayedValue": "P4O",
            "id": 16,
            "isActive": true,
            "isDefault": false,
            "isVisible": false,
            "resource_uri": "/rundb/api/v1/common_cv/16/",
            "samplePrep_instrumentType": "",
            "sequencing_instrumentType": "",
            "uid": "APPCAT0011",
            "value": "p4o"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Composite Data Management Resource

Resource URL http://mytorrentserver/rundb/api/v1/compositedatamanagement/
Schema URL http://mytorrentserver/rundb/api/v1/compositedatamanagement/schema/

Resource Fields
field help text default nullable readonly blank unique type
basecall_keep Unicode string data. Ex: “Hello World” n/a true true false false string
basecall_state Unicode string data. Ex: “Hello World” Unknown false true false false string
diskusage Integer data. Ex: 2673 n/a true false false false integer
expDir Unicode string data. Ex: “Hello World” n/a false true false false string
expName Unicode string data. Ex: “Hello World” n/a false true false false string
id Integer data. Ex: 2673   false false true true integer
in_process Boolean data. Ex: True false false false false false boolean
misc_keep Unicode string data. Ex: “Hello World” n/a true true false false string
misc_state Unicode string data. Ex: “Hello World” Unknown false true false false string
output_keep Unicode string data. Ex: “Hello World” n/a true true false false string
output_state Unicode string data. Ex: “Hello World” Unknown false true false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultsName Unicode string data. Ex: “Hello World” n/a false false false false string
sigproc_keep Unicode string data. Ex: “Hello World” n/a true true false false string
sigproc_state Unicode string data. Ex: “Hello World” Unknown false true false false string
timeStamp A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/compositedatamanagement/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 6
    },
    "objects": [
        {
            "basecall_diskspace": 5.99083232879639,
            "basecall_keep": false,
            "basecall_state": "Local",
            "diskusage": 393,
            "expDir": "/results/PGM_test/cropped_CB1-42",
            "expName": "R_2011_04_07_12_44_38_user_CB1-42-r9723-314wfa-tl",
            "id": 6,
            "in_process": false,
            "misc_diskspace": 0,
            "misc_keep": null,
            "misc_state": "Deleted",
            "output_diskspace": 4.13351440429688,
            "output_keep": false,
            "output_state": "Error",
            "resource_uri": "/rundb/api/v1/compositedatamanagement/6/",
            "resultsName": "Auto_user_CB1-42-r9723-314wfa-tl_94",
            "sigproc_diskspace": 384.02961730957,
            "sigproc_keep": false,
            "sigproc_state": "Local",
            "timeStamp": "2017-08-23T21:46:24.000391+00:00"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Composite Experiment Resource

Resource URL http://mytorrentserver/rundb/api/mesh/v1/compositeexperiment/
Schema URL http://mytorrentserver/rundb/api/mesh/v1/compositeexperiment/schema/

Resource Fields
field help text default nullable readonly blank unique type
_host Host this resource is located on. n/a false true false false string
chefReagentsSerialNum Unicode string data. Ex: “Hello World”   false false true false string
chefSolutionsSerialNum Unicode string data. Ex: “Hello World”   false false true false string
chefStartTime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
chipType Unicode string data. Ex: “Hello World” n/a false false false false string
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a false false false false datetime
displayName Unicode string data. Ex: “Hello World”   false false false false string
expName Unicode string data. Ex: “Hello World” n/a false false false false string
flows Integer data. Ex: 2673 n/a false false false false integer
ftpStatus Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
notes Unicode string data. Ex: “Hello World” n/a true false false false string
pgmName Unicode string data. Ex: “Hello World” n/a false false false false string
plan A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
platform Unicode string data. Ex: “Hello World”   false false true false string
repResult A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultDate A date & time as a string. Ex: “2010-11-10T03:07:43” true true false false false datetime
results Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
runMode Unicode string data. Ex: “Hello World”   false false true false string
star Boolean data. Ex: True false false false true false boolean
status Unicode string data. Ex: “Hello World”   false false true false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/mesh/v1/compositeexperiment/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 146
    },
    "objects": [
        {
            "_host": "hawk.itw",
            "applicationCategoryDisplayedName": "AmpliSeq DNA and Fusions",
            "barcodeId": "IonCode Barcodes 1-32",
            "barcodedSamples": {},
            "chefReagentsSerialNum": "",
            "chefSolutionsSerialNum": "",
            "chefStartTime": null,
            "chipDescription": "540",
            "chipInstrumentType": "S5",
            "chipType": "540",
            "date": "2019-10-03T22:24:50+00:00",
            "displayName": "user S16-754-R153458-540 DNA33-RNA18 OCAv3 AO-1002",
            "expName": "R_2019_10_03_15_23_03_user_S16-754-R153458-540_DNA33-RNA18_OCAv3_AO-1002",
            "flows": 400,
            "ftpStatus": "Complete",
            "id": 1800,
            "keep": false,
            "library": "hg19",
            "notes": "",
            "pgmName": "S16",
            "plan": {
                "id": 1808,
                "resource_uri": "",
                "runType": "AMPS_DNA_RNA",
                "sampleTubeLabel": null
            },
            "platform": "S5",
            "references": "hg19",
            "repResult": "/rundb/api/v1/compositeresult/1921/",
            "resource_uri": "/rundb/api/mesh/v1/compositeexperiment/1800/",
            "resultDate": "2019-10-04T02:55:43.000359+00:00",
            "results": [
                {
                    "analysis_metrics": {
                        "bead": 144205030,
                        "empty": 5365643,
                        "excluded": 13159848,
                        "id": 1785,
                        "ignored": 1554120,
                        "lib": 143117241,
                        "libFinal": 72109222,
                        "live": 144191568,
                        "pinned": 414495,
                        "resource_uri": "",
                        "total_wells": 164699136
                    },
                    "analysismetrics": {
                        "bead": 144205030,
                        "empty": 5365643,
                        "excluded": 13159848,
                        "id": 1785,
                        "ignored": 1554120,
                        "lib": 143117241,
                        "libFinal": 72109222,
                        "live": 144191568,
                        "pinned": 414495,
                        "resource_uri": "",
                        "total_wells": 164699136
                    },
                    "autoExempt": false,
                    "eas": {
                        "barcodeKitName": "IonCode Barcodes 1-32",
                        "chipType": "540",
                        "isPQ": false,
                        "reference": "hg19",
                        "references": "hg19",
                        "resource_uri": ""
                    },
                    "i18nstatus": {
                        "i18n": "Completed",
                        "state": "Completed"
                    },
                    "id": 1920,
                    "isShowAllMetrics": true,
                    "libmetrics": {
                        "aveKeyCounts": 100,
                        "i100Q20_reads": 32512585,
                        "id": 1632,
                        "q20_mean_alignment_length": 98,
                        "resource_uri": ""
                    },
                    "processedflows": 0,
                    "projects": [
                        {
                            "id": 179,
                            "modified": "2019-10-04T22:30:21.000322+00:00",
                            "name": "Valkyrie",
                            "resource_uri": ""
                        }
                    ],
                    "quality_metrics": {
                        "id": 1633,
                        "q0_bases": "8055445299",
                        "q0_mean_read_length": 111.714116247485,
                        "q0_reads": 72107676,
                        "q20_bases": "7144330852",
                        "q20_mean_read_length": 111,
                        "q20_reads": 72107676,
                        "resource_uri": ""
                    },
                    "qualitymetrics": {
                        "id": 1633,
                        "q0_bases": "8055445299",
                        "q0_mean_read_length": 111.714116247485,
                        "q0_reads": 72107676,
                        "q20_bases": "7144330852",
                        "q20_mean_read_length": 111,
                        "q20_reads": 72107676,
                        "resource_uri": ""
                    },
                    "reportLink": "/output/Home/Auto_user_S16-754-R153458-540_DNA33-RNA18_OCAv3_AO-1002_1800_1920/",
                    "reportStatus": "Nothing",
                    "representative": false,
                    "resource_uri": "/rundb/api/v1/compositeresult/1920/",
                    "resultsName": "Auto_user_S16-754-R153458-540_DNA33-RNA18_OCAv3_AO-1002_1800",
                    "status": "Completed",
                    "status_display": "Completed",
                    "timeStamp": "2019-10-04T02:55:43.000359+00:00"
                },
                {
                    "analysis_metrics": {
                        "bead": 882703,
                        "empty": 30634,
                        "excluded": 39760,
                        "id": 1784,
                        "ignored": 6104,
                        "lib": 876208,
                        "libFinal": 440446,
                        "live": 882647,
                        "pinned": 799,
                        "resource_uri": "",
                        "total_wells": 960000
                    },
                    "analysismetrics": {
                        "bead": 882703,
                        "empty": 30634,
                        "excluded": 39760,
                        "id": 1784,
                        "ignored": 6104,
                        "lib": 876208,
                        "libFinal": 440446,
                        "live": 882647,
                        "pinned": 799,
                        "resource_uri": "",
                        "total_wells": 960000
                    },
                    "autoExempt": false,
                    "eas": {
                        "barcodeKitName": "IonCode Barcodes 1-32",
                        "chipType": "540",
                        "isPQ": false,
                        "reference": "hg19",
                        "references": "hg19",
                        "resource_uri": ""
                    },
                    "i18nstatus": {
                        "i18n": "Completed",
                        "state": "Completed"
                    },
                    "id": 1921,
                    "isShowAllMetrics": true,
                    "libmetrics": {
                        "aveKeyCounts": 104,
                        "i100Q20_reads": 195606,
                        "id": 1631,
                        "q20_mean_alignment_length": 98,
                        "resource_uri": ""
                    },
                    "processedflows": 400,
                    "projects": [
                        {
                            "id": 179,
                            "modified": "2019-10-04T22:30:21.000322+00:00",
                            "name": "Valkyrie",
                            "resource_uri": ""
                        }
                    ],
                    "quality_metrics": {
                        "id": 1632,
                        "q0_bases": "49082942",
                        "q0_mean_read_length": 111.441965329731,
                        "q0_reads": 440435,
                        "q20_bases": "43452424",
                        "q20_mean_read_length": 111,
                        "q20_reads": 440435,
                        "resource_uri": ""
                    },
                    "qualitymetrics": {
                        "id": 1632,
                        "q0_bases": "49082942",
                        "q0_mean_read_length": 111.441965329731,
                        "q0_reads": 440435,
                        "q20_bases": "43452424",
                        "q20_mean_read_length": 111,
                        "q20_reads": 440435,
                        "resource_uri": ""
                    },
                    "reportLink": "/output/Home/Auto_user_S16-754-R153458-540_DNA33-RNA18_OCAv3_AO-1002_1800_tn_1921/",
                    "reportStatus": "Nothing",
                    "representative": false,
                    "resource_uri": "/rundb/api/v1/compositeresult/1921/",
                    "resultsName": "Auto_user_S16-754-R153458-540_DNA33-RNA18_OCAv3_AO-1002_1800_tn",
                    "status": "Completed",
                    "status_display": "Completed",
                    "timeStamp": "2019-10-04T00:39:45.000429+00:00"
                }
            ],
            "runMode": "single",
            "sample": "",
            "sampleDisplayedName": "",
            "sampleSetName": "",
            "star": false,
            "status": "run",
            "storage_options": "A"
        }
    ],
    "warnings": [
        "The Torrent Server(s) phuket.itw,hawk.itw have too many results to display. Only experiments newer than 2018-10-26 are displayed. Try searching or adding additional filters.",
        "Could not fetch runs from Torrent Server(s) tsautotest17.itw!"
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Composite Result Resource

Resource URL http://mytorrentserver/rundb/api/v1/compositeresult/
Schema URL http://mytorrentserver/rundb/api/v1/compositeresult/schema/

Resource Fields
field help text default nullable readonly blank unique type
analysismetrics A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
autoExempt Boolean data. Ex: True false false false true false boolean
eas A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
i18nstatus Unicode string data. Ex: “Hello World” n/a false false false false string
id Integer data. Ex: 2673   false false true true integer
libmetrics A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
processedflows Integer data. Ex: 2673 n/a false false false false integer
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
qualitymetrics A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
reportLink Unicode string data. Ex: “Hello World” n/a false false false false string
reportStatus Unicode string data. Ex: “Hello World” Nothing true false false false string
representative Boolean data. Ex: True false false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultsName Unicode string data. Ex: “Hello World” n/a false false false false string
status Unicode string data. Ex: “Hello World” n/a false false false false string
timeStamp A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/compositeresult/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 7
    },
    "objects": [
        {
            "analysis_metrics": null,
            "analysismetrics": null,
            "autoExempt": false,
            "eas": {
                "barcodeKitName": "IonXpress",
                "chipType": "",
                "isPQ": false,
                "reference": "hg19",
                "references": "hg19",
                "resource_uri": ""
            },
            "i18nstatus": {
                "i18n": "Pending",
                "state": "Other"
            },
            "id": 7,
            "isShowAllMetrics": true,
            "libmetrics": null,
            "processedflows": 0,
            "projects": [
                {
                    "id": 1,
                    "modified": "2018-02-28T17:32:01.000703+00:00",
                    "name": "demo",
                    "resource_uri": ""
                }
            ],
            "quality_metrics": null,
            "qualitymetrics": null,
            "reportLink": "/output/Home/CA_Combined_demo_001_007/",
            "reportStatus": "Nothing",
            "representative": false,
            "resource_uri": "/rundb/api/v1/compositeresult/7/",
            "resultsName": "CA_Combined_demo_001",
            "status": "Pending",
            "timeStamp": "2018-02-28T17:32:01.000577+00:00"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Content Resource

Resource URL http://mytorrentserver/rundb/api/v1/content/
Schema URL http://mytorrentserver/rundb/api/v1/content/schema/

Resource Fields
field help text default nullable readonly blank unique type
application_tags Unicode string data. Ex: “Hello World”   false false true false string
contentupload A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
description Unicode string data. Ex: “Hello World”   false false true false string
enabled Boolean data. Ex: True true false false true false boolean
extra Unicode string data. Ex: “Hello World”   false false true false string
file Unicode string data. Ex: “Hello World” n/a false false false false string
id Integer data. Ex: 2673   false false true true integer
meta Unicode string data. Ex: “Hello World” {} false false true false string
name Unicode string data. Ex: “Hello World” n/a false true false false string
notes Unicode string data. Ex: “Hello World”   false false true false string
path Unicode string data. Ex: “Hello World” n/a false false false false string
publisher A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
type Unicode string data. Ex: “Hello World”   false false true false string
upload_date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a false true false false datetime
upload_id Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/content/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 35
    },
    "objects": [
        {
            "application_tags": "",
            "contentupload": "/rundb/api/v1/contentupload/22/",
            "description": "",
            "enabled": true,
            "extra": "AmpliSeq_Mouse_Transcriptome_v1",
            "file": "/results/uploads/BED/22/AmpliSeq_Mouse_Transcriptome_v1/merged/detail/AmpliSeq_Mouse_Transcriptome_V1_Designed.bed",
            "id": 36,
            "meta": {
                "description": "",
                "enabled": true,
                "hotspot": false,
                "is_ampliseq": false,
                "notes": "",
                "num_bases": 2201026,
                "num_genes": 23930,
                "num_targets": 23930,
                "pre_process_files": [
                    "/results/uploads/BED/22/AmpliSeq_Mouse_Transcriptome_V1_Designed.bed"
                ],
                "reference": "AmpliSeq_Mouse_Transcriptome_v1",
                "upload_date": "2018-08-02T21:43:45",
                "username": "ionadmin"
            },
            "name": "AmpliSeq_Mouse_Transcriptome_V1_Designed.bed",
            "notes": "",
            "path": "/AmpliSeq_Mouse_Transcriptome_v1/merged/detail/AmpliSeq_Mouse_Transcriptome_V1_Designed.bed",
            "publisher": "/rundb/api/v1/publisher/BED/",
            "resource_uri": "/rundb/api/v1/content/36/",
            "type": "target",
            "upload_date": "2018-08-02T21:43:45.000649+00:00",
            "upload_id": "22"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Content Upload Resource

Resource URL http://mytorrentserver/rundb/api/v1/contentupload/
Schema URL http://mytorrentserver/rundb/api/v1/contentupload/schema/

Resource Fields
field help text default nullable readonly blank unique type
file_path Unicode string data. Ex: “Hello World” n/a false false false false string
id Integer data. Ex: 2673   false false true true integer
meta Unicode string data. Ex: “Hello World” {} false false true false string
name Unicode string data. Ex: “Hello World” n/a false true false false string
pub Unicode string data. Ex: “Hello World” n/a false true false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
source Unicode string data. Ex: “Hello World”   false false true false string
status Unicode string data. Ex: “Hello World”   false false true false string
upload_date A date & time as a string. Ex: “2010-11-10T03:07:43” true true false false false datetime
upload_type Unicode string data. Ex: “Hello World”   false false true false string
username Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/contentupload/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 21
    },
    "objects": [
        {
            "file_path": "/results/uploads/BED/22/AmpliSeq_Mouse_Transcriptome_V1_Designed.bed",
            "id": 22,
            "meta": {
                "description": "",
                "enabled": true,
                "hotspot": false,
                "is_ampliseq": false,
                "notes": "",
                "num_bases": 2201026,
                "num_genes": 23930,
                "num_targets": 23930,
                "pre_process_files": [
                    "/results/uploads/BED/22/AmpliSeq_Mouse_Transcriptome_V1_Designed.bed"
                ],
                "reference": "AmpliSeq_Mouse_Transcriptome_v1",
                "upload_date": "2018-08-02T21:43:45",
                "username": "ionadmin"
            },
            "name": "AmpliSeq_Mouse_Transcriptome_V1_Designed.bed",
            "pub": "BED",
            "resource_uri": "/rundb/api/v1/contentupload/22/",
            "source": "",
            "status": "Successfully Completed",
            "upload_date": "2018-08-02T21:43:45.000649+00:00",
            "upload_type": "target",
            "username": "ionadmin"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Data Management History Resource

Resource URL http://mytorrentserver/rundb/api/v1/datamanagementhistory/
Schema URL http://mytorrentserver/rundb/api/v1/datamanagementhistory/schema/

Resource Fields
field help text default nullable readonly blank unique type
created A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
id Integer data. Ex: 2673   false false true true integer
object_pk Integer data. Ex: 2673 n/a false false false false integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultsName Unicode string data. Ex: “Hello World” n/a true true false false string
text Unicode string data. Ex: “Hello World”   false false false false string
username Unicode string data. Ex: “Hello World” ION false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/datamanagementhistory/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 36
    },
    "objects": [
        {
            "created": "2018-05-29T17:32:06.000459+00:00",
            "id": 59,
            "object_pk": 7,
            "resource_uri": "/rundb/api/v1/datamanagementhistory/59/",
            "resultsName": "CA_Combined_demo_001",
            "text": "Src Dir not found: /results/analysis/output/Home/CA_Combined_demo_001_007. Setting action_state to Deleted",
            "username": "dm_agent"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Dna Barcode Resource

Resource URL http://mytorrentserver/rundb/api/v1/dnabarcode/
Schema URL http://mytorrentserver/rundb/api/v1/dnabarcode/schema/

Resource Fields
field help text default nullable readonly blank unique type
active Boolean data. Ex: True true false false true false boolean
adapter Unicode string data. Ex: “Hello World”   false false true false string
annotation Unicode string data. Ex: “Hello World”   false false true false string
end_adapter Unicode string data. Ex: “Hello World”   false false true false string
end_sequence Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
id_str Unicode string data. Ex: “Hello World” n/a false false false false string
index Integer data. Ex: 2673 n/a false false false false integer
is_end_barcode Boolean data. Ex: True false false false true false boolean
length Integer data. Ex: 2673 0 false false true false integer
name Unicode string data. Ex: “Hello World” n/a false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
score_cutoff Floating point numeric data. Ex: 26.73 0 false false false false float
score_mode Integer data. Ex: 2673 0 false false true false integer
sequence Unicode string data. Ex: “Hello World” n/a false false false false string
system Boolean data. Ex: True false false false true false boolean
type Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/dnabarcode/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2090
    },
    "objects": [
        {
            "active": true,
            "adapter": "GGTGAT",
            "annotation": "IonCode_0196--IonOmega_444A",
            "end_adapter": "CTGAG",
            "end_sequence": "TATTCACAGCGC",
            "id": 4043,
            "id_str": "IonDual_H12_0196",
            "index": 96,
            "is_end_barcode": false,
            "length": 12,
            "name": "Ion Dual Barcode Kit 1-96",
            "resource_uri": "/rundb/api/v1/dnabarcode/4043/",
            "score_cutoff": 0,
            "score_mode": 0,
            "sequence": "CTAACAATTCAC",
            "system": true,
            "type": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Email Address Resource

Resource URL http://mytorrentserver/rundb/api/v1/emailaddress/
Schema URL http://mytorrentserver/rundb/api/v1/emailaddress/schema/

Resource Fields
field help text default nullable readonly blank unique type
email Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
selected Boolean data. Ex: True   false false true false boolean
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 0
    },
    "objects": []
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Event Log Resource

Resource URL http://mytorrentserver/rundb/api/v1/eventlog/
Schema URL http://mytorrentserver/rundb/api/v1/eventlog/schema/

Resource Fields
field help text default nullable readonly blank unique type
created A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
id Integer data. Ex: 2673   false false true true integer
object_pk Integer data. Ex: 2673 n/a false false false false integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
text Unicode string data. Ex: “Hello World”   false false false false string
username Unicode string data. Ex: “Hello World” ION false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/eventlog/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 57
    },
    "objects": [
        {
            "created": "2018-08-02T18:54:44.000330+00:00",
            "id": 60,
            "object_pk": 144,
            "resource_uri": "/rundb/api/v1/eventlog/60/",
            "text": "Created Planned Run: Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression (144)",
            "username": "ionadmin"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Experiment Resource

Resource URL http://mytorrentserver/rundb/api/v1/experiment/
Schema URL http://mytorrentserver/rundb/api/v1/experiment/schema/

Resource Fields
field help text default nullable readonly blank unique type
autoAnalyze Boolean data. Ex: True true false false true false boolean
baselineRun Boolean data. Ex: True false false false true false boolean
chefChipExpiration1 Unicode string data. Ex: “Hello World”   false false true false string
chefChipExpiration2 Unicode string data. Ex: “Hello World”   false false true false string
chefChipType1 Unicode string data. Ex: “Hello World”   false false true false string
chefChipType2 Unicode string data. Ex: “Hello World”   false false true false string
chefEndTime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
chefExtraInfo_1 Unicode string data. Ex: “Hello World”   false false true false string
chefExtraInfo_2 Unicode string data. Ex: “Hello World”   false false true false string
chefFlexibleWorkflow Unicode string data. Ex: “Hello World”   false false true false string
chefInstrumentName Unicode string data. Ex: “Hello World”   false false true false string
chefKitType Unicode string data. Ex: “Hello World”   false false true false string
chefLastUpdate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
chefLogPath Unicode string data. Ex: “Hello World” n/a true false false false string
chefLotNumber Unicode string data. Ex: “Hello World”   false false true false string
chefManufactureDate Unicode string data. Ex: “Hello World”   false false true false string
chefMessage Unicode string data. Ex: “Hello World”   false false true false string
chefOperationMode Unicode string data. Ex: “Hello World”   false false true false string
chefPackageVer Unicode string data. Ex: “Hello World”   false false true false string
chefProgress Floating point numeric data. Ex: 26.73 0 false false true false float
chefProtocolDeviationName Unicode string data. Ex: “Hello World” n/a true false false false string
chefReagentID Unicode string data. Ex: “Hello World”   false false true false string
chefReagentsExpiration Unicode string data. Ex: “Hello World”   false false true false string
chefReagentsLot Unicode string data. Ex: “Hello World”   false false true false string
chefReagentsPart Unicode string data. Ex: “Hello World”   false false true false string
chefReagentsSerialNum Unicode string data. Ex: “Hello World”   false false true false string
chefRemainingSeconds Integer data. Ex: 2673 n/a true false false false integer
chefSamplePos Unicode string data. Ex: “Hello World”   false false true false string
chefScriptVersion Unicode string data. Ex: “Hello World”   false false true false string
chefSolutionsExpiration Unicode string data. Ex: “Hello World”   false false true false string
chefSolutionsLot Unicode string data. Ex: “Hello World”   false false true false string
chefSolutionsPart Unicode string data. Ex: “Hello World”   false false true false string
chefSolutionsSerialNum Unicode string data. Ex: “Hello World”   false false true false string
chefStartTime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
chefStatus Unicode string data. Ex: “Hello World”   false false true false string
chefTipRackBarcode Unicode string data. Ex: “Hello World”   false false true false string
chipBarcode Unicode string data. Ex: “Hello World”   false false true false string
chipType Unicode string data. Ex: “Hello World” n/a false false false false string
cycles Integer data. Ex: 2673 n/a false false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a false false false false datetime
diskusage Integer data. Ex: 2673 n/a true false false false integer
displayName Unicode string data. Ex: “Hello World”   false false false false string
eas_set Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
expCompInfo Unicode string data. Ex: “Hello World”   false false true false string
expDir Unicode string data. Ex: “Hello World” n/a false false false false string
expName Unicode string data. Ex: “Hello World” n/a false false false false string
flows Integer data. Ex: 2673 n/a false false false false integer
flowsInOrder Unicode string data. Ex: “Hello World”   false false true false string
ftpStatus Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
isProton Unicode string data. Ex: “Hello World” n/a false true false false string
isReverseRun Boolean data. Ex: True false false false true false boolean
log Unicode string data. Ex: “Hello World” {} false false true false string
metaData Unicode string data. Ex: “Hello World” {} false false true false string
notes Unicode string data. Ex: “Hello World” n/a true false false false string
pgmName Unicode string data. Ex: “Hello World” n/a false false false false string
pinnedRepResult Boolean data. Ex: True false false false true false boolean
plan A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
platform Unicode string data. Ex: “Hello World”   false false true false string
rawdatastyle Unicode string data. Ex: “Hello World” single true false false false string
reagentBarcode Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultDate A date & time as a string. Ex: “2010-11-10T03:07:43” true true false false false datetime
results Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runtype Unicode string data. Ex: “Hello World” n/a false false false false string
sample Unicode string data. Ex: “Hello World” n/a false true true false string
samples Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
seqKitBarcode Unicode string data. Ex: “Hello World”   false false true false string
sequencekitbarcode Unicode string data. Ex: “Hello World” n/a true false false false string
sequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
star Boolean data. Ex: True false false false true false boolean
status Unicode string data. Ex: “Hello World”   false false true false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
unique Unicode string data. Ex: “Hello World” n/a false false false true string
usePreBeadfind Boolean data. Ex: True true false false true false boolean
user_ack Unicode string data. Ex: “Hello World” U false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/experiment/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 136
    },
    "objects": [
        {
            "autoAnalyze": true,
            "baselineRun": false,
            "chefChipExpiration1": "",
            "chefChipExpiration2": "",
            "chefChipType1": "",
            "chefChipType2": "",
            "chefEndTime": null,
            "chefExtraInfo_1": "",
            "chefExtraInfo_2": "",
            "chefFlexibleWorkflow": "",
            "chefInstrumentName": "",
            "chefKitType": "",
            "chefLastUpdate": null,
            "chefLogPath": null,
            "chefLotNumber": "",
            "chefManufactureDate": "",
            "chefMessage": "",
            "chefOperationMode": "",
            "chefPackageVer": "",
            "chefProgress": 0,
            "chefProtocolDeviationName": null,
            "chefReagentID": "",
            "chefReagentsExpiration": "",
            "chefReagentsLot": "",
            "chefReagentsPart": "",
            "chefReagentsSerialNum": "",
            "chefRemainingSeconds": null,
            "chefSamplePos": "",
            "chefScriptVersion": "",
            "chefSolutionsExpiration": "",
            "chefSolutionsLot": "",
            "chefSolutionsPart": "",
            "chefSolutionsSerialNum": "",
            "chefStartTime": null,
            "chefStatus": "",
            "chefTipRackBarcode": "",
            "chipBarcode": "",
            "chipType": "530",
            "cycles": 0,
            "date": "2019-10-03T20:53:08.000599+00:00",
            "diskusage": 0,
            "displayName": "aa9309c5-5922-49f3-b901-987383b03e57",
            "eas_set": [
                {
                    "alignmentargs": "",
                    "analysisargs": "",
                    "barcodeKitName": "Ion Dual Barcode Kit 1-96",
                    "barcodedSamples": {},
                    "base_recalibration_mode": "standard_recal",
                    "basecallerargs": "",
                    "beadfindargs": "",
                    "calibrateargs": "",
                    "custom_args": false,
                    "date": "2019-10-03T20:53:08.000599+00:00",
                    "endBarcodeKitName": "",
                    "experiment": "/rundb/api/v1/experiment/163/",
                    "hotSpotRegionBedFile": "",
                    "id": 162,
                    "ionstatsargs": "",
                    "isDuplicateReads": false,
                    "isEditable": true,
                    "isOneTimeOverride": false,
                    "libraryKey": "TCAG",
                    "libraryKitBarcode": null,
                    "libraryKitName": "Ion AmpliSeq Library Kit Plus",
                    "mixedTypeRNA_hotSpotRegionBedFile": null,
                    "mixedTypeRNA_reference": null,
                    "mixedTypeRNA_targetRegionBedFile": null,
                    "prebasecallerargs": "",
                    "prethumbnailbasecallerargs": "",
                    "realign": false,
                    "reference": "",
                    "resource_uri": "/rundb/api/v1/experimentanalysissettings/162/",
                    "results": [],
                    "selectedPlugins": {},
                    "sseBedFile": "",
                    "status": "inactive",
                    "targetRegionBedFile": "",
                    "tfKey": "ATCG",
                    "threePrimeAdapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
                    "thumbnailalignmentargs": "",
                    "thumbnailanalysisargs": "",
                    "thumbnailbasecallerargs": "",
                    "thumbnailbeadfindargs": "",
                    "thumbnailcalibrateargs": "",
                    "thumbnailionstatsargs": ""
                }
            ],
            "expCompInfo": "",
            "expDir": "",
            "expName": "aa9309c5-5922-49f3-b901-987383b03e57",
            "flows": 500,
            "flowsInOrder": "",
            "ftpStatus": "",
            "id": 163,
            "isProton": "False",
            "isReverseRun": false,
            "log": {},
            "metaData": {},
            "notes": "",
            "pgmName": "",
            "pinnedRepResult": false,
            "plan": "/rundb/api/v1/plannedexperiment/170/",
            "platform": "S5",
            "rawdatastyle": "single",
            "reagentBarcode": "",
            "resource_uri": "/rundb/api/v1/experiment/163/",
            "resultDate": "2019-10-03T20:53:08.000620+00:00",
            "results": [],
            "reverse_primer": null,
            "runMode": "single",
            "runtype": "GENS",
            "sample": "",
            "samples": [],
            "seqKitBarcode": "",
            "sequencekitbarcode": "",
            "sequencekitname": "Ion S5 Sequencing Kit",
            "star": false,
            "status": "inactive",
            "storageHost": "",
            "storage_options": "A",
            "unique": "aa9309c5-5922-49f3-b901-987383b03e57",
            "usePreBeadfind": true,
            "user_ack": "U"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • PATCH
  • PUT
  • DELETE
Allowed detail HTTP methods
  • GET
  • PATCH
  • PUT
  • DELETE

Experiment Analysis Settings Resource

Resource URL http://mytorrentserver/rundb/api/v1/experimentanalysissettings/
Schema URL http://mytorrentserver/rundb/api/v1/experimentanalysissettings/schema/

Resource Fields
field help text default nullable readonly blank unique type
alignmentargs Unicode string data. Ex: “Hello World”   false false true false string
analysisargs Unicode string data. Ex: “Hello World”   false false true false string
barcodeKitName Unicode string data. Ex: “Hello World” n/a true false false false string
barcodedSamples Unicode string data. Ex: “Hello World” {} true false false false string
base_recalibration_mode Unicode string data. Ex: “Hello World” standard_recal false false false false string
basecallerargs Unicode string data. Ex: “Hello World”   false false true false string
beadfindargs Unicode string data. Ex: “Hello World”   false false true false string
calibrateargs Unicode string data. Ex: “Hello World”   false false true false string
custom_args Boolean data. Ex: True false false false true false boolean
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
endBarcodeKitName Unicode string data. Ex: “Hello World”   true false false false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
hotSpotRegionBedFile Unicode string data. Ex: “Hello World” n/a true false false false string
id Integer data. Ex: 2673   false false true true integer
ionstatsargs Unicode string data. Ex: “Hello World”   false false true false string
isDuplicateReads Boolean data. Ex: True false false false true false boolean
isEditable Boolean data. Ex: True false false false true false boolean
isOneTimeOverride Boolean data. Ex: True false false false true false boolean
libraryKey Unicode string data. Ex: “Hello World”   false false true false string
libraryKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
libraryKitName Unicode string data. Ex: “Hello World” n/a true false false false string
mixedTypeRNA_hotSpotRegionBedFile Unicode string data. Ex: “Hello World” n/a true false false false string
mixedTypeRNA_reference Unicode string data. Ex: “Hello World” n/a true false false false string
mixedTypeRNA_targetRegionBedFile Unicode string data. Ex: “Hello World” n/a true false false false string
prebasecallerargs Unicode string data. Ex: “Hello World”   false false true false string
prethumbnailbasecallerargs Unicode string data. Ex: “Hello World”   false false true false string
realign Boolean data. Ex: True false false false true false boolean
reference Unicode string data. Ex: “Hello World” n/a true false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
results Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
selectedPlugins Unicode string data. Ex: “Hello World” {} true false false false string
sseBedFile Unicode string data. Ex: “Hello World”   true false false false string
status Unicode string data. Ex: “Hello World”   false false true false string
targetRegionBedFile Unicode string data. Ex: “Hello World” n/a true false false false string
tfKey Unicode string data. Ex: “Hello World”   false false true false string
threePrimeAdapter Unicode string data. Ex: “Hello World” n/a true false false false string
thumbnailalignmentargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailanalysisargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailbasecallerargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailbeadfindargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailcalibrateargs Unicode string data. Ex: “Hello World”   false false true false string
thumbnailionstatsargs Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/experimentanalysissettings/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 136
    },
    "objects": [
        {
            "alignmentargs": "",
            "analysisargs": "",
            "barcodeKitName": "Ion Dual Barcode Kit 1-96",
            "barcodedSamples": {},
            "base_recalibration_mode": "standard_recal",
            "basecallerargs": "",
            "beadfindargs": "",
            "calibrateargs": "",
            "custom_args": false,
            "date": "2019-10-03T20:53:08.000599+00:00",
            "endBarcodeKitName": "",
            "experiment": "/rundb/api/v1/experiment/163/",
            "hotSpotRegionBedFile": "",
            "id": 162,
            "ionstatsargs": "",
            "isDuplicateReads": false,
            "isEditable": true,
            "isOneTimeOverride": false,
            "libraryKey": "TCAG",
            "libraryKitBarcode": null,
            "libraryKitName": "Ion AmpliSeq Library Kit Plus",
            "mixedTypeRNA_hotSpotRegionBedFile": null,
            "mixedTypeRNA_reference": null,
            "mixedTypeRNA_targetRegionBedFile": null,
            "prebasecallerargs": "",
            "prethumbnailbasecallerargs": "",
            "realign": false,
            "reference": "",
            "resource_uri": "/rundb/api/v1/experimentanalysissettings/162/",
            "results": [],
            "selectedPlugins": {},
            "sseBedFile": "",
            "status": "inactive",
            "targetRegionBedFile": "",
            "tfKey": "ATCG",
            "threePrimeAdapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
            "thumbnailalignmentargs": "",
            "thumbnailanalysisargs": "",
            "thumbnailbasecallerargs": "",
            "thumbnailbeadfindargs": "",
            "thumbnailcalibrateargs": "",
            "thumbnailionstatsargs": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

File Monitor Resource

Resource URL http://mytorrentserver/rundb/api/v1/filemonitor/
Schema URL http://mytorrentserver/rundb/api/v1/filemonitor/schema/

Resource Fields
field help text default nullable readonly blank unique type
celery_task_id Unicode string data. Ex: “Hello World”   false false true false string
created A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
id Integer data. Ex: 2673   false false true true integer
local_dir Unicode string data. Ex: “Hello World”   false false false false string
md5sum Unicode string data. Ex: “Hello World” None true false false false string
name Unicode string data. Ex: “Hello World”   false false false false string
progress Unicode string data. Ex: “Hello World” 0 false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
size Unicode string data. Ex: “Hello World” None true false false false string
status Unicode string data. Ex: “Hello World”   false false false false string
tags Unicode string data. Ex: “Hello World”   false false false false string
updated A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
url Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/filemonitor/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 9
    },
    "objects": [
        {
            "celery_task_id": "9791ab17-8fb1-409e-ab9f-1f02d8f0a256",
            "created": "2018-08-02T23:10:55.000145+00:00",
            "id": 11,
            "local_dir": "/results/referenceLibrary/temp/tmpBar9cj",
            "md5sum": null,
            "name": "mm10.zip",
            "progress": "4080979909",
            "resource_uri": "/rundb/api/v1/filemonitor/11/",
            "size": "4080979909",
            "status": "Complete",
            "tags": "reference",
            "updated": "2018-08-02T23:12:07.000540+00:00",
            "url": "http://updates.itw/internal_reference_downloads/mm10.zip"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

File Server Resource

Resource URL http://mytorrentserver/rundb/api/v1/fileserver/
Schema URL http://mytorrentserver/rundb/api/v1/fileserver/schema/

Resource Fields
field help text default nullable readonly blank unique type
comments Unicode string data. Ex: “Hello World”   false false true false string
filesPrefix Unicode string data. Ex: “Hello World” n/a false false false false string
id Integer data. Ex: 2673   false false true true integer
name Unicode string data. Ex: “Hello World” n/a false false false false string
percentfull Floating point numeric data. Ex: 26.73 0 true false false false float
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "comments": "",
            "filesPrefix": "/results/",
            "id": 1,
            "name": "Home",
            "percentfull": 40.1362957221239,
            "resource_uri": "/rundb/api/v1/fileserver/1/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Flow Order Resource

Resource URL http://mytorrentserver/rundb/api/v1/floworder/
Schema URL http://mytorrentserver/rundb/api/v1/floworder/schema/

Resource Fields
field help text default nullable readonly blank unique type
description Unicode string data. Ex: “Hello World”   false false true false string
flowOrder Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
isDefault Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
name Unicode string data. Ex: “Hello World” n/a false false false true string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/floworder/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 7
    },
    "objects": [
        {
            "description": "Ion samba.c.2step.pgs flow order",
            "flowOrder": "TACGTACGTCTGAGCATCGGATCGCGATGTACAGCTACGTACGGAGTCTAGCTGACGTACGTCATGTGCATCGATCAGCTAGCTGACGTAGCTAGCATCGATCAGTCATGACTGACGTAGCTGACTGATCAGTCATGCATCGTACGTACGTAGCTGACGTACGTCATGCATCGATCAGCTAGCTGACGTAGCTAGCATCGATCAGTCATGACTGACGTAGCTGACTGATCAGTCATGCATCGTACGTACGTAGCTGACGTACGTCATGCATCGATCAGCTAGCTGACGTAGCTAGCATCGATCAGTCATGACTGACGTAGCTGACTGATCAGTCATGCATCG",
            "id": 7,
            "isActive": true,
            "isDefault": false,
            "isSystem": true,
            "name": "Ion samba.c.2step.pgs",
            "resource_uri": "/rundb/api/v1/floworder/7/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Get Chef Cartridgeusage Resource

Resource URL http://mytorrentserver/rundb/api/v1/getchefcartridgeusage/
Schema URL http://mytorrentserver/rundb/api/v1/getchefcartridgeusage/schema/

Resource Fields
field help text default nullable readonly blank unique type
hoursSinceSolutionFirstUse Integer number of hours between (oldest associated experiment using Solution) and (chefCurrentTime). Rounded down to the nearest hour is OK. Ex: 24 n/a true true true false Integer
numberSolutionSerialUsage Integer number. No of Solution cartridge Usage Ex: 2 n/a true true true false Integer
errorCodes A lists of data. Ex: [“E200”] or [“W100”, “W200”] n/a true true true false List Object
allowRunToContinue Boolean string data. Ex: “true or false” n/a true true true false boolean
detailMessages A dictionary of data. Ex: {‘E300’: ‘No. of reagent and solution usage do not match’} n/a true true true false dict
numberReagentSerialUsage Integer number. No of Reagent cartridge Usage Ex: 2 n/a true true true false Integer
hoursSinceReagentFirstUse Integer number of hours between (oldest associated experiment using Reagent) and (chefCurrentTime). Rounded down to the nearest hour is OK. Ex: 48 n/a true true true false Integer
Example Response
{
    "allowRunToContinue": false,
    "detailMessages": {
        "E305": "Missing chef inputs filter option ['chefReagentsSerialNum', 'chefSolutionsSerialNum', 'kitName']"
    },
    "errorCodes": [
        "E305"
    ],
    "hoursSinceReagentFirstUse": "",
    "hoursSinceSolutionFirstUse": "",
    "numberReagentSerialUsage": 0,
    "numberSolutionSerialUsage": 0
}
Allowed list HTTP methods
  • GET
Allowed detail HTTP methods

None

Get Chef Script Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/getchefscriptinfo/
Schema URL http://mytorrentserver/rundb/api/v1/getchefscriptinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
availableversion A dictionary of data. Ex: {‘Compatible_Chef_release’: [‘IC.5.4.0’], ‘IS_scripts’: ‘00515’} n/a true true true false dict
Example Response
{
    "object": {
        "availableversion": {
            "Compatible_Chef_release": [
                "IC.5.12.1.RC.1"
            ],
            "IS_scripts": "000905"
        }
    }
}
Allowed list HTTP methods
  • GET
Allowed detail HTTP methods

None

Global Config Resource

Resource URL http://mytorrentserver/rundb/api/v1/globalconfig/
Schema URL http://mytorrentserver/rundb/api/v1/globalconfig/schema/

Resource Fields
field help text default nullable readonly blank unique type
auto_archive_ack Boolean data. Ex: True false false false true false boolean
auto_archive_enable Boolean data. Ex: True false false false true false boolean
base_recalibration_mode Unicode string data. Ex: “Hello World” standard_recal false false false false string
check_news_posts Boolean data. Ex: True true false false true false boolean
cluster_auto_disable Boolean data. Ex: True true false false true false boolean
default_flow_order Unicode string data. Ex: “Hello World”   false false true false string
default_library_key Unicode string data. Ex: “Hello World”   false false true false string
default_storage_options Unicode string data. Ex: “Hello World” D false false true false string
default_test_fragment_key Unicode string data. Ex: “Hello World”   false false true false string
enable_auto_pkg_dl Boolean data. Ex: True true false false true false boolean
enable_auto_security Boolean data. Ex: True true false false true false boolean
enable_compendia_OCP Boolean data. Ex: True false false false true false boolean
enable_nightly_email Boolean data. Ex: True true false false true false boolean
enable_support_upload Boolean data. Ex: True false false false true false boolean
enable_version_lock Boolean data. Ex: True false false false true false boolean
id Integer data. Ex: 2673   false false true true integer
mark_duplicates Boolean data. Ex: True false false false true false boolean
name Unicode string data. Ex: “Hello World” n/a false false false false string
plugin_output_folder Unicode string data. Ex: “Hello World”   false false true false string
realign Boolean data. Ex: True false false false true false boolean
records_to_display Integer data. Ex: 2673 20 false false true false integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sec_update_status Unicode string data. Ex: “Hello World”   false false true false string
selected Boolean data. Ex: True   false false true false boolean
site_name Unicode string data. Ex: “Hello World”   false false true false string
telemetry_enabled Boolean data. Ex: True true false false true false boolean
ts_update_status Unicode string data. Ex: “Hello World”   false false true false string
web_root Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "auto_archive_ack": true,
            "auto_archive_enable": true,
            "base_recalibration_mode": "standard_recal",
            "check_news_posts": true,
            "cluster_auto_disable": true,
            "default_flow_order": "TACG",
            "default_library_key": "TCAG",
            "default_storage_options": "A",
            "default_test_fragment_key": "ATCG",
            "enable_auto_pkg_dl": true,
            "enable_auto_security": true,
            "enable_compendia_OCP": true,
            "enable_nightly_email": true,
            "enable_support_upload": false,
            "enable_version_lock": false,
            "id": 1,
            "mark_duplicates": false,
            "name": "Config",
            "plugin_output_folder": "plugin_out",
            "realign": false,
            "records_to_display": 20,
            "resource_uri": "/rundb/api/v1/globalconfig/1/",
            "sec_update_status": "",
            "selected": false,
            "site_name": "Torrent Server",
            "telemetry_enabled": true,
            "ts_update_status": "No updates",
            "web_root": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Ion Chef Plan Template Resource

Resource URL http://mytorrentserver/rundb/api/v1/ionchefplantemplate/
Schema URL http://mytorrentserver/rundb/api/v1/ionchefplantemplate/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
applicationCategoryDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
applicationGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
applicationGroupDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
autoAnalyze Boolean data. Ex: True n/a false false false false boolean
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
barcodeId Unicode string data. Ex: “Hello World”   true false true false string
barcodedSamples Unicode string data. Ex: “Hello World”   true false true false string
base_recalibration_mode Unicode string data. Ex: “Hello World”   true false true false string
bedfile Unicode string data. Ex: “Hello World”   false false true false string
categories Unicode string data. Ex: “Hello World”   true false false false string
chefInfo A dictionary of data. Ex: {‘price’: 26.73, ‘name’: ‘Daniel’} {} false false false false dict
childPlans A list of data. Ex: [‘abc’, 26.73, 8] [] false false false false list
chipBarcode Unicode string data. Ex: “Hello World”   false false false false string
chipType Unicode string data. Ex: “Hello World”   false false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
earlyDatFileDeletion Boolean data. Ex: True false false true false false boolean
endBarcodeKitName Unicode string data. Ex: “Hello World”   true false true false string
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
flows Integer data. Ex: 2673 0 false false false false integer
flowsInOrder Unicode string data. Ex: “Hello World”   true false true false string
forward3primeadapter Unicode string data. Ex: “Hello World”   true false true false string
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isDuplicateReads Boolean data. Ex: True n/a false false false false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
library Unicode string data. Ex: “Hello World”   true false true false string
libraryKey Unicode string data. Ex: “Hello World”   false false true false string
libraryPrepType Unicode string data. Ex: “Hello World”   true true true false string
libraryPrepTypeDisplayedName Unicode string data. Ex: “Hello World”   true true true false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
librarykitname Unicode string data. Ex: “Hello World”   true false true false string
metaData Unicode string data. Ex: “Hello World” {} false false true false string
mixedTypeRNA_hotSpotRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
mixedTypeRNA_reference Unicode string data. Ex: “Hello World”   true false true false string
mixedTypeRNA_targetRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
notes Unicode string data. Ex: “Hello World”   true false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
parentPlan Unicode string data. Ex: “Hello World” None false false true false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
platform Unicode string data. Ex: “Hello World” n/a true false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
project Unicode string data. Ex: “Hello World” n/a false true true false string
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
qcValues Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
realign Boolean data. Ex: True n/a false false false false boolean
regionfile Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse3primeadapter Unicode string data. Ex: “Hello World”   false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
reverselibrarykey Unicode string data. Ex: “Hello World”   false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
sample Unicode string data. Ex: “Hello World”   true false true false string
sampleDisplayedName Unicode string data. Ex: “Hello World”   true false true false string
sampleGrouping A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleGroupingName Unicode string data. Ex: “Hello World” n/a true true true false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleSetDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
sampleSets Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
selectedPlugins Unicode string data. Ex: “Hello World”   true false true false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
sequencekitname Unicode string data. Ex: “Hello World”   true false true false string
sseBedFile Unicode string data. Ex: “Hello World”   false false true false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
tfKey Unicode string data. Ex: “Hello World”   false false true false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
variantfrequency Unicode string data. Ex: “Hello World”   false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/ionchefplantemplate/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 89
    },
    "objects": [
        {
            "adapter": null,
            "alignmentargs": "",
            "analysisargs": "",
            "applicationCategoryDisplayedName": "Oncology - Solid Tumor",
            "applicationGroup": "/rundb/api/v1/applicationgroup/5/",
            "applicationGroupDisplayedName": "DNA and Fusions (Separate Libraries)",
            "autoAnalyze": true,
            "autoName": null,
            "barcodeId": "Ion Dual Barcode Kit 1-96",
            "barcodedSamples": {},
            "base_recalibration_mode": "standard_recal",
            "basecallerargs": "",
            "beadfindargs": "",
            "bedfile": "",
            "calibrateargs": "",
            "categories": "Oncomine;onco_solidTumor;barcodes_8;p4o",
            "chefInfo": {},
            "childPlans": [],
            "chipBarcode": "",
            "chipType": "530",
            "controlSequencekitname": null,
            "custom_args": false,
            "cycles": null,
            "date": "2019-10-03T20:53:08.000623+00:00",
            "earlyDatFileDeletion": false,
            "endBarcodeKitName": "",
            "expName": "",
            "experiment": "/rundb/api/v1/experiment/163/",
            "flows": 500,
            "flowsInOrder": "",
            "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
            "id": 170,
            "ionstatsargs": "",
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isDuplicateReads": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": true,
            "isReverseRun": false,
            "isSystem": true,
            "isSystemDefault": false,
            "libkit": null,
            "library": "",
            "libraryKey": "TCAG",
            "libraryPrepType": "",
            "libraryPrepTypeDisplayedName": "",
            "libraryReadLength": 200,
            "librarykitname": "Ion AmpliSeq Library Kit Plus",
            "metaData": {},
            "mixedTypeRNA_hotSpotRegionBedFile": null,
            "mixedTypeRNA_reference": null,
            "mixedTypeRNA_targetRegionBedFile": null,
            "notes": "",
            "origin": "|5.12.1",
            "pairedEndLibraryAdapterName": null,
            "parentPlan": null,
            "planDisplayedName": "Oncomine Tumor Specific Fusions",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "aa9309c5-5922-49f3-b901-987383b03e57",
            "planName": "Oncomine_Tumor_Specific_Fusions",
            "planPGM": "",
            "planShortID": "OZT4F",
            "planStatus": "inactive",
            "platform": "S5",
            "preAnalysis": true,
            "prebasecallerargs": "",
            "prethumbnailbasecallerargs": "",
            "project": "",
            "projects": [],
            "qcValues": [
                {
                    "id": 487,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 1,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Bead Loading (%)",
                        "resource_uri": "/rundb/api/v1/qctype/1/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/487/",
                    "threshold": 30
                },
                {
                    "id": 488,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 2,
                        "maxThreshold": 100,
                        "minThreshold": 1,
                        "qcName": "Key Signal (1-100)",
                        "resource_uri": "/rundb/api/v1/qctype/2/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/488/",
                    "threshold": 30
                },
                {
                    "id": 489,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 3,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Usable Sequence (%)",
                        "resource_uri": "/rundb/api/v1/qctype/3/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/489/",
                    "threshold": 30
                }
            ],
            "realign": false,
            "regionfile": "",
            "resource_uri": "/rundb/api/v1/ionchefplantemplate/170/",
            "reverse3primeadapter": "",
            "reverse_primer": null,
            "reverselibrarykey": "",
            "runMode": "single",
            "runType": "AMPS_RNA",
            "runname": null,
            "sample": "",
            "sampleDisplayedName": "",
            "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/7/",
            "sampleGroupingName": "Single Fusions",
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleSetDisplayedName": "",
            "sampleSets": [],
            "sampleTubeLabel": null,
            "selectedPlugins": {},
            "seqKitBarcode": null,
            "sequencekitname": "Ion S5 Sequencing Kit",
            "sseBedFile": "",
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion Chef S530 V2",
            "tfKey": "ATCG",
            "thumbnailalignmentargs": "",
            "thumbnailanalysisargs": "",
            "thumbnailbasecallerargs": "",
            "thumbnailbeadfindargs": "",
            "thumbnailcalibrateargs": "",
            "thumbnailionstatsargs": "",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": null,
            "variantfrequency": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Ion Chef Plan Template Summary Resource

Resource URL http://mytorrentserver/rundb/api/v1/ionchefplantemplatesummary/
Schema URL http://mytorrentserver/rundb/api/v1/ionchefplantemplatesummary/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
categories Unicode string data. Ex: “Hello World”   true false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
expName Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
metaData Unicode string data. Ex: “Hello World” {} false false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/ionchefplantemplatesummary/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 89
    },
    "objects": [
        {
            "adapter": null,
            "autoName": null,
            "categories": "Oncomine;onco_solidTumor;barcodes_8;p4o",
            "controlSequencekitname": null,
            "cycles": null,
            "date": "2019-10-03T20:53:08.000623+00:00",
            "expName": "",
            "id": 170,
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": true,
            "isReverseRun": false,
            "isSystem": true,
            "isSystemDefault": false,
            "libkit": null,
            "libraryReadLength": 200,
            "metaData": {},
            "origin": "|5.12.1",
            "pairedEndLibraryAdapterName": null,
            "planDisplayedName": "Oncomine Tumor Specific Fusions",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "aa9309c5-5922-49f3-b901-987383b03e57",
            "planName": "Oncomine_Tumor_Specific_Fusions",
            "planPGM": "",
            "planShortID": "OZT4F",
            "planStatus": "inactive",
            "preAnalysis": true,
            "resource_uri": "/rundb/api/v1/ionchefplantemplatesummary/170/",
            "reverse_primer": null,
            "runMode": "single",
            "runType": "AMPS_RNA",
            "runname": null,
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleTubeLabel": null,
            "seqKitBarcode": null,
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion Chef S530 V2",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": null
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Ion Chef Prep Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/ionchefprepkitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/ionchefprepkitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/ionchefprepkitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 13
    },
    "objects": [
        {
            "applicationType": "",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": 30,
            "cartridgeExpirationDayLimit": 8,
            "categories": "s5v1Kit;",
            "chipTypes": "550;560;GX7v1",
            "defaultCartridgeUsageCount": 2,
            "description": "Ion 550 Kit-Chef",
            "flowCount": 500,
            "id": 20113,
            "instrumentType": "S5",
            "isActive": true,
            "kitType": "IonChefPrepKit",
            "libraryReadLength": 200,
            "name": "Ion Chef S550 V1",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A34540",
                    "id": 20264,
                    "kit": "/rundb/api/v1/kitinfo/20113/",
                    "resource_uri": "/rundb/api/v1/kitpart/20264/"
                },
                {
                    "barcode": "A34540C",
                    "id": 20265,
                    "kit": "/rundb/api/v1/kitinfo/20113/",
                    "resource_uri": "/rundb/api/v1/kitpart/20265/"
                }
            ],
            "resource_uri": "/rundb/api/v1/ionchefprepkitinfo/20113/",
            "runMode": "",
            "samplePrep_instrumentType": "IC",
            "uid": "ICPREP0014"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Ion Mesh Node Resource

Resource URL http://mytorrentserver/rundb/api/v1/ionmeshnode/
Schema URL http://mytorrentserver/rundb/api/v1/ionmeshnode/schema/

Resource Fields
field help text default nullable readonly blank unique type
active Boolean data. Ex: True true false false true false boolean
apikey_local Unicode string data. Ex: “Hello World” n/a true false false false string
apikey_remote Unicode string data. Ex: “Hello World” n/a true false false false string
hostname Unicode string data. Ex: “Hello World” n/a false false false true string
id Integer data. Ex: 2673   false false true true integer
name Unicode string data. Ex: “Hello World” n/a true false false true string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
system_id Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/ionmeshnode/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 4
    },
    "objects": [
        {
            "active": true,
            "apikey_local": "cc85a45c95e2079ecdec862bbd92a2ec904ee129",
            "apikey_remote": "e448e2cecc9b7e9e0d6a54aeae9ad3ac588cd75e",
            "hostname": "hawk.itw",
            "id": 10,
            "name": "hawk.itw",
            "resource_uri": "/rundb/api/v1/ionmeshnode/10/",
            "system_id": "4C4C4544-0033-4610-8043-B6C04F383432"
        }
    ]
}
Allowed list HTTP methods
  • PATCH
  • GET
  • DELETE
Allowed detail HTTP methods
  • PATCH
  • GET
  • DELETE

Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/kitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/kitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
defaultFlowOrder A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/kitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 113
    },
    "objects": [
        {
            "applicationType": "AMPS",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "carrierSeq",
            "chipTypes": "550",
            "defaultCartridgeUsageCount": null,
            "defaultFlowOrder": null,
            "description": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "flowCount": 0,
            "id": 20118,
            "instrumentType": "",
            "isActive": true,
            "kitType": "LibraryKit",
            "libraryReadLength": 0,
            "name": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A43587",
                    "id": 20269,
                    "kit": "/rundb/api/v1/kitinfo/20118/",
                    "resource_uri": "/rundb/api/v1/kitpart/20269/"
                }
            ],
            "resource_uri": "/rundb/api/v1/kitinfo/20118/",
            "runMode": "",
            "samplePrep_instrumentType": "",
            "uid": "LIB0030"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Kit Part Resource

Resource URL http://mytorrentserver/rundb/api/v1/kitpart/
Schema URL http://mytorrentserver/rundb/api/v1/kitpart/schema/

Resource Fields
field help text default nullable readonly blank unique type
barcode Unicode string data. Ex: “Hello World” n/a false false false true string
id Integer data. Ex: 2673   false false true true integer
kit A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/kitpart/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 253
    },
    "objects": [
        {
            "barcode": "A43587",
            "id": 20269,
            "kit": "/rundb/api/v1/kitinfo/20118/",
            "resource_uri": "/rundb/api/v1/kitpart/20269/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Lib Metrics Resource

Resource URL http://mytorrentserver/rundb/api/v1/libmetrics/
Schema URL http://mytorrentserver/rundb/api/v1/libmetrics/schema/

Resource Fields
field help text default nullable readonly blank unique type
Genome_Version Unicode string data. Ex: “Hello World” n/a false false false false string
Index_Version Unicode string data. Ex: “Hello World” n/a false false false false string
align_sample Integer data. Ex: 2673 n/a false false false false integer
aveKeyCounts Floating point numeric data. Ex: 26.73 n/a false false false false float
cf Floating point numeric data. Ex: 26.73 n/a false false false false float
dr Floating point numeric data. Ex: 26.73 n/a false false false false float
duplicate_reads Integer data. Ex: 2673 n/a true false false false integer
genome Unicode string data. Ex: “Hello World” n/a false false false false string
genomesize Unicode string data. Ex: “Hello World” n/a false false false false string
i100Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i100Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i100Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i100Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i100Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i150Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i150Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i150Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i150Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i150Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i200Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i200Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i200Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i200Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i200Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i250Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i250Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i250Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i250Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i250Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i300Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i300Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i300Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i300Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i300Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i350Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i350Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i350Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i350Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i350Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i400Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i400Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i400Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i400Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i400Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i450Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i450Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i450Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i450Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i450Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i500Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i500Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i500Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i500Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i500Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i50Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i50Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i50Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i50Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i50Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i550Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i550Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i550Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i550Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i550Q7_reads Integer data. Ex: 2673 n/a false false false false integer
i600Q10_reads Integer data. Ex: 2673 n/a false false false false integer
i600Q17_reads Integer data. Ex: 2673 n/a false false false false integer
i600Q20_reads Integer data. Ex: 2673 n/a false false false false integer
i600Q47_reads Integer data. Ex: 2673 n/a false false false false integer
i600Q7_reads Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
ie Floating point numeric data. Ex: 26.73 n/a false false false false float
q10_alignments Integer data. Ex: 2673 n/a false false false false integer
q10_longest_alignment Integer data. Ex: 2673 n/a false false false false integer
q10_mapped_bases Unicode string data. Ex: “Hello World” n/a false false false false string
q10_mean_alignment_length Integer data. Ex: 2673 n/a false false false false integer
q17_alignments Integer data. Ex: 2673 n/a false false false false integer
q17_longest_alignment Integer data. Ex: 2673 n/a false false false false integer
q17_mapped_bases Unicode string data. Ex: “Hello World” n/a false false false false string
q17_mean_alignment_length Integer data. Ex: 2673 n/a false false false false integer
q20_alignments Integer data. Ex: 2673 n/a false false false false integer
q20_longest_alignment Integer data. Ex: 2673 n/a false false false false integer
q20_mapped_bases Unicode string data. Ex: “Hello World” n/a false false false false string
q20_mean_alignment_length Integer data. Ex: 2673 n/a false false false false integer
q47_alignments Integer data. Ex: 2673 n/a false false false false integer
q47_longest_alignment Integer data. Ex: 2673 n/a false false false false integer
q47_mapped_bases Unicode string data. Ex: “Hello World” n/a false false false false string
q47_mean_alignment_length Integer data. Ex: 2673 n/a false false false false integer
q7_alignments Integer data. Ex: 2673 n/a false false false false integer
q7_longest_alignment Integer data. Ex: 2673 n/a false false false false integer
q7_mapped_bases Unicode string data. Ex: “Hello World” n/a false false false false string
q7_mean_alignment_length Integer data. Ex: 2673 n/a false false false false integer
raw_accuracy Floating point numeric data. Ex: 26.73 n/a false false false false float
report A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sysSNR Floating point numeric data. Ex: 26.73 n/a false false false false float
totalNumReads Integer data. Ex: 2673 n/a false false false false integer
total_mapped_reads Unicode string data. Ex: “Hello World” n/a false false false false string
total_mapped_target_bases Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/libmetrics/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 6
    },
    "objects": [
        {
            "Genome_Version": "1",
            "Index_Version": "tmap-f3",
            "align_sample": 0,
            "aveKeyCounts": 80,
            "cf": 0.902389362454414,
            "dr": 0.0903240870684385,
            "duplicate_reads": null,
            "genome": "E. coli DH10B",
            "genomesize": "4686137",
            "i100Q10_reads": 1180,
            "i100Q17_reads": 1144,
            "i100Q20_reads": 1086,
            "i100Q47_reads": 882,
            "i100Q7_reads": 1181,
            "i150Q10_reads": 0,
            "i150Q17_reads": 0,
            "i150Q20_reads": 0,
            "i150Q47_reads": 0,
            "i150Q7_reads": 0,
            "i200Q10_reads": 0,
            "i200Q17_reads": 0,
            "i200Q20_reads": 0,
            "i200Q47_reads": 0,
            "i200Q7_reads": 0,
            "i250Q10_reads": 0,
            "i250Q17_reads": 0,
            "i250Q20_reads": 0,
            "i250Q47_reads": 0,
            "i250Q7_reads": 0,
            "i300Q10_reads": 0,
            "i300Q17_reads": 0,
            "i300Q20_reads": 0,
            "i300Q47_reads": 0,
            "i300Q7_reads": 0,
            "i350Q10_reads": 0,
            "i350Q17_reads": 0,
            "i350Q20_reads": 0,
            "i350Q47_reads": 0,
            "i350Q7_reads": 0,
            "i400Q10_reads": 0,
            "i400Q17_reads": 0,
            "i400Q20_reads": 0,
            "i400Q47_reads": 0,
            "i400Q7_reads": 0,
            "i450Q10_reads": 0,
            "i450Q17_reads": 0,
            "i450Q20_reads": 0,
            "i450Q47_reads": 0,
            "i450Q7_reads": 0,
            "i500Q10_reads": 0,
            "i500Q17_reads": 0,
            "i500Q20_reads": 0,
            "i500Q47_reads": 0,
            "i500Q7_reads": 0,
            "i50Q10_reads": 1475,
            "i50Q17_reads": 1444,
            "i50Q20_reads": 1355,
            "i50Q47_reads": 1284,
            "i50Q7_reads": 1476,
            "i550Q10_reads": 0,
            "i550Q17_reads": 0,
            "i550Q20_reads": 0,
            "i550Q47_reads": 0,
            "i550Q7_reads": 0,
            "i600Q10_reads": 0,
            "i600Q17_reads": 0,
            "i600Q20_reads": 0,
            "i600Q47_reads": 0,
            "i600Q7_reads": 0,
            "id": 6,
            "ie": 1.01652704179287,
            "q10_alignments": 1515,
            "q10_longest_alignment": 149,
            "q10_mapped_bases": "157144",
            "q10_mean_alignment_length": 103,
            "q17_alignments": 1483,
            "q17_longest_alignment": 141,
            "q17_mapped_bases": "152775",
            "q17_mean_alignment_length": 103,
            "q20_alignments": 1450,
            "q20_longest_alignment": 141,
            "q20_mapped_bases": "145395",
            "q20_mean_alignment_length": 100,
            "q47_alignments": 1409,
            "q47_longest_alignment": 141,
            "q47_mapped_bases": "134360",
            "q47_mean_alignment_length": 95,
            "q7_alignments": 1519,
            "q7_longest_alignment": 149,
            "q7_mapped_bases": "157362",
            "q7_mean_alignment_length": 103,
            "raw_accuracy": 99.5,
            "report": "/rundb/api/v1/results/6/",
            "resource_uri": "/rundb/api/v1/libmetrics/6/",
            "sysSNR": 23.2850075415905,
            "totalNumReads": 1526,
            "total_mapped_reads": "1521",
            "total_mapped_target_bases": "157392"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Library Key Resource

Resource URL http://mytorrentserver/rundb/api/v1/librarykey/
Schema URL http://mytorrentserver/rundb/api/v1/librarykey/schema/

Resource Fields
field help text default nullable readonly blank unique type
description Unicode string data. Ex: “Hello World”   false false true false string
direction Unicode string data. Ex: “Hello World” Forward false false false false string
id Integer data. Ex: 2673   false false true true integer
isDefault Boolean data. Ex: True false false false true false boolean
name Unicode string data. Ex: “Hello World” n/a false false false true string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World” single false false true false string
sequence Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/librarykey/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 3
    },
    "objects": [
        {
            "description": "Ion TCAGT",
            "direction": "Forward",
            "id": 3,
            "isDefault": false,
            "name": "Ion TCAGT",
            "resource_uri": "/rundb/api/v1/librarykey/3/",
            "runMode": "single",
            "sequence": "TCAGT"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Library Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/librarykitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/librarykitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/librarykitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 29
    },
    "objects": [
        {
            "applicationType": "AMPS",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "carrierSeq",
            "chipTypes": "550",
            "defaultCartridgeUsageCount": null,
            "description": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "flowCount": 0,
            "id": 20118,
            "instrumentType": "",
            "isActive": true,
            "kitType": "LibraryKit",
            "libraryReadLength": 0,
            "name": "Ion Torrent CarrierSeq ECS Kit with Ion 550 Chips",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "A43587",
                    "id": 20269,
                    "kit": "/rundb/api/v1/kitinfo/20118/",
                    "resource_uri": "/rundb/api/v1/kitpart/20269/"
                }
            ],
            "resource_uri": "/rundb/api/v1/librarykitinfo/20118/",
            "runMode": "",
            "samplePrep_instrumentType": "",
            "uid": "LIB0030"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Library Kit Part Resource

Resource URL http://mytorrentserver/rundb/api/v1/librarykitpart/
Schema URL http://mytorrentserver/rundb/api/v1/librarykitpart/schema/

Resource Fields
field help text default nullable readonly blank unique type
barcode Unicode string data. Ex: “Hello World” n/a false false false true string
id Integer data. Ex: 2673   false false true true integer
kit A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/librarykitpart/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 37
    },
    "objects": [
        {
            "barcode": "A43587",
            "id": 20269,
            "kit": "/rundb/api/v1/kitinfo/20118/",
            "resource_uri": "/rundb/api/v1/librarykitpart/20269/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Location Resource

Resource URL http://mytorrentserver/rundb/api/v1/location/
Schema URL http://mytorrentserver/rundb/api/v1/location/schema/

Resource Fields
field help text default nullable readonly blank unique type
comments Unicode string data. Ex: “Hello World”   false false true false string
defaultlocation Only one location can be the default false false false true false boolean
id Integer data. Ex: 2673   false false true true integer
name Unicode string data. Ex: “Hello World” n/a false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/location/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "comments": "A location which will not be assigned to any File Servers so that Rigs assigned to this location will not be treated as valid Rigs when ionCrawler attempts to find new raw data directories. This is so that we do not have to delete a Rig from the Rigs table but still want to prevent new Experiments from appearing associated with the Rig.",
            "defaultlocation": false,
            "id": 2,
            "name": "Disabled",
            "resource_uri": "/rundb/api/v1/location/2/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Log Resource

Resource URL http://mytorrentserver/rundb/api/v1/log/
Schema URL http://mytorrentserver/rundb/api/v1/log/schema/

Resource Fields
field help text default nullable readonly blank unique type
id Integer data. Ex: 2673   false false true true integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
text Unicode string data. Ex: “Hello World”   false false true false string
timeStamp A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
upload A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 0
    },
    "objects": []
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Message Resource

Resource URL http://mytorrentserver/rundb/api/v1/message/
Schema URL http://mytorrentserver/rundb/api/v1/message/schema/

Resource Fields
field help text default nullable readonly blank unique type
body Unicode string data. Ex: “Hello World”   false false true false string
expires Unicode string data. Ex: “Hello World” read false false true false string
id Integer data. Ex: 2673   false false true true integer
level Integer data. Ex: 2673 20 false false false false integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
route Unicode string data. Ex: “Hello World”   false false true false string
status Unicode string data. Ex: “Hello World” unread false false true false string
tags Unicode string data. Ex: “Hello World”   false false true false string
time A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 0
    },
    "objects": []
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Monitor Data Resource

Resource URL http://mytorrentserver/rundb/api/v1/monitordata/
Schema URL http://mytorrentserver/rundb/api/v1/monitordata/schema/

Resource Fields
field help text default nullable readonly blank unique type
id Integer data. Ex: 2673   false false true true integer
name Unicode string data. Ex: “Hello World”   false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
treeDat Unicode string data. Ex: “Hello World” {} false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 0
    },
    "objects": []
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Monitor Result Resource

Resource URL http://mytorrentserver/rundb/api/v1/monitorresult/
Schema URL http://mytorrentserver/rundb/api/v1/monitorresult/schema/

Resource Fields
field help text default nullable readonly blank unique type
analysismetrics A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
autoExempt Boolean data. Ex: True false false false true false boolean
barcodeId Unicode string data. Ex: “Hello World” n/a true true false false string
eas A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
experiment A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
i18nstatus Unicode string data. Ex: “Hello World” n/a false false false false string
id Integer data. Ex: 2673   false false true true integer
libmetrics A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
library Unicode string data. Ex: “Hello World” n/a true true false false string
processedflows Integer data. Ex: 2673 n/a false false false false integer
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
qualitymetrics A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
reportLink Unicode string data. Ex: “Hello World” n/a false false false false string
reportStatus Unicode string data. Ex: “Hello World” Nothing true false false false string
representative Boolean data. Ex: True false false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultsName Unicode string data. Ex: “Hello World” n/a false false false false string
status Unicode string data. Ex: “Hello World” n/a false false false false string
timeStamp A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 0
    },
    "objects": []
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Network Resource

Resource URL http://mytorrentserver/rundb/api/v1/network/
Schema URL http://mytorrentserver/rundb/api/v1/network/schema/

Resource Fields
field help text default nullable readonly blank unique type
eth_device Unicode string data. Ex: “Hello World” n/a true true true false boolean
external_ip Unicode string data. Ex: “Hello World” n/a true true true false string
internal_ip Unicode string data. Ex: “Hello World” n/a true true true false string
route Unicode string data. Ex: “Hello World” n/a true true true false boolean
Example Response
{
    "eth_device": true,
    "external_ip": "12.27.71.34",
    "internal_ip": "10.45.2.119",
    "route": true
}
Allowed list HTTP methods
  • GET
Allowed detail HTTP methods

None

Onetouch Plan Template Resource

Resource URL http://mytorrentserver/rundb/api/v1/onetouchplantemplate/
Schema URL http://mytorrentserver/rundb/api/v1/onetouchplantemplate/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
applicationCategoryDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
applicationGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
applicationGroupDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
autoAnalyze Boolean data. Ex: True n/a false false false false boolean
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
barcodeId Unicode string data. Ex: “Hello World”   true false true false string
barcodedSamples Unicode string data. Ex: “Hello World”   true false true false string
base_recalibration_mode Unicode string data. Ex: “Hello World”   true false true false string
bedfile Unicode string data. Ex: “Hello World”   false false true false string
categories Unicode string data. Ex: “Hello World”   true false false false string
chefInfo A dictionary of data. Ex: {‘price’: 26.73, ‘name’: ‘Daniel’} {} false false false false dict
childPlans A list of data. Ex: [‘abc’, 26.73, 8] [] false false false false list
chipBarcode Unicode string data. Ex: “Hello World”   false false false false string
chipType Unicode string data. Ex: “Hello World”   false false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
earlyDatFileDeletion Boolean data. Ex: True false false true false false boolean
endBarcodeKitName Unicode string data. Ex: “Hello World”   true false true false string
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
flows Integer data. Ex: 2673 0 false false false false integer
flowsInOrder Unicode string data. Ex: “Hello World”   true false true false string
forward3primeadapter Unicode string data. Ex: “Hello World”   true false true false string
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isDuplicateReads Boolean data. Ex: True n/a false false false false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
library Unicode string data. Ex: “Hello World”   true false true false string
libraryKey Unicode string data. Ex: “Hello World”   false false true false string
libraryPrepType Unicode string data. Ex: “Hello World”   true true true false string
libraryPrepTypeDisplayedName Unicode string data. Ex: “Hello World”   true true true false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
librarykitname Unicode string data. Ex: “Hello World”   true false true false string
metaData Unicode string data. Ex: “Hello World” {} false false true false string
mixedTypeRNA_hotSpotRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
mixedTypeRNA_reference Unicode string data. Ex: “Hello World”   true false true false string
mixedTypeRNA_targetRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
notes Unicode string data. Ex: “Hello World”   true false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
parentPlan Unicode string data. Ex: “Hello World” None false false true false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
platform Unicode string data. Ex: “Hello World” n/a true false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
project Unicode string data. Ex: “Hello World” n/a false true true false string
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
qcValues Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
realign Boolean data. Ex: True n/a false false false false boolean
regionfile Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse3primeadapter Unicode string data. Ex: “Hello World”   false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
reverselibrarykey Unicode string data. Ex: “Hello World”   false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
sample Unicode string data. Ex: “Hello World”   true false true false string
sampleDisplayedName Unicode string data. Ex: “Hello World”   true false true false string
sampleGrouping A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleGroupingName Unicode string data. Ex: “Hello World” n/a true true true false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleSetDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
sampleSets Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
selectedPlugins Unicode string data. Ex: “Hello World”   true false true false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
sequencekitname Unicode string data. Ex: “Hello World”   true false true false string
sseBedFile Unicode string data. Ex: “Hello World”   false false true false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
tfKey Unicode string data. Ex: “Hello World”   false false true false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
variantfrequency Unicode string data. Ex: “Hello World”   false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/onetouchplantemplate/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 36
    },
    "objects": [
        {
            "adapter": null,
            "alignmentargs": "",
            "analysisargs": "",
            "applicationCategoryDisplayedName": "",
            "applicationGroup": "/rundb/api/v1/applicationgroup/6/",
            "applicationGroupDisplayedName": "Pharmacogenomics",
            "autoAnalyze": true,
            "autoName": null,
            "barcodeId": "IonXpress",
            "barcodedSamples": {},
            "base_recalibration_mode": "standard_recal",
            "basecallerargs": "",
            "beadfindargs": "",
            "bedfile": "/results/uploads/BED/5/hg19/unmerged/detail/PGx.20150728.designed.bed",
            "calibrateargs": "",
            "categories": "",
            "chefInfo": {},
            "childPlans": [],
            "chipBarcode": "",
            "chipType": "",
            "controlSequencekitname": "",
            "custom_args": false,
            "cycles": null,
            "date": "2018-02-08T19:41:44.000698+00:00",
            "earlyDatFileDeletion": false,
            "endBarcodeKitName": "",
            "expName": "",
            "experiment": "/rundb/api/v1/experiment/122/",
            "flows": 500,
            "flowsInOrder": "",
            "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
            "id": 130,
            "ionstatsargs": "",
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isDuplicateReads": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": true,
            "isReverseRun": false,
            "isSystem": false,
            "isSystemDefault": false,
            "libkit": null,
            "library": "hg19",
            "libraryKey": "TCAG",
            "libraryPrepType": "",
            "libraryPrepTypeDisplayedName": "",
            "libraryReadLength": 0,
            "librarykitname": "Ion AmpliSeq 2.0 Library Kit",
            "metaData": {},
            "mixedTypeRNA_hotSpotRegionBedFile": null,
            "mixedTypeRNA_reference": null,
            "mixedTypeRNA_targetRegionBedFile": null,
            "notes": "",
            "origin": "ampliseq.com|5.8.0",
            "pairedEndLibraryAdapterName": "",
            "parentPlan": null,
            "planDisplayedName": "PGx Research Panel",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "7489c32d-d3ed-4cc1-a7a2-e59b819ea395",
            "planName": "PGx_Research_Panel",
            "planPGM": null,
            "planShortID": "OO9C5",
            "planStatus": "planned",
            "platform": "PGM",
            "preAnalysis": true,
            "prebasecallerargs": "",
            "prethumbnailbasecallerargs": "",
            "project": "",
            "projects": [],
            "qcValues": [],
            "realign": false,
            "regionfile": "/results/uploads/BED/15/hg19/unmerged/detail/PGx.20180131.hotspots.bed",
            "resource_uri": "/rundb/api/v1/onetouchplantemplate/130/",
            "reverse3primeadapter": "",
            "reverse_primer": null,
            "reverselibrarykey": "",
            "runMode": "",
            "runType": "AMPS",
            "runname": null,
            "sample": "",
            "sampleDisplayedName": "",
            "sampleGrouping": null,
            "sampleGroupingName": "",
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleSetDisplayedName": "",
            "sampleSets": [],
            "sampleTubeLabel": null,
            "selectedPlugins": {
                "variantCaller": {
                    "ampliSeqVariantCallerConfig": {
                        "freebayes": {
                            "allow_complex": 0,
                            "allow_indels": 1,
                            "allow_mnps": 1,
                            "allow_snps": 1,
                            "gen_min_alt_allele_freq": "0.15",
                            "gen_min_coverage": 10,
                            "gen_min_indel_alt_allele_freq": "0.15",
                            "min_mapping_qv": 4,
                            "read_max_mismatch_fraction": 1,
                            "read_snp_limit": 10
                        },
                        "long_indel_assembler": {
                            "kmer_len": 19,
                            "max_hp_length": 8,
                            "min_indel_size": 4,
                            "min_var_count": 5,
                            "min_var_freq": "0.15",
                            "output_mnv": 0,
                            "relative_strand_bias": "0.8",
                            "short_suffix_match": 5
                        },
                        "meta": {
                            "built_in": true,
                            "compatibility": {
                                "panel": "/rundb/api/v1/contentupload/15/"
                            },
                            "configuration": "PGx_germline_low_stringency",
                            "name": "PGx - Germ Line - Customized parameters",
                            "repository_id": "",
                            "tooltip": "Panel-optimized parameters from AmpliSeq.com",
                            "ts_version": "5.0",
                            "tvcargs": "tvc --use-input-allele-only",
                            "user_selections": {
                                "chip": "pgm",
                                "frequency": "germline",
                                "library": "ampliseq",
                                "panel": "/rundb/api/v1/contentupload/15/"
                            }
                        },
                        "torrent_variant_caller": {
                            "data_quality_stringency": "6.5",
                            "do_mnp_realignment": 1,
                            "do_snp_realignment": 1,
                            "downsample_to_coverage": 4000,
                            "filter_deletion_predictions": "0.2",
                            "filter_insertion_predictions": "0.4",
                            "filter_unusual_predictions": "0.7",
                            "heavy_tailed": 3,
                            "hotspot_min_allele_freq": "0.1",
                            "hotspot_min_cov_each_strand": 3,
                            "hotspot_min_coverage": 6,
                            "hotspot_min_variant_score": 4,
                            "hotspot_strand_bias": "0.98",
                            "hotspot_strand_bias_pval": "0.01",
                            "hp_max_length": 10,
                            "indel_as_hpindel": 0,
                            "indel_min_allele_freq": "0.1",
                            "indel_min_cov_each_strand": 5,
                            "indel_min_coverage": 15,
                            "indel_min_variant_score": 10,
                            "indel_strand_bias": "0.85",
                            "indel_strand_bias_pval": 1,
                            "mnp_min_allele_freq": "0.1",
                            "mnp_min_cov_each_strand": 0,
                            "mnp_min_coverage": 6,
                            "mnp_min_variant_score": 10,
                            "mnp_strand_bias": "0.95",
                            "mnp_strand_bias_pval": 1,
                            "outlier_probability": "0.01",
                            "position_bias": "0.75",
                            "position_bias_pval": "0.05",
                            "position_bias_ref_fraction": "0.05",
                            "prediction_precision": 1,
                            "process_input_positions_only": 1,
                            "realignment_threshold": 1,
                            "snp_min_allele_freq": "0.1",
                            "snp_min_cov_each_strand": 0,
                            "snp_min_coverage": 6,
                            "snp_min_variant_score": 10,
                            "snp_strand_bias": "0.95",
                            "snp_strand_bias_pval": 1,
                            "suppress_recalibration": 0,
                            "use_position_bias": 0
                        }
                    },
                    "features": [],
                    "id": 36,
                    "name": "variantCaller",
                    "userInput": {
                        "freebayes": {
                            "allow_complex": 0,
                            "allow_indels": 1,
                            "allow_mnps": 1,
                            "allow_snps": 1,
                            "gen_min_alt_allele_freq": "0.15",
                            "gen_min_coverage": 10,
                            "gen_min_indel_alt_allele_freq": "0.15",
                            "min_mapping_qv": 4,
                            "read_max_mismatch_fraction": 1,
                            "read_snp_limit": 10
                        },
                        "long_indel_assembler": {
                            "kmer_len": 19,
                            "max_hp_length": 8,
                            "min_indel_size": 4,
                            "min_var_count": 5,
                            "min_var_freq": "0.15",
                            "output_mnv": 0,
                            "relative_strand_bias": "0.8",
                            "short_suffix_match": 5
                        },
                        "meta": {
                            "built_in": true,
                            "compatibility": {
                                "panel": "/rundb/api/v1/contentupload/15/"
                            },
                            "configuration": "PGx_germline_low_stringency",
                            "name": "PGx - Germ Line - Customized parameters",
                            "repository_id": "",
                            "tooltip": "Panel-optimized parameters from AmpliSeq.com",
                            "ts_version": "5.0",
                            "tvcargs": "tvc --use-input-allele-only",
                            "user_selections": {
                                "chip": "pgm",
                                "frequency": "germline",
                                "library": "ampliseq",
                                "panel": "/rundb/api/v1/contentupload/15/"
                            }
                        },
                        "torrent_variant_caller": {
                            "data_quality_stringency": "6.5",
                            "do_mnp_realignment": 1,
                            "do_snp_realignment": 1,
                            "downsample_to_coverage": 4000,
                            "filter_deletion_predictions": "0.2",
                            "filter_insertion_predictions": "0.4",
                            "filter_unusual_predictions": "0.7",
                            "heavy_tailed": 3,
                            "hotspot_min_allele_freq": "0.1",
                            "hotspot_min_cov_each_strand": 3,
                            "hotspot_min_coverage": 6,
                            "hotspot_min_variant_score": 4,
                            "hotspot_strand_bias": "0.98",
                            "hotspot_strand_bias_pval": "0.01",
                            "hp_max_length": 10,
                            "indel_as_hpindel": 0,
                            "indel_min_allele_freq": "0.1",
                            "indel_min_cov_each_strand": 5,
                            "indel_min_coverage": 15,
                            "indel_min_variant_score": 10,
                            "indel_strand_bias": "0.85",
                            "indel_strand_bias_pval": 1,
                            "mnp_min_allele_freq": "0.1",
                            "mnp_min_cov_each_strand": 0,
                            "mnp_min_coverage": 6,
                            "mnp_min_variant_score": 10,
                            "mnp_strand_bias": "0.95",
                            "mnp_strand_bias_pval": 1,
                            "outlier_probability": "0.01",
                            "position_bias": "0.75",
                            "position_bias_pval": "0.05",
                            "position_bias_ref_fraction": "0.05",
                            "prediction_precision": 1,
                            "process_input_positions_only": 1,
                            "realignment_threshold": 1,
                            "snp_min_allele_freq": "0.1",
                            "snp_min_cov_each_strand": 0,
                            "snp_min_coverage": 6,
                            "snp_min_variant_score": 10,
                            "snp_strand_bias": "0.95",
                            "snp_strand_bias_pval": 1,
                            "suppress_recalibration": 0,
                            "use_position_bias": 0
                        }
                    },
                    "version": "5.8.0.19"
                }
            },
            "seqKitBarcode": null,
            "sequencekitname": "IonPGMHiQ",
            "sseBedFile": "",
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion PGM Hi-Q OT2 Kit - 200",
            "tfKey": "ATCG",
            "thumbnailalignmentargs": "",
            "thumbnailanalysisargs": "",
            "thumbnailbasecallerargs": "",
            "thumbnailbeadfindargs": "",
            "thumbnailcalibrateargs": "",
            "thumbnailionstatsargs": "",
            "usePostBeadfind": true,
            "usePreBeadfind": true,
            "username": "ionuser",
            "variantfrequency": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Onetouch Plan Template Summary Resource

Resource URL http://mytorrentserver/rundb/api/v1/onetouchplantemplatesummary/
Schema URL http://mytorrentserver/rundb/api/v1/onetouchplantemplatesummary/schema/

Resource Fields
field help text default nullable readonly blank unique type
origin Unicode string data. Ex: “Hello World”   true false false false string
isReverseRun Boolean data. Ex: True false false false true false boolean
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
preAnalysis Boolean data. Ex: True true false false true false boolean
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
id Integer data. Ex: 2673   false false true true integer
metaData Unicode string data. Ex: “Hello World” {} false false true false string
isFavorite Boolean data. Ex: True false false false true false boolean
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
isPlanGroup Boolean data. Ex: True false false false true false boolean
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
isSystemDefault Boolean data. Ex: True false false false true false boolean
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
isReusable Boolean data. Ex: True false false false true false boolean
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
isSystem Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
categories Unicode string data. Ex: “Hello World”   true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
planExecuted Boolean data. Ex: True false false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
expName Unicode string data. Ex: “Hello World”   false false true false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
runname Unicode string data. Ex: “Hello World” n/a true false false false string
usePreBeadfind Boolean data. Ex: True true false false true false boolean
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "previous": null,
        "total_count": 37,
        "offset": 0,
        "limit": 1,
        "next": "/rundb/api/v1/onetouchplantemplatesummary/?offset=1&limit=1&format=json"
    },
    "objects": [
        {
            "origin": "ampliseq.com|5.8.0",
            "isReverseRun": false,
            "planDisplayedName": "PGx Research Panel",
            "storage_options": "A",
            "preAnalysis": true,
            "planShortID": "OO9C5",
            "planStatus": "planned",
            "runMode": "",
            "isCustom_kitSettings": false,
            "sampleTubeLabel": null,
            "planExecutedDate": null,
            "samplePrepKitName": null,
            "reverse_primer": null,
            "seqKitBarcode": null,
            "id": 130,
            "metaData": {},
            "isFavorite": false,
            "samplePrepProtocol": "",
            "isPlanGroup": false,
            "templatingKitName": "Ion PGM Hi-Q OT2 Kit - 200",
            "runType": "AMPS",
            "templatingKitBarcode": null,
            "planPGM": null,
            "isSystemDefault": false,
            "autoName": null,
            "isReusable": true,
            "controlSequencekitname": "",
            "date": "2018-02-08T19:41:44.000698+00:00",
            "isSystem": false,
            "libkit": null,
            "categories": "",
            "planName": "PGx_Research_Panel",
            "pairedEndLibraryAdapterName": "",
            "adapter": null,
            "irworkflow": "",
            "planExecuted": false,
            "username": "ionuser",
            "usePostBeadfind": true,
            "storageHost": null,
            "expName": "",
            "libraryReadLength": 0,
            "runname": null,
            "usePreBeadfind": true,
            "planGUID": "7489c32d-d3ed-4cc1-a7a2-e59b819ea395",
            "cycles": null,
            "resource_uri": "/rundb/api/v1/onetouchplantemplatesummary/130/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Planned Experiment Resource

Resource URL http://mytorrentserver/rundb/api/v1/plannedexperiment/
Schema URL http://mytorrentserver/rundb/api/v1/plannedexperiment/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
applicationCategoryDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
applicationGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
applicationGroupDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
autoAnalyze Boolean data. Ex: True n/a false false false false boolean
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
barcodeId Unicode string data. Ex: “Hello World”   true false true false string
barcodedSamples Unicode string data. Ex: “Hello World”   true false true false string
base_recalibration_mode Unicode string data. Ex: “Hello World”   true false true false string
bedfile Unicode string data. Ex: “Hello World”   false false true false string
categories Unicode string data. Ex: “Hello World”   true false false false string
chefInfo A dictionary of data. Ex: {‘price’: 26.73, ‘name’: ‘Daniel’} {} false false false false dict
childPlans A list of data. Ex: [‘abc’, 26.73, 8] [] false false false false list
chipBarcode Unicode string data. Ex: “Hello World”   false false false false string
chipType Unicode string data. Ex: “Hello World”   false false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
earlyDatFileDeletion Boolean data. Ex: True false false true false false boolean
endBarcodeKitName Unicode string data. Ex: “Hello World”   true false true false string
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
flows Integer data. Ex: 2673 0 false false false false integer
flowsInOrder Unicode string data. Ex: “Hello World”   true false true false string
forward3primeadapter Unicode string data. Ex: “Hello World”   true false true false string
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isDuplicateReads Boolean data. Ex: True n/a false false false false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
library Unicode string data. Ex: “Hello World”   true false true false string
libraryKey Unicode string data. Ex: “Hello World”   false false true false string
libraryPrepType Unicode string data. Ex: “Hello World”   true true true false string
libraryPrepTypeDisplayedName Unicode string data. Ex: “Hello World”   true true true false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
librarykitname Unicode string data. Ex: “Hello World”   true false true false string
metaData Unicode string data. Ex: “Hello World” {} false false true false string
mixedTypeRNA_hotSpotRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
mixedTypeRNA_reference Unicode string data. Ex: “Hello World”   true false true false string
mixedTypeRNA_targetRegionBedFile Unicode string data. Ex: “Hello World”   false false true false string
notes Unicode string data. Ex: “Hello World”   true false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
parentPlan Unicode string data. Ex: “Hello World” None false false true false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
platform Unicode string data. Ex: “Hello World” n/a true false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
project Unicode string data. Ex: “Hello World” n/a false true true false string
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
qcValues Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
realign Boolean data. Ex: True n/a false false false false boolean
regionfile Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse3primeadapter Unicode string data. Ex: “Hello World”   false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
reverselibrarykey Unicode string data. Ex: “Hello World”   false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
sample Unicode string data. Ex: “Hello World”   true false true false string
sampleDisplayedName Unicode string data. Ex: “Hello World”   true false true false string
sampleGrouping A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleGroupingName Unicode string data. Ex: “Hello World” n/a true true true false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleSetDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
sampleSets Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
selectedPlugins Unicode string data. Ex: “Hello World”   true false true false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
sequencekitname Unicode string data. Ex: “Hello World”   true false true false string
sseBedFile Unicode string data. Ex: “Hello World”   false false true false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
tfKey Unicode string data. Ex: “Hello World”   false false true false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
variantfrequency Unicode string data. Ex: “Hello World”   false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/plannedexperiment/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 135
    },
    "objects": [
        {
            "adapter": null,
            "alignmentargs": "",
            "analysisargs": "",
            "applicationCategoryDisplayedName": "Oncology - Solid Tumor",
            "applicationGroup": "/rundb/api/v1/applicationgroup/5/",
            "applicationGroupDisplayedName": "DNA and Fusions (Separate Libraries)",
            "autoAnalyze": true,
            "autoName": null,
            "barcodeId": "Ion Dual Barcode Kit 1-96",
            "barcodedSamples": {},
            "base_recalibration_mode": "standard_recal",
            "basecallerargs": "",
            "beadfindargs": "",
            "bedfile": "",
            "calibrateargs": "",
            "categories": "Oncomine;onco_solidTumor;barcodes_8;p4o",
            "chefInfo": {},
            "childPlans": [],
            "chipBarcode": "",
            "chipType": "530",
            "controlSequencekitname": null,
            "custom_args": false,
            "cycles": null,
            "date": "2019-10-03T20:53:08.000623+00:00",
            "earlyDatFileDeletion": false,
            "endBarcodeKitName": "",
            "expName": "",
            "experiment": "/rundb/api/v1/experiment/163/",
            "flows": 500,
            "flowsInOrder": "",
            "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
            "id": 170,
            "ionstatsargs": "",
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isDuplicateReads": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": true,
            "isReverseRun": false,
            "isSystem": true,
            "isSystemDefault": false,
            "libkit": null,
            "library": "",
            "libraryKey": "TCAG",
            "libraryPrepType": "",
            "libraryPrepTypeDisplayedName": "",
            "libraryReadLength": 200,
            "librarykitname": "Ion AmpliSeq Library Kit Plus",
            "metaData": {},
            "mixedTypeRNA_hotSpotRegionBedFile": null,
            "mixedTypeRNA_reference": null,
            "mixedTypeRNA_targetRegionBedFile": null,
            "notes": "",
            "origin": "|5.12.1",
            "pairedEndLibraryAdapterName": null,
            "parentPlan": null,
            "planDisplayedName": "Oncomine Tumor Specific Fusions",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "aa9309c5-5922-49f3-b901-987383b03e57",
            "planName": "Oncomine_Tumor_Specific_Fusions",
            "planPGM": "",
            "planShortID": "OZT4F",
            "planStatus": "inactive",
            "platform": "S5",
            "preAnalysis": true,
            "prebasecallerargs": "",
            "prethumbnailbasecallerargs": "",
            "project": "",
            "projects": [],
            "qcValues": [
                {
                    "id": 487,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 1,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Bead Loading (%)",
                        "resource_uri": "/rundb/api/v1/qctype/1/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/487/",
                    "threshold": 30
                },
                {
                    "id": 488,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 2,
                        "maxThreshold": 100,
                        "minThreshold": 1,
                        "qcName": "Key Signal (1-100)",
                        "resource_uri": "/rundb/api/v1/qctype/2/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/488/",
                    "threshold": 30
                },
                {
                    "id": 489,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 3,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Usable Sequence (%)",
                        "resource_uri": "/rundb/api/v1/qctype/3/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/489/",
                    "threshold": 30
                }
            ],
            "realign": false,
            "regionfile": "",
            "resource_uri": "/rundb/api/v1/plannedexperiment/170/",
            "reverse3primeadapter": "",
            "reverse_primer": null,
            "reverselibrarykey": "",
            "runMode": "single",
            "runType": "AMPS_RNA",
            "runname": null,
            "sample": "",
            "sampleDisplayedName": "",
            "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/7/",
            "sampleGroupingName": "Single Fusions",
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleSetDisplayedName": "",
            "sampleSets": [],
            "sampleTubeLabel": null,
            "selectedPlugins": {},
            "seqKitBarcode": null,
            "sequencekitname": "Ion S5 Sequencing Kit",
            "sseBedFile": "",
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion Chef S530 V2",
            "tfKey": "ATCG",
            "thumbnailalignmentargs": "",
            "thumbnailanalysisargs": "",
            "thumbnailbasecallerargs": "",
            "thumbnailbeadfindargs": "",
            "thumbnailcalibrateargs": "",
            "thumbnailionstatsargs": "",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": null,
            "variantfrequency": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Planned Experiment Db Resource

Resource URL http://mytorrentserver/rundb/api/v1/plannedexperimentdb/
Schema URL http://mytorrentserver/rundb/api/v1/plannedexperimentdb/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
applicationGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
categories Unicode string data. Ex: “Hello World”   true false false false string
childPlans A list of data. Ex: [‘abc’, 26.73, 8] [] false false false false list
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
metaData Unicode string data. Ex: “Hello World” {} false false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
parentPlan Unicode string data. Ex: “Hello World” None false false true false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
project Unicode string data. Ex: “Hello World” n/a false true true false string
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
qcValues Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
sampleGrouping A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleSets Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/plannedexperimentdb/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 135
    },
    "objects": [
        {
            "adapter": null,
            "applicationGroup": "/rundb/api/v1/applicationgroup/5/",
            "autoName": null,
            "categories": "Oncomine;onco_solidTumor;barcodes_8;p4o",
            "childPlans": [],
            "controlSequencekitname": null,
            "cycles": null,
            "date": "2019-10-03T20:53:08.000623+00:00",
            "expName": "",
            "experiment": "/rundb/api/v1/experiment/163/",
            "id": 170,
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": true,
            "isReverseRun": false,
            "isSystem": true,
            "isSystemDefault": false,
            "libkit": null,
            "libraryReadLength": 200,
            "metaData": {},
            "origin": "|5.12.1",
            "pairedEndLibraryAdapterName": null,
            "parentPlan": null,
            "planDisplayedName": "Oncomine Tumor Specific Fusions",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "aa9309c5-5922-49f3-b901-987383b03e57",
            "planName": "Oncomine_Tumor_Specific_Fusions",
            "planPGM": "",
            "planShortID": "OZT4F",
            "planStatus": "inactive",
            "preAnalysis": true,
            "project": "",
            "projects": [],
            "qcValues": [
                {
                    "id": 487,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 1,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Bead Loading (%)",
                        "resource_uri": "/rundb/api/v1/qctype/1/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/487/",
                    "threshold": 30
                },
                {
                    "id": 488,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 2,
                        "maxThreshold": 100,
                        "minThreshold": 1,
                        "qcName": "Key Signal (1-100)",
                        "resource_uri": "/rundb/api/v1/qctype/2/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/488/",
                    "threshold": 30
                },
                {
                    "id": 489,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
                    "qcType": {
                        "defaultThreshold": 30,
                        "description": "",
                        "id": 3,
                        "maxThreshold": 100,
                        "minThreshold": 0,
                        "qcName": "Usable Sequence (%)",
                        "resource_uri": "/rundb/api/v1/qctype/3/"
                    },
                    "resource_uri": "/rundb/api/v1/plannedexperimentqc/489/",
                    "threshold": 30
                }
            ],
            "resource_uri": "/rundb/api/v1/plannedexperimentdb/170/",
            "reverse_primer": null,
            "runMode": "single",
            "runType": "AMPS_RNA",
            "runname": null,
            "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/7/",
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleSets": [],
            "sampleTubeLabel": null,
            "seqKitBarcode": null,
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion Chef S530 V2",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": null
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Planned Experiment Qc Resource

Resource URL http://mytorrentserver/rundb/api/v1/plannedexperimentqc/
Schema URL http://mytorrentserver/rundb/api/v1/plannedexperimentqc/schema/

Resource Fields
field help text default nullable readonly blank unique type
id Integer data. Ex: 2673   false false true true integer
plannedExperiment A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
qcType A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
threshold Integer data. Ex: 2673 0 false false false false integer
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/plannedexperimentqc/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 390
    },
    "objects": [
        {
            "id": 489,
            "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/",
            "qcType": {
                "defaultThreshold": 30,
                "description": "",
                "id": 3,
                "maxThreshold": 100,
                "minThreshold": 0,
                "qcName": "Usable Sequence (%)",
                "resource_uri": "/rundb/api/v1/qctype/3/"
            },
            "resource_uri": "/rundb/api/v1/plannedexperimentqc/489/",
            "threshold": 30
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Plan Template Basic Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/plantemplatebasicinfo/
Schema URL http://mytorrentserver/rundb/api/v1/plantemplatebasicinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
applicationCategoryDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
applicationGroup A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
applicationGroupDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
barcodeKitName Unicode string data. Ex: “Hello World” n/a true true true false string
categories Unicode string data. Ex: “Hello World”   true false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
eas A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
expName Unicode string data. Ex: “Hello World”   false false true false string
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
hotSpotRegionBedFile Unicode string data. Ex: “Hello World”   true true true false string
id Integer data. Ex: 2673   false false true true integer
irAccountName Unicode string data. Ex: “Hello World” n/a true true true false string
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
metaData Unicode string data. Ex: “Hello World” {} false false true false string
notes Unicode string data. Ex: “Hello World”   true true true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
reference Unicode string data. Ex: “Hello World” n/a true true true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
sampleGroupName Unicode string data. Ex: “Hello World” n/a true true true false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
sequencingInstrumentType Unicode string data. Ex: “Hello World” n/a true true true false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
targetRegionBedFile Unicode string data. Ex: “Hello World”   true true true false string
templatePrepInstrumentType Unicode string data. Ex: “Hello World” n/a true true true false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/plantemplatebasicinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 103
    },
    "objects": [
        {
            "adapter": null,
            "applicationCategoryDisplayedName": "Oncology - ImmunoOncology",
            "applicationGroup": "/rundb/api/v1/applicationgroup/9/",
            "applicationGroupDisplayedName": "Immune Repertoire",
            "autoName": null,
            "barcodeKitName": "Ion Dual Barcode Kit 1-96",
            "categories": "onco_immune;immunology",
            "controlSequencekitname": null,
            "cycles": null,
            "date": "2019-10-03T20:53:08.000426+00:00",
            "eas": "/rundb/api/v1/experimentanalysissettings/159/",
            "expName": "",
            "experiment": "/rundb/api/v1/experiment/160/",
            "hotSpotRegionBedFile": "",
            "id": 167,
            "irAccountName": "",
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": true,
            "isReverseRun": false,
            "isSystem": true,
            "isSystemDefault": false,
            "libkit": null,
            "libraryReadLength": 200,
            "metaData": {},
            "notes": "",
            "origin": "|5.12.1",
            "pairedEndLibraryAdapterName": null,
            "planDisplayedName": "Ion Ampliseq Mouse TCRB-SR for S5",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "18b7b769-c7b9-4df9-9c70-3fe1794f4868",
            "planName": "Ion_Ampliseq_Mouse_TCRB-SR_for_S5",
            "planPGM": "",
            "planShortID": "MX7ER",
            "planStatus": "planned",
            "preAnalysis": true,
            "projects": "",
            "reference": "",
            "resource_uri": "/rundb/api/v1/plantemplatebasicinfo/167/",
            "reverse_primer": null,
            "runMode": "single",
            "runType": "MIXED",
            "runname": null,
            "sampleGroupName": "Self",
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleTubeLabel": null,
            "seqKitBarcode": null,
            "sequencingInstrumentType": "s5",
            "storageHost": null,
            "storage_options": "A",
            "targetRegionBedFile": "",
            "templatePrepInstrumentType": "IonChef",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion Chef S540 V1",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": null
        }
    ]
}
Allowed list HTTP methods
  • GET
Allowed detail HTTP methods
  • GET

Plan Template Summary Resource

Resource URL http://mytorrentserver/rundb/api/v1/plantemplatesummary/
Schema URL http://mytorrentserver/rundb/api/v1/plantemplatesummary/schema/

Resource Fields
field help text default nullable readonly blank unique type
adapter Unicode string data. Ex: “Hello World” n/a true false false false string
autoName Unicode string data. Ex: “Hello World” n/a true false false false string
categories Unicode string data. Ex: “Hello World”   true false false false string
controlSequencekitname Unicode string data. Ex: “Hello World” n/a true false false false string
cycles Integer data. Ex: 2673 n/a true false false false integer
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
expName Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
irworkflow Unicode string data. Ex: “Hello World”   false false true false string
isCustom_kitSettings Boolean data. Ex: True false false false true false boolean
isFavorite Boolean data. Ex: True false false false true false boolean
isPlanGroup Boolean data. Ex: True false false false true false boolean
isReusable Boolean data. Ex: True false false false true false boolean
isReverseRun Boolean data. Ex: True false false false true false boolean
isSystem Boolean data. Ex: True false false false true false boolean
isSystemDefault Boolean data. Ex: True false false false true false boolean
libkit Unicode string data. Ex: “Hello World” n/a true false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
metaData Unicode string data. Ex: “Hello World” {} false false true false string
origin Unicode string data. Ex: “Hello World”   true false false false string
pairedEndLibraryAdapterName Unicode string data. Ex: “Hello World” n/a true false false false string
planDisplayedName Unicode string data. Ex: “Hello World” n/a true false false false string
planExecuted Boolean data. Ex: True false false false true false boolean
planExecutedDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
planGUID Unicode string data. Ex: “Hello World” n/a true false false false string
planName Unicode string data. Ex: “Hello World” n/a true false false false string
planPGM Unicode string data. Ex: “Hello World” n/a true false false false string
planShortID Unicode string data. Ex: “Hello World” n/a true false false false string
planStatus Unicode string data. Ex: “Hello World”   false false true false string
preAnalysis Boolean data. Ex: True true false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
reverse_primer Unicode string data. Ex: “Hello World” n/a true false false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
runType Unicode string data. Ex: “Hello World” GENS false false false false string
runname Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
samplePrepProtocol Unicode string data. Ex: “Hello World”   true false false false string
sampleTubeLabel Unicode string data. Ex: “Hello World” n/a true false false false string
seqKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
storageHost Unicode string data. Ex: “Hello World” n/a true false false false string
storage_options Unicode string data. Ex: “Hello World” A false false false false string
templatingKitBarcode Unicode string data. Ex: “Hello World” n/a true false false false string
templatingKitName Unicode string data. Ex: “Hello World” n/a true false false false string
usePostBeadfind Boolean data. Ex: True true false false true false boolean
usePreBeadfind Boolean data. Ex: True true false false true false boolean
username Unicode string data. Ex: “Hello World” n/a true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/plantemplatesummary/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 126
    },
    "objects": [
        {
            "adapter": null,
            "autoName": null,
            "categories": "Oncomine;onco_solidTumor;barcodes_8;p4o",
            "controlSequencekitname": null,
            "cycles": null,
            "date": "2019-10-03T20:53:08.000623+00:00",
            "expName": "",
            "id": 170,
            "irworkflow": "",
            "isCustom_kitSettings": false,
            "isFavorite": false,
            "isPlanGroup": false,
            "isReusable": true,
            "isReverseRun": false,
            "isSystem": true,
            "isSystemDefault": false,
            "libkit": null,
            "libraryReadLength": 200,
            "metaData": {},
            "origin": "|5.12.1",
            "pairedEndLibraryAdapterName": null,
            "planDisplayedName": "Oncomine Tumor Specific Fusions",
            "planExecuted": false,
            "planExecutedDate": null,
            "planGUID": "aa9309c5-5922-49f3-b901-987383b03e57",
            "planName": "Oncomine_Tumor_Specific_Fusions",
            "planPGM": "",
            "planShortID": "OZT4F",
            "planStatus": "inactive",
            "preAnalysis": true,
            "resource_uri": "/rundb/api/v1/plantemplatesummary/170/",
            "reverse_primer": null,
            "runMode": "single",
            "runType": "AMPS_RNA",
            "runname": null,
            "samplePrepKitName": null,
            "samplePrepProtocol": "",
            "sampleTubeLabel": null,
            "seqKitBarcode": null,
            "storageHost": null,
            "storage_options": "A",
            "templatingKitBarcode": null,
            "templatingKitName": "Ion Chef S530 V2",
            "usePostBeadfind": false,
            "usePreBeadfind": true,
            "username": null
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Plugin Resource

Resource URL http://mytorrentserver/rundb/api/v1/plugin/
Schema URL http://mytorrentserver/rundb/api/v1/plugin/schema/

Resource Fields
field help text default nullable readonly blank unique type
active Boolean data. Ex: True true false false true false boolean
availableVersions A list of data. Ex: [‘abc’, 26.73, 8] [] false true false false list
config Unicode string data. Ex: “Hello World”   true false false false string
date A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
defaultSelected Boolean data. Ex: True false false false true false boolean
description Unicode string data. Ex: “Hello World”   false false true false string
hasAbout Boolean data. Ex: True n/a false true false false boolean
id Integer data. Ex: 2673   false false true true integer
input Unicode string data. Ex: “Hello World” n/a false true false false string
isConfig Boolean data. Ex: True n/a false true false false boolean
isInstance Boolean data. Ex: True n/a false true false false boolean
isPlanConfig Boolean data. Ex: True n/a false true false false boolean
isSupported Boolean data. Ex: True n/a false true false false boolean
isUpgradable Boolean data. Ex: True false false true false false boolean
majorBlock Boolean data. Ex: True false false false true false boolean
name Unicode string data. Ex: “Hello World” n/a false false false false string
packageName Unicode string data. Ex: “Hello World”   false false true false string
path Unicode string data. Ex: “Hello World”   false false true false string
pluginsettings Unicode string data. Ex: “Hello World”   true false false false string
requires_configuration Boolean data. Ex: True false false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
script Unicode string data. Ex: “Hello World”   false false true false string
selected Boolean data. Ex: True false false false true false boolean
status Unicode string data. Ex: “Hello World”   true false false false string
url Unicode string data. Ex: “Hello World”   false false true false string
userinputfields Unicode string data. Ex: “Hello World” {} true false false false string
version Unicode string data. Ex: “Hello World” n/a false false false false string
versionedName Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/plugin/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 16
    },
    "objects": [
        {
            "active": true,
            "availableVersions": [
                "5.12.0.1"
            ],
            "config": {},
            "date": "2019-11-08T21:45:21.000653+00:00",
            "defaultSelected": false,
            "description": "Whole Transciptome AmpliSeq-RNA Analysis. (Ion supprted)",
            "hasAbout": true,
            "id": 90,
            "input": "/configure/plugins/plugin/90/configure/report/",
            "isConfig": false,
            "isInstance": true,
            "isPlanConfig": true,
            "isSupported": true,
            "isUpgradable": false,
            "majorBlock": true,
            "name": "immuneResponseRNA",
            "packageName": "ion-plugin-immuneresponserna",
            "path": "/results/plugins/immuneResponseRNA",
            "pluginsettings": {
                "depends": [],
                "features": [],
                "runlevels": [
                    "default"
                ],
                "runtypes": [
                    "wholechip",
                    "thumbnail",
                    "composite"
                ]
            },
            "requires_configuration": false,
            "resource_uri": "/rundb/api/v1/plugin/90/",
            "script": "immuneResponseRNA.py",
            "selected": true,
            "status": {},
            "url": "",
            "userinputfields": {},
            "version": "5.12.0.1",
            "versionedName": "immuneResponseRNA--v5.12.0.1"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Plugin Result Resource

Resource URL http://mytorrentserver/rundb/api/v1/pluginresult/
Schema URL http://mytorrentserver/rundb/api/v1/pluginresult/schema/

Resource Fields
field help text default nullable readonly blank unique type
URL Unicode string data. Ex: “Hello World” n/a false true false false string
apikey Unicode string data. Ex: “Hello World” n/a true false false false string
can_terminate Boolean data. Ex: True n/a false true false false boolean
endtime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a false true false false datetime
files A list of data. Ex: [‘abc’, 26.73, 8] n/a false true false false list
id Integer data. Ex: 2673   false false true true integer
inodes Unicode string data. Ex: “Hello World” -1 false false false false string
major Boolean data. Ex: True n/a false true false false boolean
owner A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
path Unicode string data. Ex: “Hello World” n/a false true false false string
plugin A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
pluginName Unicode string data. Ex: “Hello World” n/a false true false false string
pluginVersion Unicode string data. Ex: “Hello World” n/a false true false false string
plugin_result_jobs Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
reportLink Unicode string data. Ex: “Hello World” n/a false true false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
result A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resultName Unicode string data. Ex: “Hello World” n/a false true false false string
size Unicode string data. Ex: “Hello World” -1 false false false false string
starttime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a false true false false datetime
state Unicode string data. Ex: “Hello World” n/a false true false false string
store Unicode string data. Ex: “Hello World” {} false false true false string
validation_errors Unicode string data. Ex: “Hello World” {} false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/pluginresult/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 18
    },
    "objects": [
        {
            "URL": "/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/plugin_out/PathogenomixRipseqNGS_out.25/",
            "apikey": "7b20b457ab2701e26f93a9ca774338b5e33d779a",
            "can_terminate": false,
            "endtime": "2019-01-17T23:50:39.000550+00:00",
            "files": [
                "status_block.html"
            ],
            "id": 25,
            "inodes": "7",
            "major": false,
            "owner": "/rundb/api/v1/user/1/",
            "path": "/results/analysis/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/plugin_out/PathogenomixRipseqNGS_out.25",
            "plugin": "/rundb/api/v1/plugin/64/",
            "pluginName": "PathogenomixRipseqNGS",
            "pluginVersion": "5.10.0.5",
            "plugin_result_jobs": [
                {
                    "config": {
                        "copyNumberThreshold": "20",
                        "email": "osaebo",
                        "generateAllPrimerCombinations": true,
                        "generateReversedPrimerSets": false,
                        "isNC": false,
                        "maxClusterVariation": "1.0",
                        "ncCT": "33",
                        "password": "xl3eple",
                        "primerCheckLength": "12",
                        "primerCheckMaxErrors": "3",
                        "primers": ">V1_2_A_F\nGTGCCTAAYACATGCAWGT\n>V1_2_A_R\nCTGGDCCGTRTCTCAGT",
                        "readLengthThreshold": "100",
                        "safetyMarginCT": "3",
                        "sampleCT": "16",
                        "trimEndsWithNoPrimer": "21",
                        "useCT": false,
                        "useFullPrimerCoverageReadsOnly": false,
                        "useReadsWithNoPrimer": false,
                        "useWalkingInsDel": false
                    },
                    "endtime": "2019-01-17T23:50:39.000550+00:00",
                    "grid_engine_jobid": 518,
                    "id": 25,
                    "resource_uri": "/rundb/api/v1/PluginResultJob/25/",
                    "run_level": "last",
                    "starttime": "2019-01-17T23:50:33.000769+00:00",
                    "state": "Completed"
                }
            ],
            "reportLink": "/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/",
            "resource_uri": "/rundb/api/v1/pluginresult/25/",
            "result": "/rundb/api/v1/results/6/",
            "resultName": "Auto_user_CB1-42-r9723-314wfa-tl_94",
            "size": "25475",
            "starttime": "2019-01-17T23:50:33.000769+00:00",
            "state": "Completed",
            "store": {},
            "validation_errors": {
                "validation_errors": []
            }
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Plugin Result Job Resource

Resource URL http://mytorrentserver/rundb/api/v1/PluginResultJob/
Schema URL http://mytorrentserver/rundb/api/v1/PluginResultJob/schema/

Resource Fields
field help text default nullable readonly blank unique type
config Unicode string data. Ex: “Hello World”   false false true false string
endtime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
grid_engine_jobid Integer data. Ex: 2673 n/a true false false false integer
id Integer data. Ex: 2673   false false true true integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
run_level Unicode string data. Ex: “Hello World” n/a false false false false string
starttime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
state Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/PluginResultJob/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 18
    },
    "objects": [
        {
            "config": {
                "copyNumberThreshold": "20",
                "email": "osaebo",
                "generateAllPrimerCombinations": true,
                "generateReversedPrimerSets": false,
                "isNC": false,
                "maxClusterVariation": "1.0",
                "ncCT": "33",
                "password": "xl3eple",
                "primerCheckLength": "12",
                "primerCheckMaxErrors": "3",
                "primers": ">V1_2_A_F\nGTGCCTAAYACATGCAWGT\n>V1_2_A_R\nCTGGDCCGTRTCTCAGT",
                "readLengthThreshold": "100",
                "safetyMarginCT": "3",
                "sampleCT": "16",
                "trimEndsWithNoPrimer": "21",
                "useCT": false,
                "useFullPrimerCoverageReadsOnly": false,
                "useReadsWithNoPrimer": false,
                "useWalkingInsDel": false
            },
            "endtime": "2019-01-17T23:50:39.000550+00:00",
            "grid_engine_jobid": 518,
            "id": 25,
            "resource_uri": "/rundb/api/v1/PluginResultJob/25/",
            "run_level": "last",
            "starttime": "2019-01-17T23:50:33.000769+00:00",
            "state": "Completed"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Project Resource

Resource URL http://mytorrentserver/rundb/api/v1/project/
Schema URL http://mytorrentserver/rundb/api/v1/project/schema/

Resource Fields
field help text default nullable readonly blank unique type
created A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
creator A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
id Integer data. Ex: 2673   false false true true integer
modified A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
name Unicode string data. Ex: “Hello World” n/a false false false true string
public Boolean data. Ex: True true false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultsCount Integer data. Ex: 2673 n/a false true false false integer
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/project/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "created": "2017-08-23T21:43:01.000074+00:00",
            "creator": "/rundb/api/v1/user/1/",
            "id": 2,
            "modified": "2018-04-27T18:59:37.000779+00:00",
            "name": "SampleData",
            "public": true,
            "resource_uri": "/rundb/api/v1/project/2/",
            "resultsCount": 0
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Project Results Resource

Resource URL http://mytorrentserver/rundb/api/v1/projectresults/
Schema URL http://mytorrentserver/rundb/api/v1/projectresults/schema/

Resource Fields
field help text default nullable readonly blank unique type
analysisVersion Unicode string data. Ex: “Hello World” n/a false false false false string
autoExempt Boolean data. Ex: True false false false true false boolean
diskusage Integer data. Ex: 2673 n/a true false false false integer
framesProcessed Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
log Unicode string data. Ex: “Hello World”   false false true false string
metaData Unicode string data. Ex: “Hello World” {} false false true false string
parentIDs Unicode string data. Ex: “Hello World”   false false true false string
processedCycles Integer data. Ex: 2673 n/a false false false false integer
processedflows Integer data. Ex: 2673 n/a false false false false integer
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
reference Unicode string data. Ex: “Hello World” n/a true false false false string
reportLink Unicode string data. Ex: “Hello World” n/a false false false false string
reportStatus Unicode string data. Ex: “Hello World” Nothing true false false false string
representative Boolean data. Ex: True false false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultsName Unicode string data. Ex: “Hello World” n/a false false false false string
resultsType Unicode string data. Ex: “Hello World”   false false true false string
runid Unicode string data. Ex: “Hello World”   false false true false string
status Unicode string data. Ex: “Hello World” n/a false false false false string
timeStamp A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
timeToComplete Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/projectresults/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 7
    },
    "objects": [
        {
            "analysisVersion": "_",
            "autoExempt": false,
            "diskusage": 0,
            "framesProcessed": 0,
            "id": 7,
            "log": "/output/Home/CA_Combined_demo_001_007/log.html",
            "metaData": {},
            "parentIDs": ":4:2:",
            "processedCycles": 0,
            "processedflows": 0,
            "projects": [
                "/rundb/api/v1/project/1/"
            ],
            "reference": "hg19",
            "reportLink": "/output/Home/CA_Combined_demo_001_007/",
            "reportStatus": "Nothing",
            "representative": false,
            "resource_uri": "/rundb/api/v1/projectresults/7/",
            "resultsName": "CA_Combined_demo_001",
            "resultsType": "CombinedAlignments",
            "runid": "GOAMS",
            "status": "Pending",
            "timeStamp": "2018-02-28T17:32:01.000577+00:00",
            "timeToComplete": "0"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Publisher Resource

Resource URL http://mytorrentserver/rundb/api/v1/publisher/
Schema URL http://mytorrentserver/rundb/api/v1/publisher/schema/

Resource Fields
field help text default nullable readonly blank unique type
date A date & time as a string. Ex: “2010-11-10T03:07:43” n/a false false false false datetime
global_meta Unicode string data. Ex: “Hello World” {} false false true false string
id Integer data. Ex: 2673   false false true true integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
path Unicode string data. Ex: “Hello World” n/a false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
version Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/publisher/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "date": "2017-07-22T21:17:13.000054+00:00",
            "global_meta": {},
            "id": 2,
            "name": "BED",
            "path": "/results/publishers/BED",
            "resource_uri": "/rundb/api/v1/publisher/BED/",
            "version": "1.0"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Qc Type Resource

Resource URL http://mytorrentserver/rundb/api/v1/qctype/
Schema URL http://mytorrentserver/rundb/api/v1/qctype/schema/

Resource Fields
field help text default nullable readonly blank unique type
defaultThreshold Integer data. Ex: 2673 0 false false false false integer
description Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
maxThreshold Integer data. Ex: 2673 100 false false false false integer
minThreshold Integer data. Ex: 2673 0 false false false false integer
qcName Unicode string data. Ex: “Hello World” n/a false false false true string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/qctype/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 3
    },
    "objects": [
        {
            "defaultThreshold": 30,
            "description": "",
            "id": 3,
            "maxThreshold": 100,
            "minThreshold": 0,
            "qcName": "Usable Sequence (%)",
            "resource_uri": "/rundb/api/v1/qctype/3/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Quality Metrics Resource

Resource URL http://mytorrentserver/rundb/api/v1/qualitymetrics/
Schema URL http://mytorrentserver/rundb/api/v1/qualitymetrics/schema/

Resource Fields
field help text default nullable readonly blank unique type
id Integer data. Ex: 2673   false false true true integer
q0_100bp_reads Integer data. Ex: 2673 n/a false false false false integer
q0_150bp_reads Integer data. Ex: 2673 0 false false false false integer
q0_50bp_reads Integer data. Ex: 2673 n/a false false false false integer
q0_bases Unicode string data. Ex: “Hello World” n/a false false false false string
q0_max_read_length Integer data. Ex: 2673 n/a false false false false integer
q0_mean_read_length Floating point numeric data. Ex: 26.73 n/a false false false false float
q0_median_read_length Integer data. Ex: 2673 0 false false false false integer
q0_mode_read_length Integer data. Ex: 2673 0 false false false false integer
q0_reads Integer data. Ex: 2673 n/a false false false false integer
q17_100bp_reads Integer data. Ex: 2673 n/a false false false false integer
q17_150bp_reads Integer data. Ex: 2673 n/a false false false false integer
q17_50bp_reads Integer data. Ex: 2673 n/a false false false false integer
q17_bases Unicode string data. Ex: “Hello World” n/a false false false false string
q17_max_read_length Integer data. Ex: 2673 n/a false false false false integer
q17_mean_read_length Floating point numeric data. Ex: 26.73 n/a false false false false float
q17_median_read_length Integer data. Ex: 2673 0 false false false false integer
q17_mode_read_length Integer data. Ex: 2673 0 false false false false integer
q17_reads Integer data. Ex: 2673 n/a false false false false integer
q20_100bp_reads Integer data. Ex: 2673 n/a false false false false integer
q20_150bp_reads Integer data. Ex: 2673 n/a false false false false integer
q20_50bp_reads Integer data. Ex: 2673 n/a false false false false integer
q20_bases Unicode string data. Ex: “Hello World” n/a false false false false string
q20_max_read_length Floating point numeric data. Ex: 26.73 n/a false false false false float
q20_mean_read_length Integer data. Ex: 2673 n/a false false false false integer
q20_median_read_length Integer data. Ex: 2673 0 false false false false integer
q20_mode_read_length Integer data. Ex: 2673 0 false false false false integer
q20_reads Integer data. Ex: 2673 n/a false false false false integer
report A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/qualitymetrics/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 6
    },
    "objects": [
        {
            "id": 6,
            "q0_100bp_reads": 1353,
            "q0_150bp_reads": 31,
            "q0_50bp_reads": 1485,
            "q0_bases": "194418",
            "q0_max_read_length": 159,
            "q0_mean_read_length": 127.403669724771,
            "q0_median_read_length": 135,
            "q0_mode_read_length": 141,
            "q0_reads": 1526,
            "q17_100bp_reads": 1353,
            "q17_150bp_reads": 31,
            "q17_50bp_reads": 1485,
            "q17_bases": "178131",
            "q17_max_read_length": 159,
            "q17_mean_read_length": 127.403669724771,
            "q17_median_read_length": 135,
            "q17_mode_read_length": 141,
            "q17_reads": 1526,
            "q20_100bp_reads": 1353,
            "q20_150bp_reads": 31,
            "q20_50bp_reads": 1485,
            "q20_bases": "172077",
            "q20_max_read_length": 159,
            "q20_mean_read_length": 127,
            "q20_median_read_length": 135,
            "q20_mode_read_length": 141,
            "q20_reads": 1526,
            "report": "/rundb/api/v1/results/6/",
            "resource_uri": "/rundb/api/v1/qualitymetrics/6/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Reference Genome Resource

Resource URL http://mytorrentserver/rundb/api/v1/referencegenome/
Schema URL http://mytorrentserver/rundb/api/v1/referencegenome/schema/

Resource Fields
field help text default nullable readonly blank unique type
celery_task_id Unicode string data. Ex: “Hello World”   false false true false string
date A date & time as a string. Ex: “2010-11-10T03:07:43” 2019-11-19T06:33:01.000642+00:00 false false false false datetime
enabled Boolean data. Ex: True true false false true false boolean
id Integer data. Ex: 2673   false false true true integer
identity_hash Unicode string data. Ex: “Hello World” None true false false false string
index_version Unicode string data. Ex: “Hello World”   false false true false string
name Unicode string data. Ex: “Hello World” n/a false false false false string
notes Unicode string data. Ex: “Hello World”   false false true false string
reference_path Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
short_name Unicode string data. Ex: “Hello World” n/a false false false false string
source Unicode string data. Ex: “Hello World”   false false true false string
species Unicode string data. Ex: “Hello World”   false false true false string
status Unicode string data. Ex: “Hello World”   false false true false string
verbose_error Unicode string data. Ex: “Hello World”   false false true false string
version Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/referencegenome/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 7
    },
    "objects": [
        {
            "celery_task_id": "c645df38-1c40-4c84-a627-74b3f82efa4e",
            "date": "2018-08-02T23:23:43.000395+00:00",
            "enabled": true,
            "id": 8,
            "identity_hash": null,
            "index_version": "tmap-f3",
            "name": "Reference for AmpliSeq Mouse Transcriptome runs",
            "notes": "",
            "reference_path": "/results/referenceLibrary/tmap-f3/AmpliSeq_Mouse_Transcriptome_V1_Reference",
            "resource_uri": "/rundb/api/v1/referencegenome/8/",
            "short_name": "AmpliSeq_Mouse_Transcriptome_V1_Reference",
            "source": "/results/referenceLibrary/temp/o_1cjueovofqd516ha144414641jqd7.fasta",
            "species": "",
            "status": "complete",
            "verbose_error": "",
            "version": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Results Resource

Resource URL http://mytorrentserver/rundb/api/v1/results/
Schema URL http://mytorrentserver/rundb/api/v1/results/schema/

Resource Fields
field help text default nullable readonly blank unique type
analysisVersion Unicode string data. Ex: “Hello World” n/a false false false false string
analysismetrics Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
autoExempt Boolean data. Ex: True false false false true false boolean
bamLink Unicode string data. Ex: “Hello World” n/a false false false false string
diskusage Integer data. Ex: 2673 n/a true false false false integer
eas A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
experiment A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
filesystempath Unicode string data. Ex: “Hello World” n/a false false false false string
framesProcessed Integer data. Ex: 2673 n/a false false false false integer
i18nstatus Unicode string data. Ex: “Hello World” n/a false false false false string
id Integer data. Ex: 2673   false false true true integer
libmetrics Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
log Unicode string data. Ex: “Hello World”   false false true false string
metaData Unicode string data. Ex: “Hello World” {} false false true false string
parentIDs Unicode string data. Ex: “Hello World”   false false true false string
planShortID Unicode string data. Ex: “Hello World” n/a false false false false string
pluginState A dictionary of data. Ex: {‘price’: 26.73, ‘name’: ‘Daniel’} n/a false true false false dict
pluginStore A dictionary of data. Ex: {‘price’: 26.73, ‘name’: ‘Daniel’} n/a false true false false dict
pluginresults Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
processedCycles Integer data. Ex: 2673 n/a false false false false integer
processedflows Integer data. Ex: 2673 n/a false false false false integer
projects Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
qualitymetrics Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
reference Unicode string data. Ex: “Hello World” n/a true false false false string
reportLink Unicode string data. Ex: “Hello World” n/a false false false false string
reportStatus Unicode string data. Ex: “Hello World” Nothing true false false false string
reportstorage A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
representative Boolean data. Ex: True false false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
resultsName Unicode string data. Ex: “Hello World” n/a false false false false string
resultsType Unicode string data. Ex: “Hello World”   false false true false string
runid Unicode string data. Ex: “Hello World”   false false true false string
status Unicode string data. Ex: “Hello World” n/a false false false false string
tfmetrics Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
timeStamp A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
timeToComplete Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/results/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 7
    },
    "objects": [
        {
            "analysisVersion": "_",
            "analysismetrics": [],
            "autoExempt": false,
            "bamLink": "/output/Home/CA_Combined_demo_001_007/download_links/NONE_ReportOnly_NONE_CA_Combined_demo_001.bam",
            "diskusage": 0,
            "eas": "/rundb/api/v1/experimentanalysissettings/123/",
            "experiment": "/rundb/api/v1/experiment/124/",
            "filesystempath": "/results/analysis/output/Home/CA_Combined_demo_001_007",
            "framesProcessed": 0,
            "i18nstatus": {
                "i18n": "Pending",
                "state": "Other"
            },
            "id": 7,
            "libmetrics": [],
            "log": "/output/Home/CA_Combined_demo_001_007/log.html",
            "metaData": {},
            "parentIDs": ":4:2:",
            "planShortID": "",
            "pluginresults": [],
            "processedCycles": 0,
            "processedflows": 0,
            "projects": [
                "/rundb/api/v1/project/1/"
            ],
            "qualitymetrics": [],
            "reference": "hg19",
            "reportLink": "/output/Home/CA_Combined_demo_001_007/",
            "reportStatus": "Nothing",
            "reportstorage": {
                "default": true,
                "dirPath": "/results/analysis/output",
                "id": 1,
                "name": "Home",
                "resource_uri": "",
                "webServerPath": "/output"
            },
            "representative": false,
            "resource_uri": "/rundb/api/v1/results/7/",
            "resultsName": "CA_Combined_demo_001",
            "resultsType": "CombinedAlignments",
            "runid": "GOAMS",
            "status": "Pending",
            "tfmetrics": [],
            "timeStamp": "2018-02-28T17:32:01.000577+00:00",
            "timeToComplete": "0"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Rig Resource

Resource URL http://mytorrentserver/rundb/api/v1/rig/
Schema URL http://mytorrentserver/rundb/api/v1/rig/schema/

Resource Fields
field help text default nullable readonly blank unique type
alarms Unicode string data. Ex: “Hello World” {} false false true false string
comments Unicode string data. Ex: “Hello World”   false false true false string
display_state Unicode string data. Ex: “Hello World”   false false true false string
ftppassword Unicode string data. Ex: “Hello World” ionguest false false false false string
ftprootdir Unicode string data. Ex: “Hello World” results false false false false string
ftpserver Unicode string data. Ex: “Hello World” 192.168.201.1 false false false false string
ftpusername Unicode string data. Ex: “Hello World” ionguest false false false false string
host_address Unicode string data. Ex: “Hello World”   false false true false string
last_clean_date Unicode string data. Ex: “Hello World”   false false true false string
last_experiment Unicode string data. Ex: “Hello World”   false false true false string
last_init_date Unicode string data. Ex: “Hello World”   false false true false string
location A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
name Unicode string data. Ex: “Hello World” n/a false false false true string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
serial Unicode string data. Ex: “Hello World” n/a true false false false string
state Unicode string data. Ex: “Hello World”   false false true false string
type Unicode string data. Ex: “Hello World”   false false true false string
updateCommand Unicode string data. Ex: “Hello World” {} false false true false string
updateflag Boolean data. Ex: True false false false true false boolean
updatehome Unicode string data. Ex: “Hello World” 192.168.201.1 false false false false string
version Unicode string data. Ex: “Hello World” {} false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/rig/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 4
    },
    "objects": [
        {
            "alarms": {},
            "comments": "",
            "display_state": "",
            "ftppassword": "ionguest",
            "ftprootdir": "results",
            "ftpserver": "192.168.201.1",
            "ftpusername": "ionguest",
            "host_address": "",
            "last_clean_date": "",
            "last_experiment": "",
            "last_init_date": "",
            "location": {
                "comments": "",
                "defaultlocation": true,
                "id": 1,
                "name": "Home",
                "resource_uri": "/rundb/api/v1/location/1/"
            },
            "name": "S5_DemoData",
            "resource_uri": "/rundb/api/v1/rig/S5_DemoData/",
            "serial": "",
            "state": "",
            "type": "",
            "updateCommand": {},
            "updateflag": false,
            "updatehome": "192.168.201.1",
            "version": {}
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Run Type Resource

Resource URL http://mytorrentserver/rundb/api/v1/runtype/
Schema URL http://mytorrentserver/rundb/api/v1/runtype/schema/

Resource Fields
field help text default nullable readonly blank unique type
alternate_name Unicode string data. Ex: “Hello World”   true false false false string
applicationGroups Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false false false related
barcode Unicode string data. Ex: “Hello World”   false false true false string
description Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
meta Unicode string data. Ex: “Hello World”   true false false false string
nucleotideType Unicode string data. Ex: “Hello World” dna false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runType Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/runtype/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 15
    },
    "objects": [
        {
            "alternate_name": "AmpliSeq HD - DNA and Fusions (Single Library)",
            "applicationGroups": [
                "/rundb/api/v1/applicationgroup/11/"
            ],
            "barcode": "",
            "description": "AmpliSeq HD - DNA and Fusions (Single Library)",
            "id": 15,
            "isActive": true,
            "meta": {},
            "nucleotideType": "dna",
            "resource_uri": "/rundb/api/v1/runtype/15/",
            "runType": "AMPS_HD_DNA_RNA_1"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sample Resource

Resource URL http://mytorrentserver/rundb/api/v1/sample/
Schema URL http://mytorrentserver/rundb/api/v1/sample/schema/

Resource Fields
field help text default nullable readonly blank unique type
date A date & time as a string. Ex: “2010-11-10T03:07:43” true true false false false datetime
description Unicode string data. Ex: “Hello World” n/a true false false false string
displayedName Unicode string data. Ex: “Hello World” n/a true false false false string
experiments Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
externalId Unicode string data. Ex: “Hello World”   true false false false string
id Integer data. Ex: 2673   false false true true integer
name Unicode string data. Ex: “Hello World” n/a true false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sampleSets Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
status Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/sample/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 23
    },
    "objects": [
        {
            "date": "2018-04-13T22:17:13.000114+00:00",
            "description": "",
            "displayedName": "Sample 9",
            "experiments": [
                "/rundb/api/v1/experiment/136/"
            ],
            "externalId": "",
            "id": 26,
            "name": "Sample_9",
            "resource_uri": "/rundb/api/v1/sample/26/",
            "sampleSets": [],
            "status": "planned"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
Allowed detail HTTP methods
  • GET
  • POST
  • PUT

Sample Annotation Cv Resource

Resource URL http://mytorrentserver/rundb/api/v1/sampleannotation_cv/
Schema URL http://mytorrentserver/rundb/api/v1/sampleannotation_cv/schema/

Resource Fields
field help text default nullable readonly blank unique type
annotationType Unicode string data. Ex: “Hello World” n/a false false false false string
iRAnnotationType Unicode string data. Ex: “Hello World” n/a true false false false string
iRValue Unicode string data. Ex: “Hello World” n/a true false false false string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
isIRCompatible Boolean data. Ex: True false false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sampleGroupType_CV A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
uid Unicode string data. Ex: “Hello World” n/a false false false true string
value Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/sampleannotation_cv/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 90
    },
    "objects": [
        {
            "annotationType": "16s_markers",
            "iRAnnotationType": "16S_Markers",
            "iRValue": "Target Species",
            "id": 90,
            "isActive": true,
            "isIRCompatible": true,
            "resource_uri": "/rundb/api/v1/sampleannotation_cv/90/",
            "sampleGroupType_CV": null,
            "uid": "SAMPLEANNOTATE_CV_0090",
            "value": "Target Species"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sample Attribute Resource

Resource URL http://mytorrentserver/rundb/api/v1/sampleattribute/
Schema URL http://mytorrentserver/rundb/api/v1/sampleattribute/schema/

Resource Fields
field help text default nullable readonly blank unique type
creationDate A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
dataType A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
dataType_name Unicode string data. Ex: “Hello World” n/a true true true false string
description Unicode string data. Ex: “Hello World” n/a true false false false string
displayedName Unicode string data. Ex: “Hello World” n/a false false false true string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
isMandatory Boolean data. Ex: True false false false true false boolean
lastModifiedDate A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sampleCount Integer data. Ex: 2673 n/a false true false false integer
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "creationDate": "2019-02-21T20:37:39.000872+00:00",
            "dataType": "/rundb/api/v1/sampleattributedatatype/1/",
            "dataType_name": "Text",
            "description": "",
            "displayedName": "customattribute",
            "id": 1,
            "isActive": true,
            "isMandatory": false,
            "lastModifiedDate": "2019-02-21T20:38:36.000274+00:00",
            "resource_uri": "/rundb/api/v1/sampleattribute/1/",
            "sampleCount": 0
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sample Attribute Data Type Resource

Resource URL http://mytorrentserver/rundb/api/v1/sampleattributedatatype/
Schema URL http://mytorrentserver/rundb/api/v1/sampleattributedatatype/schema/

Resource Fields
field help text default nullable readonly blank unique type
dataType Unicode string data. Ex: “Hello World” n/a false false false true string
description Unicode string data. Ex: “Hello World” n/a true false false false string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/sampleattributedatatype/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "dataType": "Integer",
            "description": "Whole number",
            "id": 2,
            "isActive": true,
            "resource_uri": "/rundb/api/v1/sampleattributedatatype/2/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sample Group Type Cv Resource

Resource URL http://mytorrentserver/rundb/api/v1/samplegrouptype_cv/
Schema URL http://mytorrentserver/rundb/api/v1/samplegrouptype_cv/schema/

Resource Fields
field help text default nullable readonly blank unique type
description Unicode string data. Ex: “Hello World” n/a true false false false string
displayedName Unicode string data. Ex: “Hello World” n/a false false false true string
iRAnnotationType Unicode string data. Ex: “Hello World” n/a true false false false string
iRValue Unicode string data. Ex: “Hello World” n/a true false false false string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
isIRCompatible Boolean data. Ex: True false false false true false boolean
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sampleAnnotation_set Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
sampleSets Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/samplegrouptype_cv/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 7
    },
    "objects": [
        {
            "description": "",
            "displayedName": "Single Fusions",
            "iRAnnotationType": "RelationshipType",
            "iRValue": "SINGLE_RNA_FUSION",
            "id": 7,
            "isActive": true,
            "isIRCompatible": true,
            "resource_uri": "/rundb/api/v1/samplegrouptype_cv/7/",
            "sampleAnnotation_set": [],
            "sampleSets": [],
            "uid": "SAMPLEGROUP_CV_0007"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sample Prep Data Resource

Resource URL http://mytorrentserver/rundb/api/v1/sampleprepdata/
Schema URL http://mytorrentserver/rundb/api/v1/sampleprepdata/schema/

Resource Fields
field help text default nullable readonly blank unique type
endTime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
id Integer data. Ex: 2673   false false true true integer
instrumentName Unicode string data. Ex: “Hello World”   false false true false string
instrumentStatus Unicode string data. Ex: “Hello World”   false false true false string
kitType Unicode string data. Ex: “Hello World”   false false true false string
lastUpdate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
logPath Unicode string data. Ex: “Hello World” n/a true false false false string
message Unicode string data. Ex: “Hello World”   false false true false string
operationMode Unicode string data. Ex: “Hello World”   false false true false string
packageVer Unicode string data. Ex: “Hello World”   false false true false string
progress Floating point numeric data. Ex: 26.73 0 false false true false float
reagentsExpiration Unicode string data. Ex: “Hello World”   false false true false string
reagentsLot Unicode string data. Ex: “Hello World”   false false true false string
reagentsPart Unicode string data. Ex: “Hello World”   false false true false string
remainingSeconds Integer data. Ex: 2673 n/a true false false false integer
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
samplePrepDataType Unicode string data. Ex: “Hello World”   false false true false string
scriptVersion Unicode string data. Ex: “Hello World”   false false true false string
solutionsExpiration Unicode string data. Ex: “Hello World”   false false true false string
solutionsLot Unicode string data. Ex: “Hello World”   false false true false string
solutionsPart Unicode string data. Ex: “Hello World”   false false true false string
startTime A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
tipRackBarcode Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 0
    },
    "objects": []
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sample Set Resource

Resource URL http://mytorrentserver/rundb/api/v1/sampleset/
Schema URL http://mytorrentserver/rundb/api/v1/sampleset/schema/

Resource Fields
field help text default nullable readonly blank unique type
SampleGroupType_CV A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
additionalCycles Unicode string data. Ex: “Hello World” n/a true false false false string
combinedLibraryTubeLabel Unicode string data. Ex: “Hello World”   false false true false string
creationDate A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
cyclingProtocols Unicode string data. Ex: “Hello World” n/a true false false false string
description Unicode string data. Ex: “Hello World” n/a true false false false string
displayedName Unicode string data. Ex: “Hello World” n/a false false false true string
id Integer data. Ex: 2673   false false true true integer
lastModifiedDate A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
libraryPrepInstrument Unicode string data. Ex: “Hello World”   false false true false string
libraryPrepInstrumentData A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
libraryPrepKitDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
libraryPrepKitName Unicode string data. Ex: “Hello World” n/a true false false false string
libraryPrepPlateType Unicode string data. Ex: “Hello World”   false false true false string
libraryPrepType Unicode string data. Ex: “Hello World”   false false true false string
libraryPrepTypeDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
pcrPlateSerialNum Unicode string data. Ex: “Hello World”   true false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sampleCount Integer data. Ex: 2673 n/a false true false false integer
sampleGroupTypeName Unicode string data. Ex: “Hello World” n/a true true true false string
samples Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a true false true false related
status Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/sampleset/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "SampleGroupType_CV": null,
            "additionalCycles": null,
            "combinedLibraryTubeLabel": "",
            "creationDate": "2017-11-01T16:19:12.000371+00:00",
            "cyclingProtocols": null,
            "description": "",
            "displayedName": "Sample Set 1",
            "id": 2,
            "lastModifiedDate": "2017-11-01T16:19:12.000371+00:00",
            "libraryPrepInstrument": "",
            "libraryPrepInstrumentData": null,
            "libraryPrepKitDisplayedName": "",
            "libraryPrepKitName": "",
            "libraryPrepPlateType": "",
            "libraryPrepType": "",
            "libraryPrepTypeDisplayedName": "",
            "pcrPlateSerialNum": "",
            "readyForPlanning": true,
            "resource_uri": "/rundb/api/v1/sampleset/2/",
            "sampleCount": 8,
            "sampleGroupTypeName": "",
            "samples": [
                "/rundb/api/v1/samplesetitem/6/",
                "/rundb/api/v1/samplesetitem/8/",
                "/rundb/api/v1/samplesetitem/10/",
                "/rundb/api/v1/samplesetitem/12/",
                "/rundb/api/v1/samplesetitem/14/",
                "/rundb/api/v1/samplesetitem/16/",
                "/rundb/api/v1/samplesetitem/18/",
                "/rundb/api/v1/samplesetitem/19/"
            ],
            "status": "created"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sample Set Item Resource

Resource URL http://mytorrentserver/rundb/api/v1/samplesetitem/
Schema URL http://mytorrentserver/rundb/api/v1/samplesetitem/schema/

Resource Fields
field help text default nullable readonly blank unique type
assayGroup Unicode string data. Ex: “Hello World” n/a true false false false string
biopsyDays Integer data. Ex: 2673 0 true false false false integer
cancerType Unicode string data. Ex: “Hello World” n/a true false false false string
cellNum Unicode string data. Ex: “Hello World”   true false false false string
cellularityPct Integer data. Ex: 2673 n/a true false false false integer
controlType Unicode string data. Ex: “Hello World”   true false false false string
coupleId Unicode string data. Ex: “Hello World”   true false false false string
creationDate A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
description Unicode string data. Ex: “Hello World”   true false false false string
dnabarcode A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
embryoId Unicode string data. Ex: “Hello World”   true false false false string
gender Unicode string data. Ex: “Hello World” n/a true false false false string
id Integer data. Ex: 2673   false false true true integer
lastModifiedDate A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
mouseStrains Unicode string data. Ex: “Hello World” n/a true false false false string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
panelPoolType Unicode string data. Ex: “Hello World” n/a true false false false string
pcrPlateColumn Unicode string data. Ex: “Hello World”   true false false false string
pcrPlateRow Unicode string data. Ex: “Hello World”   true false false false string
population Unicode string data. Ex: “Hello World” n/a true false false false string
relationshipGroup Integer data. Ex: 2673 n/a false false false false integer
relationshipRole Unicode string data. Ex: “Hello World” n/a true false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sample A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleCollectionDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
sampleReceiptDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
sampleSet A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleSource Unicode string data. Ex: “Hello World” n/a true false false false string
tubePosition Unicode string data. Ex: “Hello World”   true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/samplesetitem/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 16
    },
    "objects": [
        {
            "assayGroup": null,
            "biopsyDays": 0,
            "cancerType": "",
            "cellNum": "",
            "cellularityPct": null,
            "controlType": "",
            "coupleId": "",
            "creationDate": "2017-11-01T18:48:24.000678+00:00",
            "description": "",
            "dnabarcode": null,
            "embryoId": "",
            "gender": "",
            "id": 19,
            "lastModifiedDate": "2017-11-01T18:48:24.000678+00:00",
            "mouseStrains": null,
            "nucleotideType": "",
            "panelPoolType": null,
            "pcrPlateColumn": "",
            "pcrPlateRow": "",
            "population": null,
            "relationshipGroup": 0,
            "relationshipRole": "",
            "resource_uri": "/rundb/api/v1/samplesetitem/19/",
            "sample": "/rundb/api/v1/sample/16/",
            "sampleCollectionDate": null,
            "sampleReceiptDate": null,
            "sampleSet": "/rundb/api/v1/sampleset/2/",
            "sampleSource": null,
            "tubePosition": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sample Set Item Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/samplesetiteminfo/
Schema URL http://mytorrentserver/rundb/api/v1/samplesetiteminfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
assayGroup Unicode string data. Ex: “Hello World” n/a true false false false string
biopsyDays Integer data. Ex: 2673 0 true false false false integer
cancerType Unicode string data. Ex: “Hello World” n/a true false false false string
cellNum Unicode string data. Ex: “Hello World”   true false false false string
cellularityPct Integer data. Ex: 2673 n/a true false false false integer
controlType Unicode string data. Ex: “Hello World”   true false false false string
coupleId Unicode string data. Ex: “Hello World”   true false false false string
creationDate A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
description Unicode string data. Ex: “Hello World”   true false false false string
dnabarcode A single related resource. Can be either a URI or set of nested resource data. n/a true true true false related
dnabarcodeKit Unicode string data. Ex: “Hello World” n/a true true true false string
embryoId Unicode string data. Ex: “Hello World”   true false false false string
gender Unicode string data. Ex: “Hello World” n/a true false false false string
id Integer data. Ex: 2673   false false true true integer
lastModifiedDate A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
mouseStrains Unicode string data. Ex: “Hello World” n/a true false false false string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
panelPoolType Unicode string data. Ex: “Hello World” n/a true false false false string
pcrPlateColumn Unicode string data. Ex: “Hello World”   true false false false string
pcrPlateRow Unicode string data. Ex: “Hello World”   true false false false string
population Unicode string data. Ex: “Hello World” n/a true false false false string
relationshipGroup Integer data. Ex: 2673 n/a true true true false integer
relationshipRole Unicode string data. Ex: “Hello World” n/a true true true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sample A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleCollectionDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
sampleDescription Unicode string data. Ex: “Hello World” n/a true true true false string
sampleDisplayedName Unicode string data. Ex: “Hello World” n/a true true true false string
sampleExternalId Unicode string data. Ex: “Hello World” n/a true true true false string
samplePk Integer data. Ex: 2673 n/a true true true false integer
sampleReceiptDate A date & time as a string. Ex: “2010-11-10T03:07:43” n/a true false false false datetime
sampleSet A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related
sampleSetPk Integer data. Ex: 2673 n/a true true true false integer
sampleSetStatus Unicode string data. Ex: “Hello World” n/a true true true false string
sampleSource Unicode string data. Ex: “Hello World” n/a true false false false string
tubePosition Unicode string data. Ex: “Hello World”   true false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/samplesetiteminfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 16
    },
    "objects": [
        {
            "assayGroup": null,
            "attribute_dict": {
                "customattribute": ""
            },
            "biopsyDays": 0,
            "cancerType": "",
            "cellNum": "",
            "cellularityPct": null,
            "controlType": "",
            "coupleId": "",
            "creationDate": "2017-11-01T18:48:24.000678+00:00",
            "customattribute": "",
            "description": "",
            "dnabarcode": "",
            "dnabarcodeKit": "",
            "embryoId": "",
            "gender": "",
            "id": 19,
            "lastModifiedDate": "2017-11-01T18:48:24.000678+00:00",
            "mouseStrains": null,
            "nucleotideType": "",
            "panelPoolType": null,
            "pcrPlateColumn": "",
            "pcrPlateRow": "",
            "population": null,
            "relationshipGroup": 0,
            "relationshipRole": "",
            "resource_uri": "/rundb/api/v1/samplesetiteminfo/19/",
            "sample": "/rundb/api/v1/sample/16/",
            "sampleCollectionDate": null,
            "sampleDescription": "",
            "sampleDisplayedName": "test sample",
            "sampleExternalId": "",
            "samplePk": 16,
            "sampleReceiptDate": null,
            "sampleSet": "/rundb/api/v1/sampleset/2/",
            "sampleSetGroupType": "",
            "sampleSetPk": 2,
            "sampleSetStatus": "created",
            "sampleSource": null,
            "tubePosition": ""
        }
    ]
}
Allowed list HTTP methods
  • GET
Allowed detail HTTP methods
  • GET

Sequencing Kit Info Resource

Resource URL http://mytorrentserver/rundb/api/v1/sequencingkitinfo/
Schema URL http://mytorrentserver/rundb/api/v1/sequencingkitinfo/schema/

Resource Fields
field help text default nullable readonly blank unique type
applicationType Unicode string data. Ex: “Hello World”   true false false false string
cartridgeBetweenUsageAbsoluteMaxDayLimit Integer data. Ex: 2673 n/a true false false false integer
cartridgeExpirationDayLimit Integer data. Ex: 2673 n/a true false false false integer
categories Unicode string data. Ex: “Hello World”   true false false false string
chipTypes Unicode string data. Ex: “Hello World”   false false true false string
defaultCartridgeUsageCount Integer data. Ex: 2673 n/a true false false false integer
defaultFlowOrder A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
description Unicode string data. Ex: “Hello World”   false false true false string
flowCount Integer data. Ex: 2673 n/a false false false false integer
id Integer data. Ex: 2673   false false true true integer
instrumentType Unicode string data. Ex: “Hello World”   false false true false string
isActive Boolean data. Ex: True true false false true false boolean
kitType Unicode string data. Ex: “Hello World” n/a false false false false string
libraryReadLength Integer data. Ex: 2673 0 false false false false integer
name Unicode string data. Ex: “Hello World” n/a false false false true string
nucleotideType Unicode string data. Ex: “Hello World”   false false true false string
parts Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World”   false false true false string
samplePrep_instrumentType Unicode string data. Ex: “Hello World”   false false true false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/sequencingkitinfo/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 27
    },
    "objects": [
        {
            "applicationType": "AMPS",
            "cartridgeBetweenUsageAbsoluteMaxDayLimit": null,
            "cartridgeExpirationDayLimit": null,
            "categories": "filter_s5HidKit",
            "chipTypes": "",
            "defaultCartridgeUsageCount": null,
            "defaultFlowOrder": null,
            "description": "Precision ID S5 Sequencing Kit",
            "flowCount": 650,
            "id": 20111,
            "instrumentType": "S5",
            "isActive": true,
            "kitType": "SequencingKit",
            "libraryReadLength": 0,
            "name": "precisionIDS5Kit",
            "nucleotideType": "",
            "parts": [
                {
                    "barcode": "100041073B",
                    "id": 20236,
                    "kit": "/rundb/api/v1/kitinfo/20111/",
                    "resource_uri": "/rundb/api/v1/kitpart/20236/"
                },
                {
                    "barcode": "100041074B",
                    "id": 20237,
                    "kit": "/rundb/api/v1/kitinfo/20111/",
                    "resource_uri": "/rundb/api/v1/kitpart/20237/"
                },
                {
                    "barcode": "A33208",
                    "id": 20260,
                    "kit": "/rundb/api/v1/kitinfo/20111/",
                    "resource_uri": "/rundb/api/v1/kitpart/20260/"
                },
                {
                    "barcode": "100049484",
                    "id": 20263,
                    "kit": "/rundb/api/v1/kitinfo/20111/",
                    "resource_uri": "/rundb/api/v1/kitpart/20263/"
                }
            ],
            "resource_uri": "/rundb/api/v1/sequencingkitinfo/20111/",
            "runMode": "",
            "samplePrep_instrumentType": "",
            "uid": "SEQ0028"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Sequencing Kit Part Resource

Resource URL http://mytorrentserver/rundb/api/v1/sequencingkitpart/
Schema URL http://mytorrentserver/rundb/api/v1/sequencingkitpart/schema/

Resource Fields
field help text default nullable readonly blank unique type
barcode Unicode string data. Ex: “Hello World” n/a false false false true string
defaultFlowOrder A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
id Integer data. Ex: 2673   false false true true integer
kit A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/sequencingkitpart/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 99
    },
    "objects": [
        {
            "barcode": "100049484",
            "defaultFlowOrder": null,
            "id": 20263,
            "kit": "/rundb/api/v1/kitinfo/20111/",
            "resource_uri": "/rundb/api/v1/sequencingkitpart/20263/"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Support Upload Resource

Resource URL http://mytorrentserver/rundb/api/v1/supportupload/
Schema URL http://mytorrentserver/rundb/api/v1/supportupload/schema/

Resource Fields
field help text default nullable readonly blank unique type
celery_task_id Unicode string data. Ex: “Hello World”   false false true false string
contact_email Unicode string data. Ex: “Hello World”   false false false false string
created A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
description Unicode string data. Ex: “Hello World”   false false false false string
file A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related
id Integer data. Ex: 2673   false false true true integer
local_message Unicode string data. Ex: “Hello World”   false false true false string
local_status Unicode string data. Ex: “Hello World”   false false true false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
result A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
ticket_id Unicode string data. Ex: “Hello World”   false false true false string
ticket_message Unicode string data. Ex: “Hello World”   false false true false string
ticket_status Unicode string data. Ex: “Hello World”   false false true false string
updated A date & time as a string. Ex: “2010-11-10T03:07:43” true false false true false datetime
Example Response
{
    "meta": {
        "limit": 1,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 0
    },
    "objects": []
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Template Resource

Resource URL http://mytorrentserver/rundb/api/v1/template/
Schema URL http://mytorrentserver/rundb/api/v1/template/schema/

Resource Fields
field help text default nullable readonly blank unique type
comments Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
isofficial Boolean data. Ex: True true false false true false boolean
key Unicode string data. Ex: “Hello World” n/a false false false false string
name Unicode string data. Ex: “Hello World” n/a false false false false string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sequence Unicode string data. Ex: “Hello World”   false false true false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/template/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 6
    },
    "objects": [
        {
            "comments": " ",
            "id": 6,
            "isofficial": true,
            "key": "ATCG",
            "name": "TF_1",
            "resource_uri": "/rundb/api/v1/template/6/",
            "sequence": "GAATAATCCAGCCCGCCAGGCATGGAAGAGCGTCGTAAAGTATTGCAGGTTCAGGCGGCGGAAAGCGTGATTGACTACTGGCAAATAAAGTACGTTCCACCTTTGACACCATTTTCCGTAGTGAACTGACGCTGCCAAACGCCGACCGCG"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Tf Metrics Resource

Resource URL http://mytorrentserver/rundb/api/v1/tfmetrics/
Schema URL http://mytorrentserver/rundb/api/v1/tfmetrics/schema/

Resource Fields
field help text default nullable readonly blank unique type
HPAccuracy Unicode string data. Ex: “Hello World”   false false true false string
Q10Histo Unicode string data. Ex: “Hello World”   false false true false string
Q10Mean Floating point numeric data. Ex: 26.73 n/a false false false false float
Q10ReadCount Floating point numeric data. Ex: 26.73 n/a false false false false float
Q17Histo Unicode string data. Ex: “Hello World”   false false true false string
Q17Mean Floating point numeric data. Ex: 26.73 n/a false false false false float
Q17ReadCount Floating point numeric data. Ex: 26.73 n/a false false false false float
SysSNR Floating point numeric data. Ex: 26.73 n/a false false false false float
aveKeyCount Floating point numeric data. Ex: 26.73 n/a false false false false float
corrHPSNR Unicode string data. Ex: “Hello World”   false false true false string
id Integer data. Ex: 2673   false false true true integer
keypass Floating point numeric data. Ex: 26.73 n/a false false false false float
name Unicode string data. Ex: “Hello World” n/a false false false false string
number Floating point numeric data. Ex: 26.73 n/a false false false false float
report A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
sequence Unicode string data. Ex: “Hello World” n/a false false false false string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/tfmetrics/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 10
    },
    "objects": [
        {
            "HPAccuracy": "0 : 35872169/36179467, 1 : 20822701/21171718, 2 : 6426443/6700122, 3 : 1749997/1876013, 4 : 249642/267974, 5 : 0/0, 6 : 0/0, 7 : 0/0",
            "Q10Histo": "401 4430 27 957 8 4 85 0 8 38 37 32 25 14 38 29 18 21 45 31 64 210 122 127 146 42 35 27 18 49 76 45 55 37 123 149 24 92 407 62 23 35 61 39 47 70 28 24 38 50 442 53 31 22 77 14 8 22 17 17 101 39 41 203 43 31 18 25 31 21 54 200 60 57 35 70 58 36 48 65 69 54 55 35 43 57 58 34 56 150 110 94 114 121 79 69 37 49 27 14 23 25 47 81 34 42 30 57 66 299 74 63 163 563 553 124 101 48 42 58 68 67 46 64 67 62 55 48 68 79 131 107 101 110 105 93 123 183 243 436 497 430 522 906 1404 1817 1933 1828 4497 22354 153736 25634 9781 5977 4612 4583 3267 2205 1537 1158 899 681 523 408 190 59 11 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0",
            "Q10Mean": 144,
            "Q10ReadCount": 259462,
            "Q17Histo": "5571 18198 104 5151 2507 67 1317 453 82 221 203 1122 26 151 439 177 104 216 264 33 376 638 467 224 72 200 44 137 87 71 93 68 85 56 128 135 76 37 452 52 25 99 57 3 48 60 250 1 20 4 502 69 169 62 134 58 51 155 44 197 507 106 285 198 106 58 86 86 96 113 73 268 128 133 116 114 100 133 179 254 213 130 81 102 39 190 170 255 66 163 146 64 57 59 28 29 8 45 12 14 157 181 71 214 37 41 84 75 108 432 162 229 236 741 560 149 99 114 57 77 80 148 145 153 147 88 75 67 80 86 113 71 115 99 132 40 138 88 192 319 328 217 199 549 955 1313 1193 524 3093 20272 152212 24060 7616 2382 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0",
            "Q17Mean": 125,
            "Q17ReadCount": 227564,
            "SysSNR": 9.37860903870432,
            "aveKeyCount": 89,
            "corrHPSNR": "",
            "id": 10,
            "keypass": 268035,
            "name": "TF_1",
            "number": 268035,
            "report": "/rundb/api/v1/results/5/",
            "resource_uri": "/rundb/api/v1/tfmetrics/10/",
            "sequence": "GAATAATCCAGCCCGCCAGGCATGGAAGAGCGTCGTAAAGTATTGCAGGTTCAGGCGGCGGAAAGCGTGATTGACTACTGGCAAATAAAGTACGTTCCACCTTTGACACCATTTTCCGTAGTGAACTGACGCTGCCAAACGCCGACCGCG"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Three Prime Adapter Resource

Resource URL http://mytorrentserver/rundb/api/v1/threeprimeadapter/
Schema URL http://mytorrentserver/rundb/api/v1/threeprimeadapter/schema/

Resource Fields
field help text default nullable readonly blank unique type
chemistryType Unicode string data. Ex: “Hello World”   false false true false string
description Unicode string data. Ex: “Hello World”   false false true false string
direction Unicode string data. Ex: “Hello World” Forward false false false false string
id Integer data. Ex: 2673   false false true true integer
isActive Boolean data. Ex: True true false false true false boolean
isDefault Boolean data. Ex: True false false false true false boolean
name Unicode string data. Ex: “Hello World” n/a false false false true string
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
runMode Unicode string data. Ex: “Hello World” single false false true false string
sequence Unicode string data. Ex: “Hello World” n/a false false false false string
uid Unicode string data. Ex: “Hello World” n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/threeprimeadapter/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 8
    },
    "objects": [
        {
            "chemistryType": "",
            "description": "Ion Xpress MuSeek adapter",
            "direction": "Forward",
            "id": 8,
            "isActive": true,
            "isDefault": false,
            "name": " Ion Xpress MuSeek adapter",
            "resource_uri": "/rundb/api/v1/threeprimeadapter/8/",
            "runMode": "single",
            "sequence": "TGCACTGAAGCACACAATCACCGACTGCCC",
            "uid": "FWD_0007"
        }
    ]
}
Allowed list HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
Allowed detail HTTP methods
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Torrent Suite Resource

Resource URL http://mytorrentserver/rundb/api/v1/torrentsuite/
Schema URL http://mytorrentserver/rundb/api/v1/torrentsuite/schema/

Resource Fields
field help text default nullable readonly blank unique type
meta_version Unicode string data. Ex: “Hello World” n/a true true true false string
locked Unicode string data. Ex: “Hello World” n/a true true true false boolean
logs Unicode string data. Ex: “Hello World” n/a true true true false boolean
versions Unicode string data. Ex: “Hello World” n/a true true true false string
Example Response
{
    "locked": false,
    "logs": false,
    "meta_version": "5.12.1",
    "versions": {
        "ion-analysis": "5.12.27-1",
        "ion-chefupdates": "5.12.3",
        "ion-dbreports": "5.12.60-1",
        "ion-docs": "5.12.1",
        "ion-gpu": "5.12.1-1",
        "ion-onetouchupdater": "5.0.2-1",
        "ion-pipeline": "5.12.17-1",
        "ion-plugins": "5.12.15-1",
        "ion-publishers": "5.12.1-1",
        "ion-referencelibrary": "2.2.0",
        "ion-rsmts": "5.12.5-1",
        "ion-sampledata": "1.2.0-1",
        "ion-torrentpy": "5.12.21-1",
        "ion-torrentr": "5.12.23-1",
        "ion-tsconfig": "5.12.23-1"
    }
}
Allowed list HTTP methods
  • GET
  • PUT
Allowed detail HTTP methods

None

User Resource

Resource URL http://mytorrentserver/rundb/api/v1/user/
Schema URL http://mytorrentserver/rundb/api/v1/user/schema/

Resource Fields
field help text default nullable readonly blank unique type
date_joined A date & time as a string. Ex: “2010-11-10T03:07:43” 2019-11-19T06:33:10.000022+00:00 false false false false datetime
email Unicode string data. Ex: “Hello World”   false false true false string
first_name Unicode string data. Ex: “Hello World”   false false true false string
full_name Unicode string data. Ex: “Hello World” n/a false false false false string
id Integer data. Ex: 2673   false false true true integer
is_active Designates whether this user should be treated as active. Unselect this instead of deleting accounts. true false false true false boolean
last_login A date & time as a string. Ex: “2010-11-10T03:07:43” 2019-11-19T06:33:10.000022+00:00 false false false false datetime
last_name Unicode string data. Ex: “Hello World”   false false true false string
profile A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
resource_uri Unicode string data. Ex: “Hello World” n/a false true false false string
username Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters n/a false false false true string
Example Response
{
    "meta": {
        "limit": 1,
        "next": "/rundb/api/v1/user/?offset=1&limit=1&format=json",
        "offset": 0,
        "previous": null,
        "total_count": 6
    },
    "objects": [
        {
            "date_joined": "2017-07-24T18:11:45.000735+00:00",
            "email": "yourname@mail.com",
            "first_name": "",
            "full_name": "",
            "id": 6,
            "is_active": true,
            "last_login": "2017-07-24T18:11:45.000735+00:00",
            "last_name": "",
            "profile": {
                "id": 6,
                "last_read_news_post": "1984-11-06T00:00:00+00:00",
                "name": "",
                "needs_activation": false,
                "note": "",
                "phone_number": "",
                "resource_uri": "",
                "title": "user"
            },
            "resource_uri": "/rundb/api/v1/user/6/",
            "username": "dm_contact"
        }
    ]
}
Allowed list HTTP methods
  • GET
Allowed detail HTTP methods
  • GET

API Examples

See API Reference for a listing of all available APIs. This section has the setup common to all the API examples. See Authentication for more information on the authentication header. All examples use the third-party python library requests.

import requests

BASE_URL = "http://example.xyz"
USERNAME = "ionadmin"
API_KEY = "efb7a14021732d773a4258b69d9452042a31a6b6"

Fetching all Chips

Using the Chip Resource API.

headers = {"Authorization": "ApiKey " + USERNAME + ":" + API_KEY}
object_list = []

next_url = "/rundb/api/v1/chip/"
while next_url:
    response = requests.get(BASE_URL + next_url, headers=headers, params={})
    response.raise_for_status()
    response_data = response.json()

    object_list += response_data["objects"]
    next_url = response_data["meta"]["next"] or None

print object_list

[...]

Adding Filters

Using the Chip Resource API.

headers = {"Authorization": "ApiKey " + USERNAME + ":" + API_KEY}
object_list = []

next_url = "/rundb/api/v1/chip/"
while next_url:
    response = requests.get(BASE_URL + next_url, headers=headers, params={"name__startswith": "31"})
    response.raise_for_status()
    response_data = response.json()

    object_list += response_data["objects"]
    next_url = response_data["meta"]["next"] or None

for chip in object_list[0:3]:
    print chip["name"]

314
316
318

Completed Runs and Reports

Using the Composite Experiment Resource API.

headers = {"Authorization": "ApiKey " + USERNAME + ":" + API_KEY}
object_list = []

next_url = "/rundb/api/v1/compositeexperiment/"
while next_url:
    response = requests.get(BASE_URL + next_url, headers=headers)
    response.raise_for_status()
    response_data = response.json()

    object_list += response_data["objects"]
    next_url = response_data["meta"]["next"] or None

for experiment in object_list[0:3]:
    print experiment["displayName"]
    for report in experiment["results"]:
        print "    " + report["resultsName"] + " " + report["status"]

S5-530 cfDNA
    Reanalyze Completed
    S5-530_cfDNA Completed
    Auto_S5-530_cfDNA_89 Completed
S5-540 AmpliSeqExome
    S5-540_AmpliSeqExome Importing Failed
    Auto_S5-540_AmpliSeqExome_90 Completed
S5-540 WholeTranscriptomeRNA
    Auto_S5-540_WholeTranscriptomeRNA_91 Importing Failed

Fetching a Report

Using the Results Resource API.

headers = {"Authorization": "ApiKey " + USERNAME + ":" + API_KEY}

report_response = requests.get(BASE_URL + "/rundb/api/v1/results/3/", headers=headers)
report_response.raise_for_status()
report_response_data = report_response.json()

print report_response_data["resultsName"]

for plugin_name, plugin_status in report_response_data["pluginState"].items():
    print "    " + plugin_name, plugin_status

lib_metrics_response = requests.get(BASE_URL + report_response_data["libmetrics"][0], headers=headers)
lib_metrics_response.raise_for_status()
lib_metrics_response_data = lib_metrics_response.json()

print "%.1f million reads" % (lib_metrics_response_data["totalNumReads"]/1000000.0)

Auto_S5-540_WholeTranscriptomeRNA_91
    DataExport Completed
    ERCC_Analysis Completed
    sampleID Error
    coverageAnalysis Error
    AssemblerSPAdes Started
    FilterDuplicates Completed
    RunTransfer Completed
94.0 million reads

Planning a Non-barcoded Run

Using the Planned Experiment Resource API.

headers = {"Authorization": "ApiKey " + USERNAME + ":" + API_KEY}
plan_json = {
    "library": "hg19",
    "planName": "DOCS_my_plan",
    "sample": "my_sample",
    "chipType": "520",
    "sequencekitname": "Ion S5 Sequencing Kit",
    "librarykitname": "Ion Xpress Plus Fragment Library Kit",
    "templatingKitName": "Ion 520/530 Kit-OT2"
}
response = requests.post(BASE_URL + "/rundb/api/v1/plannedexperiment/", headers=headers, json=plan_json)
response.raise_for_status()
print response.status_code

201

Planning a Barcoded Run

Using the Planned Experiment Resource API.

headers = {"Authorization": "ApiKey " + USERNAME + ":" + API_KEY}
plan_json = {
    "library": "hg19",
    "planName": "DOCS_my_plan",
    "sample": "my_sample",
    "chipType": "520",
    "sequencekitname": "Ion S5 Sequencing Kit",
    "librarykitname": "Ion Xpress Plus Fragment Library Kit",
    "templatingKitName": "Ion 520/530 Kit-OT2",
    "barcodeId": "IonXpress",
    "barcodedSamples": {
        'demo sample 1': {
            'barcodeSampleInfo': {
                'IonXpress_003': {
                    'description': 'description here',
                    'hotSpotRegionBedFile': '',
                    'nucleotideType': 'DNA',
                    'reference': 'hg19',
                    'targetRegionBedFile': ''
                }
            },
            'barcodes': ['IonXpress_003']
        },
        'demo sample 2': {
            'barcodeSampleInfo': {
                'IonXpress_004': {
                    'description': 'description here',
                    'hotSpotRegionBedFile': '',
                    'nucleotideType': 'DNA',
                    'reference': 'hg19',
                    'targetRegionBedFile': ''
                }
            },
            'barcodes': ['IonXpress_004']
        }
    }
}
response = requests.post(BASE_URL + "/rundb/api/v1/plannedexperiment/", headers=headers, json=plan_json)
response.raise_for_status()
print response.status_code

201