From 4983f5a254b6878f551bb25762f8435017cef720 Mon Sep 17 00:00:00 2001 From: Ivan Pan Date: Fri, 27 Dec 2019 13:35:47 -0800 Subject: [PATCH] Torrent Suite Software 5.12.1 SDK docs --- build_sdk_docs.sh | 6 + docker_build.sh | 9 + docker_push.sh | 11 + generate_api_docs.py | 222 +++++- .../activeioncheflibraryprepkitinfo.rst | 108 +-- .../activeionchefprepkitinfo.rst | 104 +-- .../activelibrarykitinfo.rst | 97 +-- .../activepgmlibrarykitinfo.rst | 97 +-- .../activepgmsequencingkitinfo.rst | 128 +-- .../activeprotonlibrarykitinfo.rst | 97 +-- .../activeprotonsequencingkitinfo.rst | 138 ++-- .../activesequencingkitinfo.rst | 128 +-- .../analysisargs.rst | 141 ++-- .../analysismetrics.rst | 154 ++-- .../applicationgroup.rst | 134 +--- .../references_auto_generated/applproduct.rst | 474 +++++------ .../availableionchefplannedexperiment.rst | 136 ++-- ...ailableionchefplannedexperimentsummary.rst | 130 +-- .../availableonetouchplannedexperiment.rst | 658 +++++++--------- ...ilableonetouchplannedexperimentsummary.rst | 196 ++--- .../availableplannedexperimentsummary.rst | 658 +++++++--------- source/api/references_auto_generated/chip.rst | 70 +- .../clusterinfohistory.rst | 26 +- .../references_auto_generated/common_cv.rst | 60 +- .../compositedatamanagement.rst | 82 +- .../compositeexperiment.rst | 373 +++++---- .../compositeresult.rst | 146 ++-- .../api/references_auto_generated/content.rst | 139 ++-- .../contentupload.rst | 79 +- .../datamanagementhistory.rst | 36 +- .../references_auto_generated/dnabarcode.rst | 76 +- .../emailaddress.rst | 20 +- .../references_auto_generated/eventlog.rst | 34 +- .../references_auto_generated/experiment.rst | 423 +++++----- .../experimentanalysissettings.rst | 180 ++--- .../references_auto_generated/filemonitor.rst | 60 +- .../references_auto_generated/fileserver.rst | 32 +- .../references_auto_generated/floworder.rst | 40 +- .../getchefcartridgeusage.rst | 18 +- .../getchefscriptinfo.rst | 6 +- .../globalconfig.rst | 122 +-- .../ionchefplantemplate.rst | 501 ++++++------ .../ionchefplantemplatesummary.rst | 194 ++--- .../ionchefprepkitinfo.rst | 104 +-- .../references_auto_generated/ionmeshnode.rst | 42 +- .../api/references_auto_generated/kitinfo.rst | 108 ++- .../api/references_auto_generated/kitpart.rst | 24 +- .../references_auto_generated/libmetrics.rst | 396 +++++----- .../references_auto_generated/librarykey.rst | 42 +- .../librarykitinfo.rst | 97 +-- .../librarykitpart.rst | 24 +- .../references_auto_generated/location.rst | 32 +- source/api/references_auto_generated/log.rst | 20 +- .../api/references_auto_generated/message.rst | 40 +- .../references_auto_generated/monitordata.rst | 20 +- .../monitorresult.rst | 44 +- .../api/references_auto_generated/network.rst | 6 +- .../onetouchplantemplate.rst | 744 +++++++++--------- .../plannedexperiment.rst | 711 ++++++----------- .../plannedexperimentdb.rst | 309 ++++---- .../plannedexperimentqc.rst | 42 +- .../plantemplatebasicinfo.rst | 254 +++--- .../plantemplatesummary.rst | 194 ++--- .../api/references_auto_generated/plugin.rst | 134 ++-- .../pluginresult.rst | 157 ++-- .../pluginresultjob.rst | 82 +- .../api/references_auto_generated/project.rst | 38 +- .../projectresults.rst | 96 +-- .../references_auto_generated/publisher.rst | 38 +- .../api/references_auto_generated/qctype.rst | 34 +- .../qualitymetrics.rst | 132 ++-- .../referencegenome.rst | 72 +- .../api/references_auto_generated/results.rst | 175 ++-- source/api/references_auto_generated/rig.rst | 100 +-- .../api/references_auto_generated/runtype.rst | 54 +- .../api/references_auto_generated/sample.rst | 46 +- .../sampleannotation_cv.rst | 50 +- .../sampleattribute.rst | 48 +- .../sampleattributedatatype.rst | 28 +- .../samplegrouptype_cv.rst | 55 +- .../sampleprepdata.rst | 54 +- .../references_auto_generated/sampleset.rst | 112 +-- .../samplesetitem.rst | 168 ++-- .../samplesetiteminfo.rst | 217 ++--- .../sequencingkitinfo.rst | 128 +-- .../sequencingkitpart.rst | 28 +- .../supportupload.rst | 38 +- .../references_auto_generated/template.rst | 38 +- .../references_auto_generated/tfmetrics.rst | 72 +- .../threeprimeadapter.rst | 52 +- .../torrentsuite.rst | 36 +- source/api/references_auto_generated/user.rst | 67 +- source/conf.py | 8 +- 93 files changed, 5899 insertions(+), 6254 deletions(-) create mode 100755 build_sdk_docs.sh create mode 100755 docker_build.sh create mode 100755 docker_push.sh diff --git a/build_sdk_docs.sh b/build_sdk_docs.sh new file mode 100755 index 0000000..274bc5e --- /dev/null +++ b/build_sdk_docs.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +repo_name='iontorrent' +image_name='sdk-docs-builder' + +docker run -v $(pwd):/src $repo_name/$image_name diff --git a/docker_build.sh b/docker_build.sh new file mode 100755 index 0000000..7297b84 --- /dev/null +++ b/docker_build.sh @@ -0,0 +1,9 @@ +#!/bin/bash +repo_name="iontorrent" +image_name="sdk-docs-builder" + +#build docker file +# n.b.: assume Dockerfile is in same dir +if docker build --rm -t $repo_name/$image_name .; then + echo "$image_name is successfully built." +fi diff --git a/docker_push.sh b/docker_push.sh new file mode 100755 index 0000000..a70a5c9 --- /dev/null +++ b/docker_push.sh @@ -0,0 +1,11 @@ +#!/bin/bash +set -e + +repo_name="iontorrent" +image_name="sdk-docs-builder" + +for name in $(docker images --format '{{.Repository}}:{{.Tag}}'); do + if [[ $name =~ $repo_name/$image_name:.* ]]; then + docker push $name + fi +done diff --git a/generate_api_docs.py b/generate_api_docs.py index dd425c0..ec2379c 100644 --- a/generate_api_docs.py +++ b/generate_api_docs.py @@ -1,15 +1,23 @@ #!/usr/bin/env python import requests -import urlparse import json import os +try: + from urllib import parse as urlparse +except ImportError: + import urlparse + + from settings import TS_URL, TS_USERNAME, TS_PASSWORD # modified from http://stackoverflow.com/a/12539081/56069 def make_table(grid): - max_cols = [max(out) for out in map(list, zip(*[[len(item) for item in row] for row in grid]))] + max_cols = [ + max(out) + for out in map(list, zip(*[[len(item) for item in row] for row in grid])) + ] rst = table_div(max_cols, 1) for i, row in enumerate(grid): @@ -47,21 +55,95 @@ def lower_case_to_title_case(string): This function takes text like 'bigredtruck' and turns it into 'big red truck' by magic. """ string = string.replace("_", "").lower() - dictionary = sorted([ - "active", "adapter", "analysis", "analysis", "annotation", "appl", "application", "args", "attribute", - "available", "basic", "chef", "cluster", "common", "composite", "content", "cv", "data", "db", "dna", "email", - "event", "experiment", "file", "flow", "genome", "global", "group", "history", "info", "ion", "item", "job", - "kit", "lib", "library", "location", "log", "management", "metrics", "mesh", "monitor", "node", "onetouch", "pgm", - "plan", "planned", "plugin", "prep", "prime", "product", "project", "proton", "qc", "quality", "reference", - "result", "results", "run", "sample", "sequencing", "server", "set", "settings", "suite", "summary", "support", - "support", "template", "tf", "three", "torrent", "type", "upload", "get", "script","info", - ], key=len, reverse=True) + dictionary = sorted( + [ + "active", + "adapter", + "analysis", + "analysis", + "annotation", + "appl", + "application", + "args", + "attribute", + "available", + "basic", + "chef", + "cluster", + "common", + "composite", + "content", + "cv", + "data", + "db", + "dna", + "email", + "event", + "experiment", + "file", + "flow", + "genome", + "global", + "group", + "history", + "info", + "ion", + "item", + "job", + "kit", + "lib", + "library", + "location", + "log", + "management", + "metrics", + "mesh", + "monitor", + "node", + "onetouch", + "pgm", + "plan", + "planned", + "plugin", + "prep", + "prime", + "product", + "project", + "proton", + "qc", + "quality", + "reference", + "result", + "results", + "run", + "sample", + "sequencing", + "server", + "set", + "settings", + "suite", + "summary", + "support", + "support", + "template", + "tf", + "three", + "torrent", + "type", + "upload", + "get", + "script", + "info", + ], + key=len, + reverse=True, + ) found_words = [] for _ in range(0, 10): for word in dictionary: if string.startswith(word): found_words.append(word) - string = string[len(word):] + string = string[len(word) :] break found_words.append(string) return " ".join(found_words) @@ -80,7 +162,8 @@ def lower_case_to_title_case(string): "ionreporter", # 500 "account", # 401 "prepopulatedplanningsession", # 500 - "obsoletereferencegenome" # Obsolete + "obsoletereferencegenome", # Obsolete + "getsoftwareinfo", ] API_VERSION = "v1" DEMO_API_BASE_URL = "http://mytorrentserver/rundb/api/v1/" @@ -98,67 +181,126 @@ def lower_case_to_title_case(string): resource_doc_paths = [] # Write out docs pages for each API resource -for resource_name, resource_values in main_schema_request.json().items(): +for resource_name, resource_values in list(main_schema_request.json().items()): if resource_name not in EXCLUDE_RESOURCES: # Get schema for the current resource - print "Using TS API to fetch %s schema..." % resource_name + print("Using TS API to fetch %s schema..." % resource_name) single_resource_schema_request = requests.get( urlparse.urljoin(API_BASE_URL, resource_values["schema"]), - params={"format": "json"}, auth=auth) - print single_resource_schema_request.url + params={"format": "json"}, + auth=auth, + ) + print(single_resource_schema_request.url) single_resource_schema_request.raise_for_status() # Make a request to get an example response single_resource_demo_request = requests.get( - urlparse.urljoin(API_BASE_URL, resource_values["list_endpoint"]) + DEMO_URL_ARGS, auth=auth) + urlparse.urljoin(API_BASE_URL, resource_values["list_endpoint"]) + + DEMO_URL_ARGS, + auth=auth, + ) single_resource_demo_request.raise_for_status() # We get warnings if the manual files do not exist. Try to create them now if they do not exist - manual_resource_doc_path = os.path.join(MANUAL_API_DOCS_OUTPUT_PATH, resource_name.lower() + ".rst") + manual_resource_doc_path = os.path.join( + MANUAL_API_DOCS_OUTPUT_PATH, resource_name.lower() + ".rst" + ) if not os.path.exists(manual_resource_doc_path): - print "Missing manual rst file for %s resource. Creating one now." % resource_name + print( + "Missing manual rst file for %s resource. Creating one now." + % resource_name + ) with open(manual_resource_doc_path, "w+") as output_file: output_file.write("") # Generate an rst for the resource - resource_doc_path = os.path.join(API_DOCS_OUTPUT_PATH, resource_name.lower() + ".rst") + resource_doc_path = os.path.join( + API_DOCS_OUTPUT_PATH, resource_name.lower() + ".rst" + ) with open(resource_doc_path, "w+") as output_file: - json_formatted_demo = json.dumps(single_resource_demo_request.json(), indent=4) - json_formatted_demo = "\n".join(["\t" + json_line for json_line in json_formatted_demo.split("\n")]) - - json_formatted_schema = json.dumps(single_resource_schema_request.json()["fields"], indent=4) - json_formatted_schema = "\n".join(["\t" + json_line for json_line in json_formatted_schema.split("\n")]) - - allowed_detail_http_methods = single_resource_schema_request.json()["allowed_detail_http_methods"] - allowed_list_http_methods = single_resource_schema_request.json()["allowed_list_http_methods"] + json_formatted_demo = json.dumps( + single_resource_demo_request.json(), indent=4 + ) + json_formatted_demo = "\n".join( + ["\t" + json_line for json_line in json_formatted_demo.split("\n")] + ) + + json_formatted_schema = json.dumps( + single_resource_schema_request.json()["fields"], indent=4 + ) + json_formatted_schema = "\n".join( + ["\t" + json_line for json_line in json_formatted_schema.split("\n")] + ) + + allowed_detail_http_methods = single_resource_schema_request.json()[ + "allowed_detail_http_methods" + ] + allowed_list_http_methods = single_resource_schema_request.json()[ + "allowed_list_http_methods" + ] title = lower_case_to_title_case(resource_name).title() + " Resource\n" output_file.write(".. _api_reference_%s:\n\n" % resource_name.lower()) output_file.write(title) - output_file.write("=" * (len(title)-1) + "\n\n") + output_file.write("=" * (len(title) - 1) + "\n\n") + output_file.write( + "| Resource URL ``%s``\n" + % urlparse.urljoin(DEMO_API_BASE_URL, resource_values["list_endpoint"]) + ) output_file.write( - "| Resource URL ``%s``\n" % urlparse.urljoin(DEMO_API_BASE_URL, resource_values["list_endpoint"])) - output_file.write("| Schema URL ``%s``\n" % urlparse.urljoin(DEMO_API_BASE_URL, resource_values["schema"])) + "| Schema URL ``%s``\n" + % urlparse.urljoin(DEMO_API_BASE_URL, resource_values["schema"]) + ) output_file.write("| ") # Write out manual docs portion output_file.write( - "\n\n" + ".. include:: ../references_manual_extras/" + resource_name.lower() + ".rst" + "\n\n") + "\n\n" + + ".. include:: ../references_manual_extras/" + + resource_name.lower() + + ".rst" + + "\n\n" + ) # Write out resource schema - cols = ["help_text", "default", "nullable", "readonly", "blank", "unique", "type"] - header_cols = ["help text", "default ", "nullable", - "readonly", "blank", "unique", "type"] - header_cols = ["help text", "default", "nullable", "readonly", "blank", "unique", "type"] + cols = [ + "help_text", + "default", + "nullable", + "readonly", + "blank", + "unique", + "type", + ] + header_cols = [ + "help text", + "default ", + "nullable", + "readonly", + "blank", + "unique", + "type", + ] + header_cols = [ + "help text", + "default", + "nullable", + "readonly", + "blank", + "unique", + "type", + ] output_file.write("Resource Fields\n") output_file.write("---------------" + "\n\n") toprow = ["field"] toprow.extend(header_cols) table = [toprow] - for field, values in single_resource_schema_request.json()["fields"].iteritems(): + for field, values in single_resource_schema_request.json()[ + "fields" + ].items(): row = ["**" + field + "**"] for col in cols: if col == "default" and values[col] == "No default provided.": @@ -212,4 +354,6 @@ def lower_case_to_title_case(string): "ordering": [] """ - resource_doc_paths.append(os.path.relpath(resource_doc_path, "source").replace("\\", "/")) + resource_doc_paths.append( + os.path.relpath(resource_doc_path, "source").replace("\\", "/") + ) diff --git a/source/api/references_auto_generated/activeioncheflibraryprepkitinfo.rst b/source/api/references_auto_generated/activeioncheflibraryprepkitinfo.rst index 0b2c6dd..29c518d 100644 --- a/source/api/references_auto_generated/activeioncheflibraryprepkitinfo.rst +++ b/source/api/references_auto_generated/activeioncheflibraryprepkitinfo.rst @@ -15,45 +15,45 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** 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 +**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 @@ -63,47 +63,47 @@ Example Response { "meta": { - "previous": null, - "total_count": 2, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/activeioncheflibraryprepkitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/activeioncheflibraryprepkitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "IC", - "kitType": "LibraryPrepKit", - "description": "Precision ID Chef DL8", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "", - "chipTypes": "", - "runMode": "", + "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, - "resource_uri": "/rundb/api/v1/kitpart/20245/", - "kit": "/rundb/api/v1/kitinfo/20105/" - }, + "barcode": "A32926C", + "id": 20245, + "kit": "/rundb/api/v1/kitinfo/20105/", + "resource_uri": "/rundb/api/v1/kitpart/20245/" + }, { - "barcode": "A33212", - "id": 20261, - "resource_uri": "/rundb/api/v1/kitpart/20261/", - "kit": "/rundb/api/v1/kitinfo/20105/" + "barcode": "A33212", + "id": 20261, + "kit": "/rundb/api/v1/kitinfo/20105/", + "resource_uri": "/rundb/api/v1/kitpart/20261/" } - ], - "flowCount": 0, - "applicationType": "AMPS", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/activeioncheflibraryprepkitinfo/20105/", - "uid": "LPREP0003", - "id": 20105, - "categories": "filter_s5HidKit", - "name": "Ion Chef HID Library V2" + ], + "resource_uri": "/rundb/api/v1/activeioncheflibraryprepkitinfo/20105/", + "runMode": "", + "samplePrep_instrumentType": "IC", + "uid": "LPREP0003" } ] } diff --git a/source/api/references_auto_generated/activeionchefprepkitinfo.rst b/source/api/references_auto_generated/activeionchefprepkitinfo.rst index 3cc6437..91403c4 100644 --- a/source/api/references_auto_generated/activeionchefprepkitinfo.rst +++ b/source/api/references_auto_generated/activeionchefprepkitinfo.rst @@ -15,45 +15,45 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** 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 +**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 @@ -63,41 +63,47 @@ Example Response { "meta": { - "previous": null, - "total_count": 9, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/activeionchefprepkitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/activeionchefprepkitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 9 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "IC", - "kitType": "IonChefPrepKit", - "description": "Precision ID Chef Reagents", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "S5", - "chipTypes": "510;520;530", - "runMode": "", + "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": "A32882C", - "id": 20246, - "resource_uri": "/rundb/api/v1/kitpart/20246/", - "kit": "/rundb/api/v1/kitinfo/20106/" + "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/" } - ], - "flowCount": 0, - "applicationType": "AMPS", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/activeionchefprepkitinfo/20106/", - "uid": "ICPREP0011", - "id": 20106, - "categories": "filter_s5HidKit;samplePrepProtocol;s5hidSamplePrep", - "name": "Ion Chef HID S530 V2" + ], + "resource_uri": "/rundb/api/v1/activeionchefprepkitinfo/20113/", + "runMode": "", + "samplePrep_instrumentType": "IC", + "uid": "ICPREP0014" } ] } diff --git a/source/api/references_auto_generated/activelibrarykitinfo.rst b/source/api/references_auto_generated/activelibrarykitinfo.rst index 6fefc05..0dd1e9f 100644 --- a/source/api/references_auto_generated/activelibrarykitinfo.rst +++ b/source/api/references_auto_generated/activelibrarykitinfo.rst @@ -15,45 +15,45 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** 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 +**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 @@ -63,34 +63,41 @@ Example Response { "meta": { - "previous": null, - "total_count": 21, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/activelibrarykitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/activelibrarykitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 24 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "", - "kitType": "LibraryKit", - "description": "MuSeek Library Preparation Kit", - "nucleotideType": "dna", - "defaultCartridgeUsageCount": null, - "instrumentType": "", - "chipTypes": "", - "runMode": "", - "parts": [], - "flowCount": 0, - "applicationType": "GENS", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/activelibrarykitinfo/20025/", - "uid": "LIB0012", - "id": 20025, - "categories": "filter_muSeek", - "name": "MuSeek(tm) Library Preparation Kit" + "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" } ] } diff --git a/source/api/references_auto_generated/activepgmlibrarykitinfo.rst b/source/api/references_auto_generated/activepgmlibrarykitinfo.rst index cd19511..46d5584 100644 --- a/source/api/references_auto_generated/activepgmlibrarykitinfo.rst +++ b/source/api/references_auto_generated/activepgmlibrarykitinfo.rst @@ -15,45 +15,45 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** 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 +**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 @@ -63,34 +63,41 @@ Example Response { "meta": { - "previous": null, - "total_count": 18, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/activepgmlibrarykitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/activepgmlibrarykitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 21 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "", - "kitType": "LibraryKit", - "description": "MuSeek Library Preparation Kit", - "nucleotideType": "dna", - "defaultCartridgeUsageCount": null, - "instrumentType": "", - "chipTypes": "", - "runMode": "", - "parts": [], - "flowCount": 0, - "applicationType": "GENS", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/activepgmlibrarykitinfo/20025/", - "uid": "LIB0012", - "id": 20025, - "categories": "filter_muSeek", - "name": "MuSeek(tm) Library Preparation Kit" + "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" } ] } diff --git a/source/api/references_auto_generated/activepgmsequencingkitinfo.rst b/source/api/references_auto_generated/activepgmsequencingkitinfo.rst index 98f6d25..2d8601a 100644 --- a/source/api/references_auto_generated/activepgmsequencingkitinfo.rst +++ b/source/api/references_auto_generated/activepgmsequencingkitinfo.rst @@ -15,47 +15,47 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** 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 +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**name** Unicode string data. Ex: "Hello World" n/a false false false true string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**defaultFlowOrder** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** 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 @@ -65,54 +65,60 @@ Example Response { "meta": { - "previous": null, - "total_count": 4, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/activepgmsequencingkitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/activepgmsequencingkitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 4 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "OT_IC", - "kitType": "SequencingKit", - "defaultFlowOrder": null, - "name": "IonPGMInstallKit", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "pgm", - "chipTypes": "", - "runMode": "", + "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": "4480217", - "id": 20019, - "resource_uri": "/rundb/api/v1/kitpart/20019/", - "kit": "/rundb/api/v1/kitinfo/20020/" - }, + "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": "4480282", - "id": 20020, - "resource_uri": "/rundb/api/v1/kitpart/20020/", - "kit": "/rundb/api/v1/kitinfo/20020/" - }, + "barcode": "A30275", + "id": 20205, + "kit": "/rundb/api/v1/kitinfo/20090/", + "resource_uri": "/rundb/api/v1/kitpart/20205/" + }, { - "barcode": "4480284", - "id": 20021, - "resource_uri": "/rundb/api/v1/kitpart/20021/", - "kit": "/rundb/api/v1/kitinfo/20020/" + "barcode": "A25590", + "id": 20206, + "kit": "/rundb/api/v1/kitinfo/20090/", + "resource_uri": "/rundb/api/v1/kitpart/20206/" } - ], - "flowCount": 100, - "applicationType": "", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/activepgmsequencingkitinfo/20020/", - "uid": "SEQ0006", - "id": 20020, - "categories": "readLengthDerivableFromFlows;", - "description": "Ion PGM Install Kit" + ], + "resource_uri": "/rundb/api/v1/activepgmsequencingkitinfo/20090/", + "runMode": "", + "samplePrep_instrumentType": "OT_IC_IA", + "uid": "SEQ0024" } ] } diff --git a/source/api/references_auto_generated/activeprotonlibrarykitinfo.rst b/source/api/references_auto_generated/activeprotonlibrarykitinfo.rst index 4dd5a32..e7e741e 100644 --- a/source/api/references_auto_generated/activeprotonlibrarykitinfo.rst +++ b/source/api/references_auto_generated/activeprotonlibrarykitinfo.rst @@ -15,45 +15,45 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** 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 +**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 @@ -63,34 +63,41 @@ Example Response { "meta": { - "previous": null, - "total_count": 19, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/activeprotonlibrarykitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/activeprotonlibrarykitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 22 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "", - "kitType": "LibraryKit", - "description": "MuSeek Library Preparation Kit", - "nucleotideType": "dna", - "defaultCartridgeUsageCount": null, - "instrumentType": "", - "chipTypes": "", - "runMode": "", - "parts": [], - "flowCount": 0, - "applicationType": "GENS", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/activeprotonlibrarykitinfo/20025/", - "uid": "LIB0012", - "id": 20025, - "categories": "filter_muSeek", - "name": "MuSeek(tm) Library Preparation Kit" + "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" } ] } diff --git a/source/api/references_auto_generated/activeprotonsequencingkitinfo.rst b/source/api/references_auto_generated/activeprotonsequencingkitinfo.rst index 54e4337..e57f06c 100644 --- a/source/api/references_auto_generated/activeprotonsequencingkitinfo.rst +++ b/source/api/references_auto_generated/activeprotonsequencingkitinfo.rst @@ -15,47 +15,47 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** 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 +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**name** Unicode string data. Ex: "Hello World" n/a false false false true string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**defaultFlowOrder** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** 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 @@ -65,66 +65,60 @@ Example Response { "meta": { - "previous": null, - "total_count": 5, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/activeprotonsequencingkitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/activeprotonsequencingkitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 5 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "", - "kitType": "SequencingKit", - "defaultFlowOrder": null, - "name": "ProtonI200Kit-v2", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "proton", - "chipTypes": "900;P1.0.19;P1.0.20;P1.1.17;P1.1.541;P1.2.18;P2.0.1;P2.1.1;P2.3.1", - "runMode": "", + "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": "4485149", - "id": 20094, - "resource_uri": "/rundb/api/v1/kitpart/20094/", - "kit": "/rundb/api/v1/kitinfo/20044/" - }, - { - "barcode": "4485521", - "id": 20095, - "resource_uri": "/rundb/api/v1/kitpart/20095/", - "kit": "/rundb/api/v1/kitinfo/20044/" - }, + "barcode": "A26433", + "id": 20154, + "kit": "/rundb/api/v1/kitinfo/20071/", + "resource_uri": "/rundb/api/v1/kitpart/20154/" + }, { - "barcode": "4484082", - "id": 20096, - "resource_uri": "/rundb/api/v1/kitpart/20096/", - "kit": "/rundb/api/v1/kitinfo/20044/" - }, + "barcode": "A26430", + "id": 20155, + "kit": "/rundb/api/v1/kitinfo/20071/", + "resource_uri": "/rundb/api/v1/kitpart/20155/" + }, { - "barcode": "4482282", - "id": 20078, - "resource_uri": "/rundb/api/v1/kitpart/20078/", - "kit": "/rundb/api/v1/kitinfo/20044/" - }, + "barcode": "A26431", + "id": 20156, + "kit": "/rundb/api/v1/kitinfo/20071/", + "resource_uri": "/rundb/api/v1/kitpart/20156/" + }, { - "barcode": "4482284", - "id": 20079, - "resource_uri": "/rundb/api/v1/kitpart/20079/", - "kit": "/rundb/api/v1/kitinfo/20044/" + "barcode": "A26432", + "id": 20157, + "kit": "/rundb/api/v1/kitinfo/20071/", + "resource_uri": "/rundb/api/v1/kitpart/20157/" } - ], - "flowCount": 500, - "applicationType": "", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/activeprotonsequencingkitinfo/20044/", - "uid": "SEQ0012", - "id": 20044, - "categories": "readLengthDerivableFromFlows;", - "description": "Ion PI Sequencing 200 Kit v2" + ], + "resource_uri": "/rundb/api/v1/activeprotonsequencingkitinfo/20071/", + "runMode": "", + "samplePrep_instrumentType": "OT_IC_IA", + "uid": "SEQ0020" } ] } diff --git a/source/api/references_auto_generated/activesequencingkitinfo.rst b/source/api/references_auto_generated/activesequencingkitinfo.rst index 6f63f21..0cf7a56 100644 --- a/source/api/references_auto_generated/activesequencingkitinfo.rst +++ b/source/api/references_auto_generated/activesequencingkitinfo.rst @@ -15,47 +15,47 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** 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 +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**name** Unicode string data. Ex: "Hello World" n/a false false false true string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**defaultFlowOrder** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** 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 @@ -65,54 +65,60 @@ Example Response { "meta": { - "previous": null, - "total_count": 13, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/activesequencingkitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/activesequencingkitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 13 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "OT_IC", - "kitType": "SequencingKit", - "defaultFlowOrder": null, - "name": "IonPGMInstallKit", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "pgm", - "chipTypes": "", - "runMode": "", + "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": "4480217", - "id": 20019, - "resource_uri": "/rundb/api/v1/kitpart/20019/", - "kit": "/rundb/api/v1/kitinfo/20020/" - }, + "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": "4480282", - "id": 20020, - "resource_uri": "/rundb/api/v1/kitpart/20020/", - "kit": "/rundb/api/v1/kitinfo/20020/" - }, + "barcode": "A33208", + "id": 20260, + "kit": "/rundb/api/v1/kitinfo/20111/", + "resource_uri": "/rundb/api/v1/kitpart/20260/" + }, { - "barcode": "4480284", - "id": 20021, - "resource_uri": "/rundb/api/v1/kitpart/20021/", - "kit": "/rundb/api/v1/kitinfo/20020/" + "barcode": "100049484", + "id": 20263, + "kit": "/rundb/api/v1/kitinfo/20111/", + "resource_uri": "/rundb/api/v1/kitpart/20263/" } - ], - "flowCount": 100, - "applicationType": "", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/activesequencingkitinfo/20020/", - "uid": "SEQ0006", - "id": 20020, - "categories": "readLengthDerivableFromFlows;", - "description": "Ion PGM Install Kit" + ], + "resource_uri": "/rundb/api/v1/activesequencingkitinfo/20111/", + "runMode": "", + "samplePrep_instrumentType": "", + "uid": "SEQ0028" } ] } diff --git a/source/api/references_auto_generated/analysisargs.rst b/source/api/references_auto_generated/analysisargs.rst index 39be521..0127119 100644 --- a/source/api/references_auto_generated/analysisargs.rst +++ b/source/api/references_auto_generated/analysisargs.rst @@ -15,69 +15,71 @@ Resource Fields ============================== ============================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ============================== ============================================================================== ======= ======== ======== ===== ====== ======== -**ionstatsargs** Unicode string data. Ex: "Hello World" false false true false string +**active** Boolean data. Ex: True true false false true false boolean ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" false false false false string +**alignmentargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**creator** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**analysisargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**thumbnailionstatsargs** 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 ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**thumbnailalignmentargs** Unicode string data. Ex: "Hello World" false false true 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 ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**thumbnailanalysisargs** Unicode string data. Ex: "Hello World" false false true false string +**applType** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" false false true false string +**basecallerargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**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 ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sequenceKitName** Unicode string data. Ex: "Hello World" false false true false string +**creator** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**analysisargs** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" n/a true false false true string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**thumbnailcalibrateargs** Unicode string data. Ex: "Hello World" false false true false string +**id** Integer data. Ex: 2673 false false true true integer ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**applGroup** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**ionstatsargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**chip_default** Boolean data. Ex: True false false false true false boolean +**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 ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**beadfindargs** Unicode string data. Ex: "Hello World" false false true false string +**lastModifiedUser** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**templateKitName** Unicode string data. Ex: "Hello World" false false true false string +**libraryKitName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**prebasecallerargs** 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 ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**description** Unicode string data. Ex: "Hello World" n/a true 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 ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**applType** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**alignmentargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**thumbnailbasecallerargs** 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 ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**active** Boolean data. Ex: True true false false true false boolean +**samplePrepKitName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**sequenceKitName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**thumbnailbeadfindargs** Unicode string data. Ex: "Hello World" false false true false string +**templateKitName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**calibrateargs** Unicode string data. Ex: "Hello World" false false true false string +**thumbnailalignmentargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**libraryKitName** Unicode string data. Ex: "Hello World" false false true false string +**thumbnailanalysisargs** 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 +**thumbnailbasecallerargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**basecallerargs** Unicode string data. Ex: "Hello World" false false true false string +**thumbnailbeadfindargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**lastModifiedUser** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**thumbnailcalibrateargs** 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 +**thumbnailionstatsargs** Unicode string data. Ex: "Hello World" false false true false string ============================== ============================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -87,46 +89,47 @@ Example Response { "meta": { - "previous": null, - "total_count": 129, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/analysisargs/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/analysisargs/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 106 + }, "objects": [ { - "ionstatsargs": "ionstats alignment", - "chipType": "314", - "creator": null, - "thumbnailionstatsargs": "", - "thumbnailalignmentargs": "", - "thumbnailanalysisargs": "", - "samplePrepKitName": "", - "id": 1, - "creationDate": "2018-06-08T06:20:39.000036+00:00", - "sequenceKitName": "", - "analysisargs": "Analysis --args-json /opt/ion/config/args_314_analysis.json", - "thumbnailcalibrateargs": "", - "applGroup": null, - "chip_default": true, - "lastModifiedDate": "2018-06-08T06:20:39.000036+00:00", - "beadfindargs": "justBeadFind --args-json /opt/ion/config/args_314_beadfind.json", - "templateKitName": "", - "prebasecallerargs": "BaseCaller --barcode-filter-minreads 20", - "description": "Ion 314 chip v2 analysis arguments", - "prethumbnailbasecallerargs": "", - "applType": null, - "alignmentargs": "tmap mapall ... stage1 map4", - "thumbnailbasecallerargs": "", - "active": true, - "isSystem": true, - "thumbnailbeadfindargs": "", - "calibrateargs": "Calibration", - "libraryKitName": "", - "name": "ion_default_314", - "basecallerargs": "BaseCaller --barcode-filter-minreads 20", - "lastModifiedUser": null, - "resource_uri": "/rundb/api/v1/analysisargs/1/" + "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": "" } ] } diff --git a/source/api/references_auto_generated/analysismetrics.rst b/source/api/references_auto_generated/analysismetrics.rst index b7666ee..34a9b4e 100644 --- a/source/api/references_auto_generated/analysismetrics.rst +++ b/source/api/references_auto_generated/analysismetrics.rst @@ -15,77 +15,77 @@ Resource Fields ========================= ============================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ========================= ============================================================================== ======= ======== ======== ===== ====== ======= -**libLive** Integer data. Ex: 2673 n/a false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**ignored** Integer data. Ex: 2673 n/a false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**washout_ambiguous** Integer data. Ex: 2673 n/a false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**tfLive** Integer data. Ex: 2673 n/a false false false false integer +**adjusted_addressable** Integer data. Ex: 2673 0 false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**sysIE** Floating point numeric data. Ex: 26.73 n/a false false false false float +**amb** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- **bead** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**tfKp** Integer data. Ex: 2673 n/a false false false false integer +**dud** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**washout_live** 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 ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**libFinal** Integer data. Ex: 2673 n/a false false false false integer +**ignored** 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 +**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 ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**keypass_all_beads** Integer data. Ex: 2673 n/a false false false false integer +**libFinal** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**dud** Integer data. Ex: 2673 n/a false false false false integer +**libKp** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**sysCF** Floating point numeric data. Ex: 26.73 n/a false false false false float +**libLive** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**pinned** Integer data. Ex: 2673 n/a false false false false integer +**libMix** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**live** 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 ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**excluded** 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 ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**tf** Integer data. Ex: 2673 n/a false false false false integer +**live** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**empty** 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 ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**tfFinal** Integer data. Ex: 2673 n/a false false false false integer +**pinned** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**amb** 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 ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**lib_pass_basecaller** 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 ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**lib_pass_cafie** Integer data. Ex: 2673 n/a false false false false integer +**sysCF** Floating point numeric data. Ex: 26.73 n/a false false false false float ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**washout_dud** Integer data. Ex: 2673 n/a false false false false integer +**sysDR** Floating point numeric data. Ex: 26.73 n/a false false false false float ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**libMix** Integer data. Ex: 2673 n/a false false false false integer +**sysIE** 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 +**tf** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**libKp** Integer data. Ex: 2673 n/a false false false false integer +**tfFinal** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**adjusted_addressable** Integer data. Ex: 2673 0 false false false false integer +**tfKp** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**sysDR** Floating point numeric data. Ex: 26.73 n/a false false false false float +**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_test_fragment** Integer data. Ex: 2673 n/a false false false false integer +**washout** 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_ambiguous** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**washout** Integer data. Ex: 2673 n/a false false false false integer +**washout_dud** Integer data. Ex: 2673 n/a false false false false integer ------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**tfMix** Integer data. Ex: 2673 n/a false false false false integer +**washout_library** 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 +**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 @@ -95,50 +95,50 @@ Example Response { "meta": { - "previous": null, - "total_count": 6, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/analysismetrics/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/analysismetrics/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 6 + }, "objects": [ { - "libLive": 0, - "ignored": 1042801, - "washout_ambiguous": 0, - "tfLive": 0, - "sysIE": 0.465626595541835, - "bead": 140400602, - "tfKp": 0, - "washout_live": 0, - "id": 1, - "libFinal": 93974105, - "loading": 94.7655552064634, - "lib": 139085639, - "keypass_all_beads": 0, - "dud": 60690, - "sysCF": 0.603865925222635, - "pinned": 2329, - "live": 140339912, - "excluded": 16543404, - "tf": 1254273, - "empty": 6710000, - "tfFinal": 1198552, - "amb": 0, - "lib_pass_basecaller": 0, - "lib_pass_cafie": 0, - "washout_dud": 0, - "libMix": 0, - "report": "/rundb/api/v1/results/3/", - "libKp": 0, - "adjusted_addressable": 148155732, - "sysDR": 0.168037705589086, - "total": 164699136, - "washout_test_fragment": 0, - "washout_library": 0, - "washout": 0, - "tfMix": 0, - "resource_uri": "/rundb/api/v1/analysismetrics/1/" + "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 } ] } diff --git a/source/api/references_auto_generated/applicationgroup.rst b/source/api/references_auto_generated/applicationgroup.rst index 953565d..24aae00 100644 --- a/source/api/references_auto_generated/applicationgroup.rst +++ b/source/api/references_auto_generated/applicationgroup.rst @@ -15,19 +15,19 @@ Resource Fields ================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**name** 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 ----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- **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 ---------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**uid** 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 ---------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- +**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 @@ -37,112 +37,36 @@ Example Response { "meta": { - "previous": null, - "total_count": 12, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/applicationgroup/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/applicationgroup/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 12 + }, "objects": [ { - "name": "DNA", - "description": "DNA", "applications": [ { + "alternate_name": "AmpliSeq HD - Fusions", "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/", - "/rundb/api/v1/applicationgroup/3/", - "/rundb/api/v1/applicationgroup/4/" - ], - "description": "Generic Sequencing", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "Other", - "runType": "GENS", - "id": 1, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/1/" - }, - { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/", - "/rundb/api/v1/applicationgroup/6/", - "/rundb/api/v1/applicationgroup/8/", - "/rundb/api/v1/applicationgroup/10/" - ], - "description": "AmpliSeq DNA", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "AmpliSeq DNA", - "runType": "AMPS", - "id": 2, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/2/" - }, - { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/" - ], - "description": "TargetSeq", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "TargetSeq", - "runType": "TARS", - "id": 3, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/3/" - }, - { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/", - "/rundb/api/v1/applicationgroup/4/" - ], - "description": "Whole Genome", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "Whole Genome", - "runType": "WGNM", - "id": 4, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/4/" - }, - { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/" - ], - "description": "AmpliSeq Exome", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "AmpliSeq Exome", - "runType": "AMPS_EXOME", - "id": 7, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/7/" - }, - { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/" - ], - "description": "AmpliSeq HD - DNA", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "AmpliSeq HD - DNA", - "runType": "AMPS_HD_DNA", - "id": 12, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/12/" + "/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" } - ], - "uid": "APPLGROUP_0001", - "id": 1, - "isActive": true, - "resource_uri": "/rundb/api/v1/applicationgroup/1/" + ], + "description": "Fusions", + "id": 12, + "isActive": true, + "name": "Fusions", + "resource_uri": "/rundb/api/v1/applicationgroup/12/", + "uid": "APPLGROUP_0012" } ] } diff --git a/source/api/references_auto_generated/applproduct.rst b/source/api/references_auto_generated/applproduct.rst index 520016c..05bdf99 100644 --- a/source/api/references_auto_generated/applproduct.rst +++ b/source/api/references_auto_generated/applproduct.rst @@ -15,89 +15,89 @@ Resource Fields ========================================================= ============================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ========================================================= ============================================================================== ======= ======== ======== ===== ====== ======= -**isDualNucleotideTypeBySampleSupported** Boolean data. Ex: True false false false true false boolean ---------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultHotSpotRegionBedFileName** Unicode string data. Ex: "Hello World" n/a true false false false string ---------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isTargetRegionBEDFileSupported** Boolean data. Ex: True true false false true false boolean +**appl** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isSamplePrepKitSupported** Boolean data. Ex: True true false false true false boolean +**applicationGroup** 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 +**barcodeKitSelectableType** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isControlSeqTypeBySampleSupported** Boolean data. Ex: True false false false true false boolean +**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 --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isHotSpotBEDFileBySampleSupported** Boolean data. Ex: True false false false true false boolean ---------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true integer +**defaultChipType** Unicode string data. Ex: "Hello World" n/a true false false false string --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isTargetRegionBEDFileBySampleSupported** Boolean data. Ex: True false false false true false boolean +**defaultControlSeqKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isReferenceSelectionSupported** Boolean data. Ex: True true false false true false boolean +**defaultFlowCount** Integer data. Ex: 2673 0 false false false false integer --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**productCode** Unicode string data. Ex: "Hello World" any false false false true string +**defaultGenomeRefName** 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 false false related +**defaultHotSpotRegionBedFileName** Unicode string data. Ex: "Hello World" n/a true false false false string --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**dualBarcodingRule** Unicode string data. Ex: "Hello World" false false true 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 --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultChipType** Unicode string data. Ex: "Hello World" n/a true false false false string +**defaultIonChefSequencingKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**appl** A single related resource. Can be either a URI or set of nested resource data. n/a false 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 --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**defaultSamplePrepKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**defaultSeqKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isDefault** Boolean data. Ex: True false false false true false boolean +**defaultTargetRegionBedFileName** Unicode string data. Ex: "Hello World" n/a true false false false string --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isTargetTechniqueSelectionSupported** Boolean data. Ex: True true false false true false boolean +**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 --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isHotspotRegionBEDFileSuppported** Boolean data. Ex: True true false false true false boolean +**dualBarcodingRule** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isVisible** Boolean data. Ex: True false false false true false boolean +**id** Integer data. Ex: 2673 false false true true integer --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**productName** Unicode string data. Ex: "Hello World" n/a false false false false string +**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 --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isTargetRegionBEDFileSelectionRequiredForRefSelection** 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 --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultTargetRegionBedFileName** Unicode string data. Ex: "Hello World" n/a true false false false string +**isDualNucleotideTypeBySampleSupported** Boolean data. Ex: True false false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isActive** Boolean data. Ex: True true false false true false boolean +**isHotSpotBEDFileBySampleSupported** Boolean data. Ex: True false false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isReferenceBySampleSupported** Boolean data. Ex: True false false false true false boolean +**isHotspotRegionBEDFileSuppported** Boolean data. Ex: True true false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultFlowCount** Integer data. Ex: 2673 0 false false false false integer +**isReferenceBySampleSupported** Boolean data. Ex: True false false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultLibKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**isReferenceSelectionSupported** Boolean data. Ex: True true false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**barcodeKitSelectableType** Unicode string data. Ex: "Hello World" false false true false string +**isSamplePrepKitSupported** Boolean data. Ex: True true false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isDefaultForInstrumentType** Boolean data. Ex: True false false false true false boolean +**isTargetRegionBEDFileBySampleSupported** Boolean data. Ex: True false false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultGenomeRefName** Unicode string data. Ex: "Hello World" n/a true false false false string +**isTargetRegionBEDFileSelectionRequiredForRefSelection** Boolean data. Ex: True false false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultSamplePrepKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**isTargetRegionBEDFileSupported** Boolean data. Ex: True true false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultControlSeqKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**isTargetTechniqueSelectionSupported** Boolean data. Ex: True true false false true false boolean --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultIonChefPrepKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**isVisible** 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 +**productCode** Unicode string data. Ex: "Hello World" any false false false true string --------------------------------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**defaultIonChefSequencingKit** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**productName** Unicode string data. Ex: "Hello World" n/a false 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 +**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string ========================================================= ============================================================================== ======= ======== ======== ===== ====== ======= Example Response @@ -107,247 +107,185 @@ Example Response { "meta": { - "previous": null, - "total_count": 59, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/applproduct/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/applproduct/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 59 + }, "objects": [ { - "isDualNucleotideTypeBySampleSupported": false, - "defaultHotSpotRegionBedFileName": "", - "isTargetRegionBEDFileSupported": true, - "isSamplePrepKitSupported": true, - "defaultSeqKit": { - "isActive": true, - "samplePrep_instrumentType": "OT_IC_IA", - "kitType": "SequencingKit", - "defaultFlowOrder": null, - "name": "IonPGMHiQView", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "pgm", - "chipTypes": "", - "runMode": "", - "parts": [ - { - "barcode": "A30044", - "id": 20203, - "resource_uri": "/rundb/api/v1/kitpart/20203/", - "kit": "/rundb/api/v1/kitinfo/20090/" - }, - { - "barcode": "A30043", - "id": 20204, - "resource_uri": "/rundb/api/v1/kitpart/20204/", - "kit": "/rundb/api/v1/kitinfo/20090/" - }, - { - "barcode": "A30275", - "id": 20205, - "resource_uri": "/rundb/api/v1/kitpart/20205/", - "kit": "/rundb/api/v1/kitinfo/20090/" - }, - { - "barcode": "A25590", - "id": 20206, - "resource_uri": "/rundb/api/v1/kitpart/20206/", - "kit": "/rundb/api/v1/kitinfo/20090/" - } - ], - "flowCount": 500, - "applicationType": "", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/kitinfo/20090/", - "uid": "SEQ0024", - "id": 20090, - "categories": "flowOverridable;readLengthDerivableFromFlows;", - "description": "Ion PGM Hi-Q View Sequencing Kit" - }, - "isControlSeqTypeBySampleSupported": false, - "defaultBarcodeKitName": null, - "isHotSpotBEDFileBySampleSupported": true, - "id": 20001, - "isTargetRegionBEDFileBySampleSupported": true, - "isReferenceSelectionSupported": true, - "productCode": "AMPS_0", + "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": { - "name": "DNA", - "description": "DNA", "applications": [ { + "alternate_name": "AmpliSeq HD - DNA and Fusions (Single Library)", "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/", - "/rundb/api/v1/applicationgroup/3/", - "/rundb/api/v1/applicationgroup/4/" - ], - "description": "Generic Sequencing", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "Other", - "runType": "GENS", - "id": 1, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/1/" - }, + "/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": [ { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/", - "/rundb/api/v1/applicationgroup/6/", - "/rundb/api/v1/applicationgroup/8/", - "/rundb/api/v1/applicationgroup/10/" - ], - "description": "AmpliSeq DNA", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "AmpliSeq DNA", - "runType": "AMPS", - "id": 2, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/2/" - }, + "barcode": "100031412", + "id": 20173, + "kit": "/rundb/api/v1/kitinfo/20088/", + "resource_uri": "/rundb/api/v1/kitpart/20173/" + }, { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/" - ], - "description": "TargetSeq", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "TargetSeq", - "runType": "TARS", - "id": 3, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/3/" - }, + "barcode": "100031090", + "id": 20174, + "kit": "/rundb/api/v1/kitinfo/20088/", + "resource_uri": "/rundb/api/v1/kitpart/20174/" + }, { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/", - "/rundb/api/v1/applicationgroup/4/" - ], - "description": "Whole Genome", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "Whole Genome", - "runType": "WGNM", - "id": 4, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/4/" - }, + "barcode": "100031096", + "id": 20175, + "kit": "/rundb/api/v1/kitinfo/20088/", + "resource_uri": "/rundb/api/v1/kitpart/20175/" + }, { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/" - ], - "description": "AmpliSeq Exome", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "AmpliSeq Exome", - "runType": "AMPS_EXOME", - "id": 7, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/7/" - }, + "barcode": "A27767", + "id": 20195, + "kit": "/rundb/api/v1/kitinfo/20088/", + "resource_uri": "/rundb/api/v1/kitpart/20195/" + }, { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/" - ], - "description": "AmpliSeq HD - DNA", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "AmpliSeq HD - DNA", - "runType": "AMPS_HD_DNA", - "id": 12, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/12/" - } - ], - "uid": "APPLGROUP_0001", - "id": 1, - "isActive": true, - "resource_uri": "/rundb/api/v1/applicationgroup/1/" - }, - "dualBarcodingRule": "", - "defaultChipType": "318", - "appl": { - "applicationGroups": [ - "/rundb/api/v1/applicationgroup/1/", - "/rundb/api/v1/applicationgroup/6/", - "/rundb/api/v1/applicationgroup/8/", - "/rundb/api/v1/applicationgroup/10/" - ], - "description": "AmpliSeq DNA", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "AmpliSeq DNA", - "runType": "AMPS", - "id": 2, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/2/" - }, - "categories": "", - "instrumentType": "pgm", - "isDefault": true, - "isTargetTechniqueSelectionSupported": true, - "description": "", - "isHotspotRegionBEDFileSuppported": true, - "isVisible": true, - "productName": "AMPS_default", - "isBarcodeKitSelectionRequired": false, - "isDefaultBarcoded": false, - "isTargetRegionBEDFileSelectionRequiredForRefSelection": true, - "isDualBarcodingBySampleSupported": false, - "defaultTargetRegionBedFileName": "", - "isActive": true, - "isReferenceBySampleSupported": true, - "defaultFlowCount": 500, - "defaultLibKit": { - "isActive": true, - "samplePrep_instrumentType": "", - "kitType": "LibraryKit", - "defaultFlowOrder": null, - "name": "Ion AmpliSeq 2.0 Library Kit", - "nucleotideType": "dna", - "defaultCartridgeUsageCount": null, - "instrumentType": "", - "chipTypes": "", - "runMode": "", - "parts": [ + "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": "4475345", - "id": 20034, - "resource_uri": "/rundb/api/v1/kitpart/20034/", - "kit": "/rundb/api/v1/kitinfo/20012/" + "barcode": "INS1012841B", + "id": 20239, + "kit": "/rundb/api/v1/kitinfo/20088/", + "resource_uri": "/rundb/api/v1/kitpart/20239/" } - ], - "flowCount": 0, - "applicationType": "AMPS_ANY", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/kitinfo/20012/", - "uid": "LIB0008", - "id": 20012, - "categories": "", - "description": "Ion AmpliSeq 2.0 Library Kit" - }, - "barcodeKitSelectableType": "all", - "isDefaultForInstrumentType": true, - "defaultGenomeRefName": "hg19", - "defaultSamplePrepKit": null, - "defaultControlSeqKit": null, - "defaultIonChefPrepKit": "/rundb/api/v1/kitinfo/20093/", - "resource_uri": "/rundb/api/v1/applproduct/20001/", - "defaultIonChefSequencingKit": "/rundb/api/v1/kitinfo/20090/", - "defaultTemplateKit": "/rundb/api/v1/kitinfo/20091/" + ], + "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/" } ] } diff --git a/source/api/references_auto_generated/availableionchefplannedexperiment.rst b/source/api/references_auto_generated/availableionchefplannedexperiment.rst index 5423fe7..b56826b 100644 --- a/source/api/references_auto_generated/availableionchefplannedexperiment.rst +++ b/source/api/references_auto_generated/availableionchefplannedexperiment.rst @@ -15,101 +15,101 @@ Resource Fields =============================== ============================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =============================== ============================================================================== ======= ======== ======== ===== ====== ======== -**origin** Unicode string data. Ex: "Hello World" true false false false string +**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**autoName** 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 +**categories** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**storage_options** Unicode string data. Ex: "Hello World" A false false false false string +**chipType** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" n/a true true true false string +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planShortID** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**expName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**runMode** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean +**id** Integer data. Ex: 2673 false false true true integer ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**isFavorite** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**seqKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isSystemDefault** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**autoName** Unicode string data. Ex: "Hello World" n/a true false false false string +**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**planName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**planShortID** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**categories** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planName** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**adapter** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**irworkflow** Unicode string data. Ex: "Hello World" false false true false string +**runname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**username** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**usePostBeadfind** Boolean data. Ex: True true false false true false boolean +**sampleTubeLabel** 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 +**seqKitBarcode** 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 +**storageHost** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**runname** Unicode string data. Ex: "Hello World" n/a true false false false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**usePreBeadfind** Boolean data. Ex: True true false false true false boolean +**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string +**usePostBeadfind** Boolean data. Ex: True true false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**usePreBeadfind** 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 +**username** Unicode string data. Ex: "Hello World" n/a true false false false string =============================== ============================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -119,28 +119,28 @@ Example Response { "meta": { - "previous": null, - "total_count": 2, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/availableionchefplannedexperiment/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/availableionchefplannedexperiment/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA", - "isReverseRun": false, - "chipType": "540", - "planShortID": "SP1XE", - "username": "ionadmin", - "samplePrepProtocol": "", - "isPlanGroup": false, - "planStatus": "pending", - "samplePrepProtocolName": "", - "experiment": "/rundb/api/v1/experiment/136/", - "sampleTubeLabel": "", - "date": "2018-04-13T22:17:13.000108+00:00", - "id": 143, - "templatingKitName": "Ion Chef S540 V1" + "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" } ] } diff --git a/source/api/references_auto_generated/availableionchefplannedexperimentsummary.rst b/source/api/references_auto_generated/availableionchefplannedexperimentsummary.rst index 1364062..6e9cd6c 100644 --- a/source/api/references_auto_generated/availableionchefplannedexperimentsummary.rst +++ b/source/api/references_auto_generated/availableionchefplannedexperimentsummary.rst @@ -15,99 +15,99 @@ Resource Fields =============================== ============================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =============================== ============================================================================== ======= ======== ======== ===== ====== ======== -**origin** Unicode string data. Ex: "Hello World" true false false false string +**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**autoName** 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 +**categories** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**storage_options** Unicode string data. Ex: "Hello World" A false false false false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planShortID** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**expName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**runMode** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean +**id** Integer data. Ex: 2673 false false true true integer ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**isFavorite** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**seqKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isSystemDefault** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**autoName** Unicode string data. Ex: "Hello World" n/a true false false false string +**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**planName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**planShortID** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**categories** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planName** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**adapter** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**irworkflow** Unicode string data. Ex: "Hello World" false false true false string +**runname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**username** 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 ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**usePostBeadfind** Boolean data. Ex: True true false false true false boolean +**sampleTubeLabel** 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 +**seqKitBarcode** 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 +**storageHost** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**runname** Unicode string data. Ex: "Hello World" n/a true false false false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**usePreBeadfind** Boolean data. Ex: True true false false true false boolean +**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string +**usePostBeadfind** Boolean data. Ex: True true false false true false boolean ------------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**usePreBeadfind** 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 +**username** Unicode string data. Ex: "Hello World" n/a true false false false string =============================== ============================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -117,26 +117,26 @@ Example Response { "meta": { - "previous": null, - "total_count": 2, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/availableionchefplannedexperimentsummary/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/availableionchefplannedexperimentsummary/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA", - "isReverseRun": false, - "planShortID": "SP1XE", - "samplePrepProtocol": "", - "isPlanGroup": false, - "planStatus": "pending", - "username": "ionadmin", - "experiment": "/rundb/api/v1/experiment/136/", - "sampleTubeLabel": "", - "date": "2018-04-13T22:17:13.000108+00:00", - "id": 143, - "templatingKitName": "Ion Chef S540 V1" + "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" } ] } diff --git a/source/api/references_auto_generated/availableonetouchplannedexperiment.rst b/source/api/references_auto_generated/availableonetouchplannedexperiment.rst index 8f36554..9e03de8 100644 --- a/source/api/references_auto_generated/availableonetouchplannedexperiment.rst +++ b/source/api/references_auto_generated/availableonetouchplannedexperiment.rst @@ -15,193 +15,193 @@ Resource Fields ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**planDisplayedName** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean +**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodeId** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**platform** Unicode string data. Ex: "Hello World" n/a 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string +**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string +**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**chipBarcode** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" true false true false string +**chipType** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**base_recalibration_mode** Unicode string data. Ex: "Hello World" true false true false string +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storageHost** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string +**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**expName** 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 +**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" false false false false string +**flows** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**library** Unicode string data. Ex: "Hello World" true false true false string +**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string +**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**id** Integer data. Ex: 2673 false false true true integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodeId** Unicode string data. Ex: "Hello World" true false true false string +**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**realign** Boolean data. Ex: True n/a false false false false boolean +**isFavorite** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**bedfile** Unicode string data. Ex: "Hello World" false false true false string +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean +**libkit** Unicode string data. Ex: "Hello World" n/a 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 +**library** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**librarykitname** Unicode string data. Ex: "Hello World" true false true false string +**libraryKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string +**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string +**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string +**librarykitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**origin** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string +**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean +**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**notes** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**planDisplayedName** 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 +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**tfKey** Unicode string data. Ex: "Hello World" false false true false string +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string +**platform** Unicode string data. Ex: "Hello World" n/a true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string +**project** Unicode string data. Ex: "Hello World" n/a false true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** Unicode string data. Ex: "Hello World" false false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**irworkflow** Unicode string data. Ex: "Hello World" false false true false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**realign** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**project** Unicode string data. Ex: "Hello World" n/a false true true false string +**regionfile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict +**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**runType** Unicode string data. Ex: "Hello World" GENS false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** Unicode string data. Ex: "Hello World" n/a true 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**regionfile** Unicode string data. Ex: "Hello World" false false true false string +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string +**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoName** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryKey** Unicode string data. Ex: "Hello World" false false true false string +**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flows** Integer data. Ex: 2673 0 false false false false integer +**seqKitBarcode** 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 +**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string +**storageHost** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string +**templatingKitName** 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 +**tfKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipBarcode** Unicode string data. Ex: "Hello World" false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string -------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string +**username** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string +**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -211,321 +211,201 @@ Example Response { "meta": { - "previous": null, - "total_count": 1, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": "/rundb/api/v1/availableonetouchplannedexperiment/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "planDisplayedName": "Ion ReproSeq Aneuploidy - Ion PGM System", - "autoAnalyze": true, - "endBarcodeKitName": "", - "templatingKitBarcode": null, - "preAnalysis": true, - "thumbnailanalysisargs": "", - "applicationGroup": "/rundb/api/v1/applicationgroup/1/", - "mixedTypeRNA_hotSpotRegionBedFile": "", - "mixedTypeRNA_targetRegionBedFile": "", - "platform": "", - "categories": "repro", - "planPGM": null, - "prebasecallerargs": "BaseCaller --barcode-filter 0.01 --barcode-filter-minreads 20 --extra-trim-left 30", - "alignmentargs": "tmap mapall ... stage1 map4", - "thumbnailbasecallerargs": "", - "libkit": null, - "projects": [], - "notes": "", - "sequencekitname": "IonPGMHiQ", - "base_recalibration_mode": "standard_recal", - "storageHost": null, - "expName": "", - "thumbnailionstatsargs": "", - "cycles": null, - "isReverseRun": false, - "storage_options": "A", - "thumbnailalignmentargs": "", - "chipType": "318", - "library": "hg19", - "runMode": "single", - "sampleTubeLabel": "", - "seqKitBarcode": null, - "barcodeId": "Ion SingleSeq Barcode set 1-24", - "isPlanGroup": false, - "realign": false, - "sampleGroupingName": "Self", - "experiment": "/rundb/api/v1/experiment/123/", - "bedfile": "", - "applicationCategoryDisplayedName": "Reproductive", - "isReusable": false, - "isDuplicateReads": false, - "sampleSets": [], - "thumbnailbeadfindargs": "", - "librarykitname": "IonPicoPlex", - "sseBedFile": "", - "adapter": null, - "basecallerargs": "BaseCaller --barcode-filter 0.01 --barcode-filter-minreads 20 --extra-trim-left 30", - "earlyDatFileDeletion": false, - "parentPlan": null, - "origin": "gui|5.8.0", - "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGAAAGCGG", - "planStatus": "planned", - "isCustom_kitSettings": false, - "samplePrepKitName": null, - "applicationGroupDisplayedName": "DNA", + "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_ReproSeq_Aneuploidy_-_Ion_PGM_System", + "fromTemplate": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression_Panel_OT2-Proton", "fromTemplateSource": "ION" - }, - "isFavorite": false, + }, + "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": [ { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/131/", - "id": 370, + "id": 409, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Bead Loading (%)", - "id": 1, + "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/370/" - }, + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/409/", + "threshold": 30 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/131/", - "id": 371, + "id": 410, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/", "qcType": { - "description": "", - "minThreshold": 1, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Key Signal (1-100)", - "id": 2, + "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/371/" - }, + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/410/", + "threshold": 30 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/131/", - "id": 372, + "id": 411, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Usable Sequence (%)", - "id": 3, + "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/372/" - } - ], - "analysisargs": "Analysis --args-json /opt/ion/config/args_318_analysis.json --mixed-first-flow 51 --mixed-last-flow 111", - "thumbnailcalibrateargs": "", - "templatingKitName": "Ion PGM Template IA Tech Access Kit", - "runType": "WGNM", - "username": "ionadmin", - "planShortID": "6TGIO", - "sampleDisplayedName": "", - "prethumbnailbasecallerargs": "", - "controlSequencekitname": null, - "tfKey": "ATCG", - "mixedTypeRNA_reference": "", - "childPlans": [], - "pairedEndLibraryAdapterName": "", - "reverselibrarykey": "", - "irworkflow": "", - "planExecuted": false, - "project": "", - "usePostBeadfind": true, - "libraryReadLength": 0, - "runname": null, - "chefInfo": {}, - "planGUID": "d1ed9718-b6f4-4dfd-8de5-bbd150092997", - "ionstatsargs": "ionstats alignment", - "samplePrepProtocol": "", - "sample": "", - "planExecutedDate": null, - "reverse_primer": null, - "id": 131, - "barcodedSamples": { - "Sample 6": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_006": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_006" - ] - }, - "Sample 7": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_007": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_007" - ] - }, - "Sample 4": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_004": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_004" - ] - }, - "Sample 5": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_005": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_005" - ] - }, - "Sample 2": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_002": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_002" - ] - }, - "Sample 3": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_003": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_003" - ] - }, - "Sample 1": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_001": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_001" - ] + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/411/", + "threshold": 30 } - }, - "custom_args": false, - "regionfile": "", + ], + "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": { - "FilterDuplicates": { - "userInput": "", - "version": "5.8.0.0", - "features": [], - "name": "FilterDuplicates", - "id": 34 + "ampliSeqRNA": { + "features": [], + "id": 48, + "name": "ampliSeqRNA", + "userInput": {}, + "version": "5.10.0.1" } - }, - "beadfindargs": "justBeadFind --args-json /opt/ion/config/args_318_beadfind.json", - "isSystemDefault": false, - "autoName": null, - "libraryKey": "TCAG", - "flows": 250, - "date": "2018-02-26T17:28:33.000588+00:00", - "isSystem": false, - "variantfrequency": "", - "planName": "Ion_ReproSeq_Aneuploidy_-_Ion_PGM_System", - "calibrateargs": "Calibration", - "flowsInOrder": "", - "libraryPrepType": "", - "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/2/", - "chipBarcode": "", - "sampleSetDisplayedName": "", - "usePreBeadfind": true, - "resource_uri": "/rundb/api/v1/availableonetouchplannedexperiment/131/", - "libraryPrepTypeDisplayedName": "", - "reverse3primeadapter": "" + }, + "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": "" } ] } diff --git a/source/api/references_auto_generated/availableonetouchplannedexperimentsummary.rst b/source/api/references_auto_generated/availableonetouchplannedexperimentsummary.rst index de92499..8c38495 100644 --- a/source/api/references_auto_generated/availableonetouchplannedexperimentsummary.rst +++ b/source/api/references_auto_generated/availableonetouchplannedexperimentsummary.rst @@ -15,97 +15,97 @@ Resource Fields =============================== ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =============================== ==================================================== ======= ======== ======== ===== ====== ======== -**origin** Unicode string data. Ex: "Hello World" true false false false string +**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**autoName** 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 +**categories** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storage_options** Unicode string data. Ex: "Hello World" A false false false false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**expName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**isFavorite** 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 +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitName** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planDisplayedName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**planGUID** 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 +**planName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**reverse_primer** 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 +**runMode** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string +**runname** 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 +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** Boolean data. Ex: True true false false true false boolean +**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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string -------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** Unicode string data. Ex: "Hello World" n/a true false false false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePreBeadfind** Boolean data. Ex: True true false false true false boolean +**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string +**usePostBeadfind** Boolean data. Ex: True true false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**usePreBeadfind** 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 +**username** Unicode string data. Ex: "Hello World" n/a true false false false string =============================== ==================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -115,63 +115,63 @@ Example Response { "meta": { - "previous": null, - "total_count": 1, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": "/rundb/api/v1/availableonetouchplannedexperimentsummary/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "origin": "gui|5.8.0", - "isReverseRun": false, - "planDisplayedName": "Ion ReproSeq Aneuploidy - Ion PGM System", - "storage_options": "A", - "preAnalysis": true, - "planShortID": "6TGIO", - "planStatus": "planned", - "runMode": "single", - "isCustom_kitSettings": false, - "sampleTubeLabel": "", - "planExecutedDate": null, - "samplePrepKitName": null, - "reverse_primer": null, - "seqKitBarcode": null, - "id": 131, + "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_ReproSeq_Aneuploidy_-_Ion_PGM_System", + "fromTemplate": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression_Panel_OT2-Proton", "fromTemplateSource": "ION" - }, - "isFavorite": false, - "samplePrepProtocol": "", - "isPlanGroup": false, - "templatingKitName": "Ion PGM Template IA Tech Access Kit", - "runType": "WGNM", - "templatingKitBarcode": null, - "planPGM": null, - "isSystemDefault": false, - "autoName": null, - "isReusable": false, - "controlSequencekitname": null, - "date": "2018-02-26T17:28:33.000588+00:00", - "isSystem": false, - "libkit": null, - "categories": "repro", - "planName": "Ion_ReproSeq_Aneuploidy_-_Ion_PGM_System", - "pairedEndLibraryAdapterName": "", - "adapter": null, - "irworkflow": "", - "planExecuted": false, - "username": "ionadmin", - "usePostBeadfind": true, - "storageHost": null, - "expName": "", - "libraryReadLength": 0, - "runname": null, - "usePreBeadfind": true, - "planGUID": "d1ed9718-b6f4-4dfd-8de5-bbd150092997", - "cycles": null, - "resource_uri": "/rundb/api/v1/availableonetouchplannedexperimentsummary/131/" + }, + "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" } ] } diff --git a/source/api/references_auto_generated/availableplannedexperimentsummary.rst b/source/api/references_auto_generated/availableplannedexperimentsummary.rst index fdcd2a6..9c96918 100644 --- a/source/api/references_auto_generated/availableplannedexperimentsummary.rst +++ b/source/api/references_auto_generated/availableplannedexperimentsummary.rst @@ -15,193 +15,193 @@ Resource Fields ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**planDisplayedName** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean +**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodeId** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**platform** Unicode string data. Ex: "Hello World" n/a 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string +**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string +**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**chipBarcode** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" true false true false string +**chipType** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**base_recalibration_mode** Unicode string data. Ex: "Hello World" true false true false string +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storageHost** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string +**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**expName** 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 +**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" false false false false string +**flows** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**library** Unicode string data. Ex: "Hello World" true false true false string +**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string +**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**id** Integer data. Ex: 2673 false false true true integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodeId** Unicode string data. Ex: "Hello World" true false true false string +**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**realign** Boolean data. Ex: True n/a false false false false boolean +**isFavorite** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**bedfile** Unicode string data. Ex: "Hello World" false false true false string +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean +**libkit** Unicode string data. Ex: "Hello World" n/a 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 +**library** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**librarykitname** Unicode string data. Ex: "Hello World" true false true false string +**libraryKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string +**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string +**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string +**librarykitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**origin** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string +**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean +**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**notes** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**planDisplayedName** 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 +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**tfKey** Unicode string data. Ex: "Hello World" false false true false string +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string +**platform** Unicode string data. Ex: "Hello World" n/a true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string +**project** Unicode string data. Ex: "Hello World" n/a false true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** Unicode string data. Ex: "Hello World" false false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**irworkflow** Unicode string data. Ex: "Hello World" false false true false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**realign** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**project** Unicode string data. Ex: "Hello World" n/a false true true false string +**regionfile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict +**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**runType** Unicode string data. Ex: "Hello World" GENS false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** Unicode string data. Ex: "Hello World" n/a true 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**regionfile** Unicode string data. Ex: "Hello World" false false true false string +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string +**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoName** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryKey** Unicode string data. Ex: "Hello World" false false true false string +**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flows** Integer data. Ex: 2673 0 false false false false integer +**seqKitBarcode** 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 +**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string +**storageHost** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string +**templatingKitName** 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 +**tfKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipBarcode** Unicode string data. Ex: "Hello World" false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string -------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string +**username** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string +**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -211,321 +211,201 @@ Example Response { "meta": { - "previous": null, - "total_count": 1, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": "/rundb/api/v1/availableplannedexperimentsummary/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "planDisplayedName": "Ion ReproSeq Aneuploidy - Ion PGM System", - "autoAnalyze": true, - "endBarcodeKitName": "", - "templatingKitBarcode": null, - "preAnalysis": true, - "thumbnailanalysisargs": "", - "applicationGroup": "/rundb/api/v1/applicationgroup/1/", - "mixedTypeRNA_hotSpotRegionBedFile": "", - "mixedTypeRNA_targetRegionBedFile": "", - "platform": "", - "categories": "repro", - "planPGM": null, - "prebasecallerargs": "BaseCaller --barcode-filter 0.01 --barcode-filter-minreads 20 --extra-trim-left 30", - "alignmentargs": "tmap mapall ... stage1 map4", - "thumbnailbasecallerargs": "", - "libkit": null, - "projects": [], - "notes": "", - "sequencekitname": "IonPGMHiQ", - "base_recalibration_mode": "standard_recal", - "storageHost": null, - "expName": "", - "thumbnailionstatsargs": "", - "cycles": null, - "isReverseRun": false, - "storage_options": "A", - "thumbnailalignmentargs": "", - "chipType": "318", - "library": "hg19", - "runMode": "single", - "sampleTubeLabel": "", - "seqKitBarcode": null, - "barcodeId": "Ion SingleSeq Barcode set 1-24", - "isPlanGroup": false, - "realign": false, - "sampleGroupingName": "Self", - "experiment": "/rundb/api/v1/experiment/123/", - "bedfile": "", - "applicationCategoryDisplayedName": "Reproductive", - "isReusable": false, - "isDuplicateReads": false, - "sampleSets": [], - "thumbnailbeadfindargs": "", - "librarykitname": "IonPicoPlex", - "sseBedFile": "", - "adapter": null, - "basecallerargs": "BaseCaller --barcode-filter 0.01 --barcode-filter-minreads 20 --extra-trim-left 30", - "earlyDatFileDeletion": false, - "parentPlan": null, - "origin": "gui|5.8.0", - "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGAAAGCGG", - "planStatus": "planned", - "isCustom_kitSettings": false, - "samplePrepKitName": null, - "applicationGroupDisplayedName": "DNA", + "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_ReproSeq_Aneuploidy_-_Ion_PGM_System", + "fromTemplate": "Ion_AmpliSeq_Transcriptome_Mouse_Gene_Expression_Panel_OT2-Proton", "fromTemplateSource": "ION" - }, - "isFavorite": false, + }, + "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": [ { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/131/", - "id": 370, + "id": 409, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Bead Loading (%)", - "id": 1, + "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/370/" - }, + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/409/", + "threshold": 30 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/131/", - "id": 371, + "id": 410, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/", "qcType": { - "description": "", - "minThreshold": 1, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Key Signal (1-100)", - "id": 2, + "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/371/" - }, + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/410/", + "threshold": 30 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/131/", - "id": 372, + "id": 411, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/144/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Usable Sequence (%)", - "id": 3, + "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/372/" - } - ], - "analysisargs": "Analysis --args-json /opt/ion/config/args_318_analysis.json --mixed-first-flow 51 --mixed-last-flow 111", - "thumbnailcalibrateargs": "", - "templatingKitName": "Ion PGM Template IA Tech Access Kit", - "runType": "WGNM", - "username": "ionadmin", - "planShortID": "6TGIO", - "sampleDisplayedName": "", - "prethumbnailbasecallerargs": "", - "controlSequencekitname": null, - "tfKey": "ATCG", - "mixedTypeRNA_reference": "", - "childPlans": [], - "pairedEndLibraryAdapterName": "", - "reverselibrarykey": "", - "irworkflow": "", - "planExecuted": false, - "project": "", - "usePostBeadfind": true, - "libraryReadLength": 0, - "runname": null, - "chefInfo": {}, - "planGUID": "d1ed9718-b6f4-4dfd-8de5-bbd150092997", - "ionstatsargs": "ionstats alignment", - "samplePrepProtocol": "", - "sample": "", - "planExecutedDate": null, - "reverse_primer": null, - "id": 131, - "barcodedSamples": { - "Sample 6": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_006": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_006" - ] - }, - "Sample 7": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_007": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_007" - ] - }, - "Sample 4": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_004": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_004" - ] - }, - "Sample 5": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_005": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_005" - ] - }, - "Sample 2": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_002": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_002" - ] - }, - "Sample 3": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_003": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_003" - ] - }, - "Sample 1": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "SingleSeq_001": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "SingleSeq_001" - ] + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/411/", + "threshold": 30 } - }, - "custom_args": false, - "regionfile": "", + ], + "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": { - "FilterDuplicates": { - "userInput": "", - "version": "5.8.0.0", - "features": [], - "name": "FilterDuplicates", - "id": 34 + "ampliSeqRNA": { + "features": [], + "id": 48, + "name": "ampliSeqRNA", + "userInput": {}, + "version": "5.10.0.1" } - }, - "beadfindargs": "justBeadFind --args-json /opt/ion/config/args_318_beadfind.json", - "isSystemDefault": false, - "autoName": null, - "libraryKey": "TCAG", - "flows": 250, - "date": "2018-02-26T17:28:33.000588+00:00", - "isSystem": false, - "variantfrequency": "", - "planName": "Ion_ReproSeq_Aneuploidy_-_Ion_PGM_System", - "calibrateargs": "Calibration", - "flowsInOrder": "", - "libraryPrepType": "", - "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/2/", - "chipBarcode": "", - "sampleSetDisplayedName": "", - "usePreBeadfind": true, - "resource_uri": "/rundb/api/v1/availableplannedexperimentsummary/131/", - "libraryPrepTypeDisplayedName": "", - "reverse3primeadapter": "" + }, + "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": "" } ] } diff --git a/source/api/references_auto_generated/chip.rst b/source/api/references_auto_generated/chip.rst index 10449cb..ca87a70 100644 --- a/source/api/references_auto_generated/chip.rst +++ b/source/api/references_auto_generated/chip.rst @@ -15,21 +15,21 @@ Resource Fields ======================== ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ======================== ====================================== ======= ======== ======== ===== ====== ======= -**name** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true integer +**description** Unicode string data. Ex: "Hello World" false false false false string ------------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- **earlyDatFileDeletion** Unicode string data. Ex: "Hello World" false false true false string ------------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**slots** 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 +**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 ------------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" 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 +------------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- +**slots** Integer data. Ex: 2673 n/a false false false false integer ======================== ====================================== ======= ======== ======== ===== ====== ======= Example Response @@ -39,36 +39,36 @@ Example Response { "meta": { - "previous": null, - "total_count": 28, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/chip/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/chip/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 15 + }, "objects": [ { - "ionstatsargs": "ionstats alignment", - "thumbnailionstatsargs": "", - "thumbnailalignmentargs": "", - "thumbnailanalysisargs": "", - "slots": 1, - "id": 1, - "analysisargs": "Analysis --args-json /opt/ion/config/args_314_analysis.json", - "thumbnailcalibrateargs": "", - "beadfindargs": "justBeadFind --args-json /opt/ion/config/args_314_beadfind.json", - "instrumentType": "pgm", - "prebasecallerargs": "BaseCaller --barcode-filter-minreads 20", - "description": "314v2", - "prethumbnailbasecallerargs": "", - "alignmentargs": "tmap mapall ... stage1 map4", - "thumbnailbasecallerargs": "", - "isActive": true, - "thumbnailbeadfindargs": "", - "calibrateargs": "Calibration", - "name": "314", - "basecallerargs": "BaseCaller --barcode-filter-minreads 20", - "earlyDatFileDeletion": "", - "resource_uri": "/rundb/api/v1/chip/1/" + "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" } ] } diff --git a/source/api/references_auto_generated/clusterinfohistory.rst b/source/api/references_auto_generated/clusterinfohistory.rst index 59e50a6..ca29f46 100644 --- a/source/api/references_auto_generated/clusterinfohistory.rst +++ b/source/api/references_auto_generated/clusterinfohistory.rst @@ -15,19 +15,19 @@ Resource Fields ================ ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================ ==================================================== ======= ======== ======== ===== ====== ======== -**username** Unicode string data. Ex: "Hello World" ION false false true false string ----------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**name** Unicode string data. Ex: "Hello World" n/a true true false false string ----------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **created** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**text** Unicode string data. Ex: "Hello World" false false false false string +**id** Integer data. Ex: 2673 false false true true integer ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**object_pk** Integer data. Ex: 2673 n/a false false false false integer +**name** Unicode string data. Ex: "Hello World" n/a true true false false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 @@ -37,12 +37,12 @@ Example Response { "meta": { - "previous": null, - "total_count": 0, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 0 + }, "objects": [] } diff --git a/source/api/references_auto_generated/common_cv.rst b/source/api/references_auto_generated/common_cv.rst index 152d8ee..eedb1d1 100644 --- a/source/api/references_auto_generated/common_cv.rst +++ b/source/api/references_auto_generated/common_cv.rst @@ -15,31 +15,31 @@ Resource Fields ============================= ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================= ====================================== ======= ======== ======== ===== ====== ======= -**displayedValue** Unicode string data. Ex: "Hello World" n/a false false false true string +**categories** Unicode string data. Ex: "Hello World" true false false false string ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**sequencing_instrumentType** Unicode string data. Ex: "Hello World" false false true 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 ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**displayedValue** 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 +**id** Integer data. Ex: 2673 false false true true integer ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**isActive** Boolean data. Ex: True true false false true false boolean ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**cv_type** Unicode string data. Ex: "Hello World" n/a false false false false string +**isDefault** Boolean data. Ex: True true false false true false boolean ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **isVisible** Boolean data. Ex: True true false false true false boolean ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**uid** 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 ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true integer +**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**isActive** Boolean data. Ex: True true false false true false boolean +**sequencing_instrumentType** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**isDefault** Boolean data. Ex: True true false false true false boolean +**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 @@ -49,27 +49,27 @@ Example Response { "meta": { - "previous": null, - "total_count": 13, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/common_cv/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/common_cv/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 16 + }, "objects": [ { - "displayedValue": "Ion PGM Hi-Q Chef for STR", - "sequencing_instrumentType": "pgm", - "description": "Use Ion Chef script protocol optimized for HID STR on PGM", - "categories": "hidSamplePrep", - "value": "anneal62no10xab", - "samplePrep_instrumentType": "IC", - "cv_type": "samplePrepProtocol", - "isVisible": true, - "uid": "CV0001", - "resource_uri": "/rundb/api/v1/common_cv/1/", - "id": 1, - "isActive": true, - "isDefault": false + "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" } ] } diff --git a/source/api/references_auto_generated/compositedatamanagement.rst b/source/api/references_auto_generated/compositedatamanagement.rst index 42f7113..94baa25 100644 --- a/source/api/references_auto_generated/compositedatamanagement.rst +++ b/source/api/references_auto_generated/compositedatamanagement.rst @@ -15,37 +15,37 @@ 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 ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**in_process** Boolean data. Ex: True false false false false false boolean +**diskusage** Integer data. Ex: 2673 n/a true false false false integer ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**misc_state** Unicode string data. Ex: "Hello World" Unknown false true false false string +**expDir** Unicode string data. Ex: "Hello World" n/a false true false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**timeStamp** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime +**expName** Unicode string data. Ex: "Hello World" n/a false true false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**basecall_keep** Unicode string data. Ex: "Hello World" n/a true true false false string +**id** Integer data. Ex: 2673 false false true true integer ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**misc_keep** Unicode string data. Ex: "Hello World" n/a true true false false string +**in_process** Boolean data. Ex: True false false false false false boolean ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**output_keep** Unicode string data. Ex: "Hello World" n/a true true false false string +**misc_keep** Unicode string data. Ex: "Hello World" n/a true true false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" n/a false true false false string +**misc_state** Unicode string data. Ex: "Hello World" Unknown false true false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultsName** Unicode string data. Ex: "Hello World" n/a false false 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 ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sigproc_state** Unicode string data. Ex: "Hello World" Unknown false true false false string ------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sigproc_keep** Unicode string data. Ex: "Hello World" n/a true true false false string +**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**diskusage** Integer data. Ex: 2673 n/a true false false false integer +**resultsName** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expDir** Unicode string data. Ex: "Hello World" n/a false true false false string +**sigproc_keep** Unicode string data. Ex: "Hello World" n/a true true false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**sigproc_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 +**timeStamp** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ================== ==================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -55,34 +55,34 @@ Example Response { "meta": { - "previous": null, - "total_count": 6, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/compositedatamanagement/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/compositedatamanagement/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 6 + }, "objects": [ { - "misc_diskspace": 0, - "expName": "S5-540_WholeTranscriptomeRNA", - "basecall_state": "Local", - "in_process": false, - "misc_state": "Deleted", - "timeStamp": "2017-07-22T13:15:56.000197+00:00", - "basecall_keep": false, - "misc_keep": null, - "output_keep": false, - "basecall_diskspace": 175694.536458969, - "resultsName": "Auto_S5-540_WholeTranscriptomeRNA_91", - "output_state": "Error", - "sigproc_state": "Local", - "sigproc_keep": false, - "sigproc_diskspace": 0.0160617828369141, - "diskusage": 229301, - "resource_uri": "/rundb/api/v1/compositedatamanagement/3/", - "expDir": "/results/S5_DemoData/S5-540_WholeTranscriptomeRNA", - "id": 3, - "output_diskspace": 53607.1456193924 + "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" } ] } diff --git a/source/api/references_auto_generated/compositeexperiment.rst b/source/api/references_auto_generated/compositeexperiment.rst index f42ece0..9f32147 100644 --- a/source/api/references_auto_generated/compositeexperiment.rst +++ b/source/api/references_auto_generated/compositeexperiment.rst @@ -15,51 +15,51 @@ Resource Fields ========================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ========================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**storage_options** Unicode string data. Ex: "Hello World" A false false false false string --------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" n/a false false false false string +**_host** Host this resource is located on. 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 false false false false related +**chefReagentsSerialNum** Unicode string data. Ex: "Hello World" false false true false string -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** 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 -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**_host** Host this resource is located on. n/a false true false false string +**chipType** Unicode string data. Ex: "Hello World" n/a false false false false string -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false false false false datetime -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefSolutionsSerialNum** Unicode string data. Ex: "Hello World" false false true false string +**displayName** Unicode string data. Ex: "Hello World" false false false false string -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**platform** Unicode string data. Ex: "Hello World" false false true false string +**expName** Unicode string data. Ex: "Hello World" n/a false false false false string -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**status** Unicode string data. Ex: "Hello World" false false true false string +**flows** Integer data. Ex: 2673 n/a false false false false integer -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**star** Boolean data. Ex: True false false false true false boolean +**ftpStatus** Unicode string data. Ex: "Hello World" false false true false string -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true true false false false datetime +**id** Integer data. Ex: 2673 false false true true integer -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flows** Integer data. Ex: 2673 n/a false false false false 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 -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false false false false datetime +**platform** Unicode string data. Ex: "Hello World" false false true false string -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**ftpStatus** 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 -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**displayName** 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 -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" n/a true false false false string +**resultDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true true false false false datetime -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pgmName** Unicode string data. Ex: "Hello World" n/a false false false false string +**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 -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**repResult** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**runMode** Unicode string data. Ex: "Hello World" false false true false string -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" n/a false false false false string +**star** Boolean data. Ex: True false false false true false boolean -------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefReagentsSerialNum** Unicode string data. Ex: "Hello World" false false true false string +**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 +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ========================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -69,139 +69,234 @@ Example Response { "meta": { - "previous": null, - "total_count": 8, - "offset": 0, - "limit": 1, - "next": "/rundb/api/mesh/v1/compositeexperiment/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/mesh/v1/compositeexperiment/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 146 + }, "objects": [ { - "chipDescription": "540", - "chipType": "540", + "_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": [ { - "status": "Completed", - "processedflows": 0, - "libmetrics": { - "i100Q20_reads": 0, - "aveKeyCounts": 88, - "id": 1, - "resource_uri": "", - "q20_mean_alignment_length": 0 - }, - "representative": false, "analysis_metrics": { - "ignored": 1042801, - "lib": 139085639, - "total_wells": 164699136, - "pinned": 2329, - "live": 140339912, - "excluded": 16543404, - "bead": 140400602, - "resource_uri": "", - "id": 1, - "empty": 6710000, - "libFinal": 93974105 - }, - "timeStamp": "2017-07-22T13:15:56.000197+00:00", + "bead": 144205030, + "empty": 5365643, + "excluded": 13159848, + "id": 1785, + "ignored": 1554120, + "lib": 143117241, + "libFinal": 72109222, + "live": 144191568, + "pinned": 414495, + "resource_uri": "", + "total_wells": 164699136 + }, "analysismetrics": { - "ignored": 1042801, - "lib": 139085639, - "total_wells": 164699136, - "pinned": 2329, - "live": 140339912, - "excluded": 16543404, - "bead": 140400602, - "resource_uri": "", - "id": 1, - "empty": 6710000, - "libFinal": 93974105 - }, - "reportLink": "/output/Home/Auto_S5-540_WholeTranscriptomeRNA_91_003/", - "reportStatus": "Nothing", - "quality_metrics": { - "q0_mean_read_length": 149.579903660696, - "q0_reads": 93969124, - "q0_bases": "14055892515", - "q20_reads": 93969124, - "q20_bases": "11916010889", - "q20_mean_read_length": 149, - "id": 1, + "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": "" - }, - "resultsName": "Auto_S5-540_WholeTranscriptomeRNA_91", + }, + "processedflows": 0, "projects": [ { - "resource_uri": "", - "id": 1, - "name": "demo", - "modified": "2018-02-28T17:32:01.000703+00:00" + "id": 179, + "modified": "2019-10-04T22:30:21.000322+00:00", + "name": "Valkyrie", + "resource_uri": "" } - ], - "status_display": "Completed", + ], + "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": { - "q0_mean_read_length": 149.579903660696, - "q0_reads": 93969124, - "q0_bases": "14055892515", - "q20_reads": 93969124, - "q20_bases": "11916010889", - "q20_mean_read_length": 149, - "id": 1, + "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": { - "chipType": "540", - "reference": "", - "isPQ": false, - "references": "", - "barcodeKitName": "IonXpressRNA", + "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": "" - }, - "resource_uri": "/rundb/api/v1/compositeresult/3/", - "id": 3, - "autoExempt": false, - "isShowAllMetrics": true + }, + "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" } - ], - "library": "", - "sample": "", - "runMode": "single", - "storage_options": "A", - "references": "", - "chefStartTime": null, - "repResult": "/rundb/api/v1/compositeresult/3/", - "id": 91, - "barcodedSamples": {}, - "chefSolutionsSerialNum": "", - "barcodeId": "IonXpressRNA", - "sampleSetName": "", - "platform": "S5", - "status": "run", - "applicationCategoryDisplayedName": "RNA Sequencing", - "star": false, - "sampleDisplayedName": "", - "resultDate": "2017-07-22T13:15:56.000197+00:00", - "flows": 500, - "plan": { - "runType": "RNA", - "sampleTubeLabel": null, - "id": 99, - "resource_uri": "" - }, - "date": "2017-02-21T12:59:23+00:00", - "ftpStatus": "0", - "displayName": "S5-540 WholeTranscriptomeRNA", - "notes": "", - "chipInstrumentType": "S5", - "pgmName": "S16", - "keep": false, - "expName": "S5-540_WholeTranscriptomeRNA", - "chefReagentsSerialNum": "", - "resource_uri": "/rundb/api/mesh/v1/compositeexperiment/91/" + ], + "runMode": "single", + "sample": "", + "sampleDisplayedName": "", + "sampleSetName": "", + "star": false, + "status": "run", + "storage_options": "A" } - ], - "warnings": [] + ], + "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 diff --git a/source/api/references_auto_generated/compositeresult.rst b/source/api/references_auto_generated/compositeresult.rst index 56bf6b4..628aba4 100644 --- a/source/api/references_auto_generated/compositeresult.rst +++ b/source/api/references_auto_generated/compositeresult.rst @@ -15,35 +15,37 @@ Resource Fields =================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**status** Unicode string data. Ex: "Hello World" n/a false false false false string +**analysismetrics** 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 +**autoExempt** Boolean data. Ex: True false false false true false boolean ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**timeStamp** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime +**eas** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**analysismetrics** 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 +**i18nstatus** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **id** Integer data. Ex: 2673 false false true true integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reportStatus** Unicode string data. Ex: "Hello World" Nothing true false false false string +**libmetrics** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultsName** Unicode string data. Ex: "Hello World" n/a false false 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**eas** A single related resource. Can be either a URI or set of nested resource data. n/a false 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libmetrics** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**resultsName** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoExempt** Boolean data. Ex: True false false false true false boolean +**status** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**representative** Boolean data. Ex: True false false false true false boolean +**timeStamp** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime =================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -53,94 +55,50 @@ Example Response { "meta": { - "previous": null, - "total_count": 7, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/compositeresult/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/compositeresult/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 7 + }, "objects": [ { - "status": "Completed", - "processedflows": 0, - "libmetrics": { - "i100Q20_reads": 0, - "aveKeyCounts": 88, - "id": 1, - "resource_uri": "", - "q20_mean_alignment_length": 0 - }, - "representative": false, - "analysis_metrics": { - "ignored": 1042801, - "lib": 139085639, - "total_wells": 164699136, - "pinned": 2329, - "live": 140339912, - "excluded": 16543404, - "bead": 140400602, - "resource_uri": "", - "id": 1, - "empty": 6710000, - "libFinal": 93974105 - }, - "timeStamp": "2017-07-22T13:15:56.000197+00:00", - "analysismetrics": { - "ignored": 1042801, - "lib": 139085639, - "total_wells": 164699136, - "pinned": 2329, - "live": 140339912, - "excluded": 16543404, - "bead": 140400602, - "resource_uri": "", - "id": 1, - "empty": 6710000, - "libFinal": 93974105 - }, - "reportLink": "/output/Home/Auto_S5-540_WholeTranscriptomeRNA_91_003/", - "reportStatus": "Nothing", - "quality_metrics": { - "q0_mean_read_length": 149.579903660696, - "q0_reads": 93969124, - "q0_bases": "14055892515", - "q20_reads": 93969124, - "q20_bases": "11916010889", - "q20_mean_read_length": 149, - "id": 1, + "analysis_metrics": null, + "analysismetrics": null, + "autoExempt": false, + "eas": { + "barcodeKitName": "IonXpress", + "chipType": "", + "isPQ": false, + "reference": "hg19", + "references": "hg19", "resource_uri": "" - }, - "resultsName": "Auto_S5-540_WholeTranscriptomeRNA_91", + }, + "i18nstatus": { + "i18n": "Pending", + "state": "Other" + }, + "id": 7, + "isShowAllMetrics": true, + "libmetrics": null, + "processedflows": 0, "projects": [ { - "resource_uri": "", - "id": 1, - "name": "demo", - "modified": "2018-02-28T17:32:01.000703+00:00" + "id": 1, + "modified": "2018-02-28T17:32:01.000703+00:00", + "name": "demo", + "resource_uri": "" } - ], - "qualitymetrics": { - "q0_mean_read_length": 149.579903660696, - "q0_reads": 93969124, - "q0_bases": "14055892515", - "q20_reads": 93969124, - "q20_bases": "11916010889", - "q20_mean_read_length": 149, - "id": 1, - "resource_uri": "" - }, - "eas": { - "chipType": "540", - "reference": "", - "isPQ": false, - "references": "", - "barcodeKitName": "IonXpressRNA", - "resource_uri": "" - }, - "resource_uri": "/rundb/api/v1/compositeresult/3/", - "id": 3, - "autoExempt": false, - "isShowAllMetrics": true + ], + "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" } ] } diff --git a/source/api/references_auto_generated/content.rst b/source/api/references_auto_generated/content.rst index 05206ec..89a5a3b 100644 --- a/source/api/references_auto_generated/content.rst +++ b/source/api/references_auto_generated/content.rst @@ -15,37 +15,37 @@ Resource Fields ==================== ============================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ==================== ============================================================================== ======= ======== ======== ===== ====== ======== -**publisher** 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 --------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**extra** Unicode string data. Ex: "Hello World" false false true false string +**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 -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- **enabled** Boolean data. Ex: True true false false true false boolean -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**upload_date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false true false false datetime +**extra** Unicode string data. Ex: "Hello World" false false true false string -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**application_tags** 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 -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**upload_id** Unicode string data. Ex: "Hello World" n/a false true false false string +**name** Unicode string data. Ex: "Hello World" n/a false true false false string -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**file** 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 -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- **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 -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**upload_date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false true false false datetime -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**name** Unicode string data. Ex: "Hello World" n/a false true false false string +**upload_id** Unicode string data. Ex: "Hello World" n/a false true false false string ==================== ============================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -55,90 +55,45 @@ Example Response { "meta": { - "previous": null, - "total_count": 31, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/content/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/content/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 35 + }, "objects": [ { - "publisher": "/rundb/api/v1/publisher/BED/", - "description": "Noonan Panel", - "extra": "hg19", - "contentupload": "/rundb/api/v1/contentupload/1/", - "notes": "", - "enabled": true, - "upload_date": "2018-01-16T18:30:05+00:00", - "application_tags": "", + "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": { - "upload_date": "2018-01-16T18:30:05", - "description": "Noonan Panel", - "reference": "hg19", - "is_ampliseq": true, - "hotspot": false, - "choice": "pgm", - "num_targets": 268, - "num_genes": 14, - "design": { - "number_of_amplicon_pools": 2, - "design_name": "Noonan Panel", - "configuration_choices": [], - "solution_name": null, - "id": 60011570, - "number_of_amplicons": 268, - "genome_reference": null, - "target_size": 26992, - "genome": "hg19", - "type": "COMMUNITY_PANEL", - "status": "ORDERABLE", - "min_number_amplicons_per_pool": 132, - "description": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n
\r\n

Noonan syndrome is a relatively common autosomal dominant congenital disorder with a high phenotypic variability. It is a clinically and genetically heterogeneous disorder that belongs to the group of Rasopathy diseases, caused by mutations in genes dysregulating the RAS/MAPK pathway.\r\nThe Noonan Research Gene Panel has been developed in collaboration with an European consortia composed by Marco Tartaglia(1), Jose Luis Costa (2), Kornelia Neveling and Marcel Nelen (3) . 1) Istituto Superiore di Sanit\u00e0, Rome, Italy, 2) Ipatimup, Porto 3) Human Genetics, Radboud UMC Nijmegen .\r\nThe panel assesses 14 genes known to be related with this disorder. A2ML1, BRAF, CBL, HRAS, KRAS, MAP2K1, MAP2K2, NRAS, PTPN11, RAF1, RIT1, SHOC2, SOS1, SPRED1. In a first study of 60 archived samples we showed that very high sensitivity and specificity are achievable. For further details see ASHG 2014 poster \u201cDevelopment and verification of a Noonan genes Ion AmpliSeq\u2122 panel\u201d M. Nelen et al.\r\n

\r\n
Design Date\r\n Publication: ASHG 2014 Poster \"Development and verification of a Noonan genes Ion AmpliSeq\u2122 panel\"
\r\n Author: Marcel Nelen (Marcel.Nelen@radboudumc.nl)
\r\n Affiliation: Dept. of Human Genetics, Radboud university medical center, Nijmegen, The Netherlands
\r\n
\r\n Recommended Application\r\n Germ line mutation detection\r\n \r\n Recommended Configuration\r\n Sample per Chip: 8 per 318 chip
\r\n Minimum coverage: 684 \r\n 		\r\n Sample Type\r\n High molecular weight DNA\r\n
\r\n Number of sample in Publication\r\n 60 samples \r\n \r\n Observed Performance\r\n Panel uniformity: 93.05%
\r\n Reads on-targets: 98.42% \r\n 		\r\n Input DNA required \r\n 2 pool
\r\n 20 ng total\r\n
\r\n Disease Research Area: Developmental Disorders\r\n
", - "results_uri": "/ws/tmpldesign/60011570/download/results", - "plan": { - "missed_bed": "WG_noonan.20150501.missed.bed", - "hotspot_bed": null, - "coverage_summary": "WG_noonan.20150501.results_coverage_summary.csv", - "designed_bed": "WG_noonan.20150501.designed.bed", - "target_mutations": null, - "primer_bed": null, - "runType": "AMPS", - "selectedPlugins": {}, - "inputDna": "20 ng", - "coverage_detail": "WG_noonan.20150501.results_coverage_details.csv", - "primer_sequences": null, - "displayedPanelSize": "26.99 kb", - "submitted_bed": "WG_noonan.20150501.submitted.bed", - "well_plate_data": "WG_noonan.20150501.384WellPlateDataSheet.csv" - }, - "design_id": "Noonan", - "pipeline": "DNA", - "request_id_and_solution_ordering_id": "Noonan", - "pipeline_version": null, - "created_date": "2015-05-22T20:52:38.703+0000", - "order_number": 0, - "amplicons_coverage_summary": 100 - }, + "description": "", + "enabled": true, + "hotspot": false, + "is_ampliseq": false, + "notes": "", + "num_bases": 2201026, + "num_genes": 23930, + "num_targets": 23930, "pre_process_files": [ - "WG_noonan.20150501.designed.bed", - "WG_noonan.20150501.missed.bed", - "WG_noonan.20150501.submitted.bed", - "WG_noonan.20150501.results_coverage_details.csv", - "WG_noonan.20150501.ampliconDataSheet.csv", - "WG_noonan.20150501.384WellPlateDataSheet.csv", - "WG_noonan.20150501.concentration.tab", - "WG_noonan.20150501.results_coverage_summary.csv", - "plan.json" - ], - "num_bases": 47724 - }, - "upload_id": "1", - "file": "/results/uploads/BED/1/hg19/unmerged/plain/WG_noonan.20150501.designed.bed", - "path": "/hg19/unmerged/plain/WG_noonan.20150501.designed.bed", - "resource_uri": "/rundb/api/v1/content/1/", - "type": "target", - "id": 1, - "name": "WG_noonan.20150501.designed.bed" + "/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" } ] } diff --git a/source/api/references_auto_generated/contentupload.rst b/source/api/references_auto_generated/contentupload.rst index b86945c..068b6e8 100644 --- a/source/api/references_auto_generated/contentupload.rst +++ b/source/api/references_auto_generated/contentupload.rst @@ -15,27 +15,27 @@ Resource Fields ================ ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================ ==================================================== ======= ======== ======== ===== ====== ======== -**status** Unicode string data. Ex: "Hello World" false false true false string +**file_path** Unicode string data. Ex: "Hello World" n/a false false false false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**upload_date** A date & time as a string. Ex: "2010-11-10T03:07:43" true true false false false datetime +**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 ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer ----------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** 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 ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **source** Unicode string data. Ex: "Hello World" false false true false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**meta** Unicode string data. Ex: "Hello World" {} false false true false string +**status** Unicode string data. Ex: "Hello World" false false true false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**upload_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" true true false false false datetime ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**file_path** Unicode string data. Ex: "Hello World" n/a false false false false string +**upload_type** 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 +**username** Unicode string data. Ex: "Hello World" false false true false string ================ ==================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -45,39 +45,40 @@ Example Response { "meta": { - "previous": null, - "total_count": 20, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/contentupload/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/contentupload/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 21 + }, "objects": [ { - "status": "Successfully Completed", - "upload_date": "2018-04-13T18:54:45.000418+00:00", - "name": "gencode.v19.annotation_and_tRNAs.gtf", - "pub": "refAnnot", - "id": 21, - "username": "ionadmin", - "source": "http://updates.itw/internal_reference_downloads/hg19/gencode.v19.annotation_and_tRNAs.gtf", + "file_path": "/results/uploads/BED/22/AmpliSeq_Mouse_Transcriptome_V1_Designed.bed", + "id": 22, "meta": { - "username": "ionadmin", - "upload_date": "2018-04-13T18:54:45", - "description": "hg19 and tRNA gene annotation file for smallRNA", - "reference": "hg19", - "url": "http://updates.itw/internal_reference_downloads/hg19/gencode.v19.annotation_and_tRNAs.gtf", - "upload_type": "Annotation", - "identity_hash": "c47c7d854a9767400224e119246494ec", - "application_tags": "smallRNA", - "updateversion": "1.0", - "filesize": "1109491", - "short_description": "hg19 and tRNA GTF annotation", - "publication_date": "2018-02-14", - "annot_type": "GTF" - }, - "upload_type": "Annotation", - "file_path": "/results/uploads/refAnnot/21/gencode.v19.annotation_and_tRNAs.gtf", - "resource_uri": "/rundb/api/v1/contentupload/21/" + "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" } ] } diff --git a/source/api/references_auto_generated/datamanagementhistory.rst b/source/api/references_auto_generated/datamanagementhistory.rst index 3ad008d..6e7d4b3 100644 --- a/source/api/references_auto_generated/datamanagementhistory.rst +++ b/source/api/references_auto_generated/datamanagementhistory.rst @@ -15,19 +15,19 @@ Resource Fields ================ ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================ ==================================================== ======= ======== ======== ===== ====== ======== -**username** Unicode string data. Ex: "Hello World" ION false false true false string ----------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **created** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**text** Unicode string data. Ex: "Hello World" false false false false string +**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 ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**text** 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 +**username** Unicode string data. Ex: "Hello World" ION false false true false string ================ ==================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -37,21 +37,21 @@ Example Response { "meta": { - "previous": null, - "total_count": 36, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/datamanagementhistory/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/datamanagementhistory/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 36 + }, "objects": [ { - "username": "ionadmin", - "created": "2017-07-22T06:59:07.000501+00:00", - "text": "Started from Local Basecalling Input /results/S5_DemoData/S5-530_cfDNA.", - "object_pk": 1, - "resultsName": "Auto_S5-530_cfDNA_89", - "id": 8, - "resource_uri": "/rundb/api/v1/datamanagementhistory/8/" + "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" } ] } diff --git a/source/api/references_auto_generated/dnabarcode.rst b/source/api/references_auto_generated/dnabarcode.rst index 641d271..74f628d 100644 --- a/source/api/references_auto_generated/dnabarcode.rst +++ b/source/api/references_auto_generated/dnabarcode.rst @@ -15,39 +15,39 @@ Resource Fields ================== ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================== ====================================== ======= ======== ======== ===== ====== ======= -**index** Integer data. Ex: 2673 n/a false false false false integer +**active** Boolean data. Ex: True true false false true false boolean ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**end_adapter** Unicode string data. Ex: "Hello World" false false true false string +**adapter** 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 +**annotation** Unicode string data. Ex: "Hello World" false false true false string ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**score_cutoff** Floating point numeric data. Ex: 26.73 0 false false false false float +**end_adapter** Unicode string data. Ex: "Hello World" false false true false string ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**sequence** Unicode string data. Ex: "Hello World" n/a false false false false string +**end_sequence** Unicode string data. Ex: "Hello World" false false true false string ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**is_end_barcode** Boolean data. Ex: True false false false true false boolean +**id** Integer data. Ex: 2673 false false true true integer ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**adapter** Unicode string data. Ex: "Hello World" false false true false string +**id_str** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**system** Boolean data. Ex: True false false false true false boolean +**index** Integer data. Ex: 2673 n/a false false false false integer ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true 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 ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**id_str** 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 ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**active** 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 ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**end_sequence** Unicode string data. Ex: "Hello World" false false true 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 ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**type** Unicode string data. Ex: "Hello World" false false true false string +**sequence** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**annotation** Unicode string data. Ex: "Hello World" false false true false string +**system** 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 +**type** Unicode string data. Ex: "Hello World" false false true false string ================== ====================================== ======= ======== ======== ===== ====== ======= Example Response @@ -57,31 +57,31 @@ Example Response { "meta": { - "previous": null, - "total_count": 2090, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/dnabarcode/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/dnabarcode/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2090 + }, "objects": [ { - "index": 1, - "end_adapter": "", - "name": "MuSeek_5prime_tag", - "score_cutoff": 2, - "sequence": "TTCA", - "is_end_barcode": false, - "adapter": "", - "system": false, - "id": 1, - "length": 4, - "id_str": "MuSeek_5prime_tag_001", - "active": true, - "end_sequence": "", - "score_mode": 1, - "type": "none", - "annotation": "", - "resource_uri": "/rundb/api/v1/dnabarcode/1/" + "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": "" } ] } diff --git a/source/api/references_auto_generated/emailaddress.rst b/source/api/references_auto_generated/emailaddress.rst index b7c5b4b..d720263 100644 --- a/source/api/references_auto_generated/emailaddress.rst +++ b/source/api/references_auto_generated/emailaddress.rst @@ -15,13 +15,13 @@ Resource Fields ================ ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================ ====================================== ======= ======== ======== ===== ====== ======= -**selected** Boolean data. Ex: True false false true false boolean ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **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 @@ -31,12 +31,12 @@ Example Response { "meta": { - "previous": null, - "total_count": 0, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 0 + }, "objects": [] } diff --git a/source/api/references_auto_generated/eventlog.rst b/source/api/references_auto_generated/eventlog.rst index 0c6a2b1..2decabc 100644 --- a/source/api/references_auto_generated/eventlog.rst +++ b/source/api/references_auto_generated/eventlog.rst @@ -15,17 +15,17 @@ Resource Fields ================ ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================ ==================================================== ======= ======== ======== ===== ====== ======== -**username** Unicode string data. Ex: "Hello World" ION false false true false string ----------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **created** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**text** Unicode string data. Ex: "Hello World" false false false false string +**id** Integer data. Ex: 2673 false false true true integer ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **object_pk** Integer data. Ex: 2673 n/a false 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 +---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- +**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 @@ -35,20 +35,20 @@ Example Response { "meta": { - "previous": null, - "total_count": 56, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/eventlog/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/eventlog/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 57 + }, "objects": [ { - "username": "ionadmin", - "created": "2018-02-26T17:28:33.000742+00:00", - "text": "Created Planned Run: Ion_ReproSeq_Aneuploidy_-_Ion_PGM_System (131)", - "object_pk": 131, - "id": 51, - "resource_uri": "/rundb/api/v1/eventlog/51/" + "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" } ] } diff --git a/source/api/references_auto_generated/experiment.rst b/source/api/references_auto_generated/experiment.rst index 6cfe9fd..01bb508 100644 --- a/source/api/references_auto_generated/experiment.rst +++ b/source/api/references_auto_generated/experiment.rst @@ -15,163 +15,163 @@ Resource Fields ============================= ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ============================= ================================================================================================== ======= ======== ======== ===== ====== ======== -**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefLotNumber** Unicode string data. Ex: "Hello World" false false true false string +**autoAnalyze** Boolean data. Ex: True true false false true false boolean ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" n/a false false false false string +**baselineRun** Boolean data. Ex: True false false false true false boolean ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefProtocolDeviationName** Unicode string data. Ex: "Hello World" n/a true false false false string +**chefChipExpiration1** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefReagentID** Unicode string data. Ex: "Hello World" false false true false string +**chefChipExpiration2** Unicode string data. Ex: "Hello World" false false true 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 +**chefChipType1** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefSolutionsPart** Unicode string data. Ex: "Hello World" false false true false string +**chefChipType2** 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 +**chefEndTime** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefLastUpdate** 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storage_options** Unicode string data. Ex: "Hello World" A false false false false string +**chefExtraInfo_2** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefChipExpiration1** Unicode string data. Ex: "Hello World" false false true false string +**chefFlexibleWorkflow** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefChipExpiration2** Unicode string data. Ex: "Hello World" false false true false string +**chefInstrumentName** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**diskusage** Integer data. Ex: 2673 n/a true false false false integer +**chefKitType** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefStatus** 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string +**chefLogPath** Unicode string data. Ex: "Hello World" n/a true false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** Unicode string data. Ex: "Hello World" false false true false string +**chefLotNumber** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**chefManufactureDate** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefReagentsPart** Unicode string data. Ex: "Hello World" false false true false string +**chefMessage** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**chefOperationMode** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefInstrumentName** Unicode string data. Ex: "Hello World" false false true false string +**chefPackageVer** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefSolutionsSerialNum** 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sample** Unicode string data. Ex: "Hello World" n/a false true true false string +**chefProtocolDeviationName** Unicode string data. Ex: "Hello World" n/a true false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**log** Unicode string data. Ex: "Hello World" {} false false true false string +**chefReagentID** 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 +**chefReagentsExpiration** 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 +**chefReagentsLot** Unicode string data. Ex: "Hello World" false false true 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 +**chefReagentsPart** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefLogPath** Unicode string data. Ex: "Hello World" n/a true false false false string +**chefReagentsSerialNum** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefFlexibleWorkflow** Unicode string data. Ex: "Hello World" false false true false string +**chefRemainingSeconds** Integer data. Ex: 2673 n/a true false false false integer ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**platform** Unicode string data. Ex: "Hello World" false false true false string +**chefSamplePos** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **chefScriptVersion** Unicode string data. Ex: "Hello World" false false 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 +**chefSolutionsExpiration** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefOperationMode** Unicode string data. Ex: "Hello World" false false true false string +**chefSolutionsLot** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefManufactureDate** Unicode string data. Ex: "Hello World" false false true false string +**chefSolutionsPart** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefSamplePos** Unicode string data. Ex: "Hello World" false false true false string +**chefSolutionsSerialNum** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pinnedRepResult** Boolean data. Ex: True false false false true false boolean +**chefStartTime** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefReagentsExpiration** Unicode string data. Ex: "Hello World" false false true false string +**chefStatus** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefSolutionsLot** Unicode string data. Ex: "Hello World" false false true false string +**chefTipRackBarcode** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reagentBarcode** Unicode string data. Ex: "Hello World" false false true false string +**chipBarcode** 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 +**chipType** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefKitType** Unicode string data. Ex: "Hello World" false false true false string +**cycles** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**star** 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 false false false false datetime ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefPackageVer** Unicode string data. Ex: "Hello World" false false true false string +**diskusage** Integer data. Ex: 2673 n/a true false false false integer ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePreBeadfind** Boolean data. Ex: True true false false true false boolean +**displayName** Unicode string data. Ex: "Hello World" false false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isProton** Unicode string data. Ex: "Hello World" n/a false true 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flowsInOrder** 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true true false false false datetime +**flowsInOrder** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefTipRackBarcode** Unicode string data. Ex: "Hello World" false false true false string +**ftpStatus** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefRemainingSeconds** Integer data. Ex: 2673 n/a true false false false integer +**id** Integer data. Ex: 2673 false false true true integer ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**plan** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**isProton** Unicode string data. Ex: "Hello World" n/a false true false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false false false false datetime +**isReverseRun** Boolean data. Ex: True false false false true false boolean ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefExtraInfo_1** Unicode string data. Ex: "Hello World" false false true false string +**log** Unicode string data. Ex: "Hello World" {} false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefExtraInfo_2** Unicode string data. Ex: "Hello World" false false true false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**unique** Unicode string data. Ex: "Hello World" n/a false false false true string +**notes** Unicode string data. Ex: "Hello World" n/a true false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expDir** Unicode string data. Ex: "Hello World" n/a false false false false string +**pgmName** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoAnalyze** Boolean data. Ex: True true false false true false boolean +**pinnedRepResult** Boolean data. Ex: True false false false true false boolean ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**ftpStatus** Unicode string data. Ex: "Hello World" false false true 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefMessage** Unicode string data. Ex: "Hello World" false false true false string +**platform** 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 +**rawdatastyle** Unicode string data. Ex: "Hello World" single true false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**displayName** Unicode string data. Ex: "Hello World" false false false false string +**reagentBarcode** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pgmName** 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**resultDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true true false false false datetime ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" n/a true false 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sequencekitname** 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipBarcode** Unicode string data. Ex: "Hello World" false false true false string +**runMode** 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 +**runtype** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefSolutionsExpiration** Unicode string data. Ex: "Hello World" false false true false string +**sample** Unicode string data. Ex: "Hello World" n/a false true true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefReagentsLot** Unicode string data. Ex: "Hello World" false false 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storageHost** Unicode string data. Ex: "Hello World" n/a true false false false string +**seqKitBarcode** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" n/a false false false false string +**sequencekitbarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**status** Unicode string data. Ex: "Hello World" false false true false string +**sequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefReagentsSerialNum** Unicode string data. Ex: "Hello World" false false true false string +**star** Boolean data. Ex: True false false false true false boolean ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a false false false false integer +**status** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefChipType2** 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefChipType1** 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 ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**baselineRun** Boolean data. Ex: True false false false true false boolean +**unique** Unicode string data. Ex: "Hello World" n/a false false false true string ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**user_ack** Unicode string data. Ex: "Hello World" U false false false false string +**usePreBeadfind** Boolean data. Ex: True true false false true false boolean ----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**rawdatastyle** Unicode string data. Ex: "Hello World" single true false false false string +**user_ack** Unicode string data. Ex: "Hello World" U false false false false string ============================= ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -181,153 +181,138 @@ Example Response { "meta": { - "previous": null, - "total_count": 112, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/experiment/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/experiment/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 136 + }, "objects": [ { - "isReverseRun": false, - "chefLotNumber": "", - "chipType": "P1.1.17", - "chefProtocolDeviationName": null, - "chefReagentID": "", - "results": [], - "chefSolutionsPart": "", - "runtype": "GENS", - "chefLastUpdate": null, - "storage_options": "A", - "chefChipExpiration1": "", - "chefChipExpiration2": "", - "diskusage": null, - "chefStatus": "", - "reverse_primer": null, - "seqKitBarcode": "", - "id": 5, - "chefReagentsPart": "", - "metaData": {}, - "chefInstrumentName": "", - "chefSolutionsSerialNum": "", - "sample": "", - "log": {}, - "sequencekitbarcode": "", - "resource_uri": "/rundb/api/v1/experiment/5/", + "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": [ { - "ionstatsargs": "", - "isEditable": true, - "endBarcodeKitName": "", - "hotSpotRegionBedFile": "", - "results": [], - "mixedTypeRNA_reference": null, - "mixedTypeRNA_targetRegionBedFile": null, - "targetRegionBedFile": "", - "thumbnailalignmentargs": "", - "thumbnailanalysisargs": "", - "id": 5, - "barcodedSamples": {}, - "base_recalibration_mode": "standard_recal", - "reference": "", - "isOneTimeOverride": false, - "mixedTypeRNA_hotSpotRegionBedFile": null, - "analysisargs": "", - "thumbnailcalibrateargs": "", - "realign": false, - "selectedPlugins": { - "RNASeqAnalysis": { - "userInput": {}, - "version": "5.8.0.0", - "features": [], - "name": "RNASeqAnalysis", - "id": 29 - }, - "PartekFlowUploader": { - "userInput": {}, - "version": "1.0", - "features": [], - "name": "PartekFlowUploader", - "id": 9999 - } - }, - "experiment": "/rundb/api/v1/experiment/5/", - "barcodeKitName": "IonXpressRNA", - "beadfindargs": "", - "threePrimeAdapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC", - "thumbnailbasecallerargs": "", - "status": "planned", - "prebasecallerargs": "", - "thumbnailionstatsargs": "", - "prethumbnailbasecallerargs": "", - "alignmentargs": "", - "isDuplicateReads": false, - "libraryKey": "TCAG", - "date": "2018-01-12T19:38:34.000886+00:00", - "libraryKitName": "Ion Total RNA Seq Kit v2", - "thumbnailbeadfindargs": "", - "calibrateargs": "", - "tfKey": "ATCG", - "libraryKitBarcode": null, - "sseBedFile": "", - "basecallerargs": "", - "custom_args": false, - "resource_uri": "/rundb/api/v1/experimentanalysissettings/5/" + "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": "" } - ], - "chefLogPath": null, - "chefFlexibleWorkflow": "", - "platform": "PROTON", - "chefScriptVersion": "", - "samples": [], - "chefOperationMode": "", - "chefManufactureDate": "", - "chefSamplePos": "", - "pinnedRepResult": false, - "chefReagentsExpiration": "", - "chefSolutionsLot": "", - "reagentBarcode": "", - "chefProgress": 0, - "chefKitType": "", - "star": false, - "chefPackageVer": "", - "usePreBeadfind": false, - "isProton": "True", - "expCompInfo": "", - "flowsInOrder": "", - "flows": 500, - "resultDate": "2017-07-22T06:41:42.000088+00:00", - "chefTipRackBarcode": "", - "chefRemainingSeconds": null, - "plan": "/rundb/api/v1/plannedexperiment/20/", - "date": "2017-07-22T06:41:42.000087+00:00", - "chefExtraInfo_1": "", - "chefExtraInfo_2": "", - "unique": "39ef1391-032b-44d8-a7a1-d11dbb6028e2", - "expDir": "", - "autoAnalyze": true, - "ftpStatus": "Complete", - "chefMessage": "", - "chefEndTime": null, - "displayName": "NN4E0", - "pgmName": "", - "runMode": "single", - "notes": "", - "sequencekitname": "ProtonI200Kit-v3", - "chipBarcode": "", - "chefStartTime": null, - "chefSolutionsExpiration": "", - "chefReagentsLot": "", - "storageHost": "", - "expName": "39ef1391-032b-44d8-a7a1-d11dbb6028e2", - "status": "planned", - "chefReagentsSerialNum": "", - "cycles": 0, - "chefChipType2": "", - "chefChipType1": "", - "baselineRun": false, - "user_ack": "U", - "rawdatastyle": "single" + ], + "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" } ] } diff --git a/source/api/references_auto_generated/experimentanalysissettings.rst b/source/api/references_auto_generated/experimentanalysissettings.rst index e419da8..4fd7740 100644 --- a/source/api/references_auto_generated/experimentanalysissettings.rst +++ b/source/api/references_auto_generated/experimentanalysissettings.rst @@ -15,89 +15,89 @@ Resource Fields ===================================== ================================================================================================== ============== ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ===================================== ================================================================================================== ============== ======== ======== ===== ====== ======== -**ionstatsargs** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**isEditable** Boolean data. Ex: True false false false true false boolean -------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false false false string +**alignmentargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" n/a true false false false string +**analysisargs** Unicode string data. Ex: "Hello World" false false true 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 +**barcodeKitName** 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 +**barcodedSamples** Unicode string data. Ex: "Hello World" {} true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" n/a true false false false string +**base_recalibration_mode** Unicode string data. Ex: "Hello World" standard_recal false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**targetRegionBedFile** Unicode string data. Ex: "Hello World" n/a true false false false string +**basecallerargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**thumbnailalignmentargs** Unicode string data. Ex: "Hello World" false false true false string +**beadfindargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**thumbnailanalysisargs** Unicode string data. Ex: "Hello World" false false true false string +**calibrateargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**custom_args** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**barcodedSamples** Unicode string data. Ex: "Hello World" {} 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 ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**base_recalibration_mode** Unicode string data. Ex: "Hello World" standard_recal false false false false string +**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**reference** Unicode string data. Ex: "Hello World" n/a 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 ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**isOneTimeOverride** Boolean data. Ex: True false false false true false boolean +**hotSpotRegionBedFile** 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 +**id** Integer data. Ex: 2673 false false true true integer ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**analysisargs** Unicode string data. Ex: "Hello World" false false true false string +**ionstatsargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**thumbnailcalibrateargs** Unicode string data. Ex: "Hello World" false false true false string +**isDuplicateReads** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**realign** Boolean data. Ex: True false false false true false boolean +**isEditable** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**selectedPlugins** Unicode string data. Ex: "Hello World" {} true false false false string +**isOneTimeOverride** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**libraryKey** 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 +**libraryKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**beadfindargs** Unicode string data. Ex: "Hello World" false false true false string +**libraryKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**threePrimeAdapter** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**thumbnailbasecallerargs** Unicode string data. Ex: "Hello World" false false true false string +**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**status** Unicode string data. Ex: "Hello World" false false true 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 ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**thumbnailionstatsargs** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- **prethumbnailbasecallerargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**alignmentargs** Unicode string data. Ex: "Hello World" false false true false string +**realign** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**isDuplicateReads** Boolean data. Ex: True false false false true false boolean +**reference** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**libraryKey** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a 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 ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**libraryKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**selectedPlugins** Unicode string data. Ex: "Hello World" {} true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**thumbnailbeadfindargs** Unicode string data. Ex: "Hello World" false false true false string +**sseBedFile** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**calibrateargs** Unicode string data. Ex: "Hello World" false false true 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 ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**libraryKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**threePrimeAdapter** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**sseBedFile** Unicode string data. Ex: "Hello World" true false false false string +**thumbnailalignmentargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**basecallerargs** Unicode string data. Ex: "Hello World" false false true false string +**thumbnailanalysisargs** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- -------------- -------- -------- ----- ------ -------- -**custom_args** Boolean data. Ex: True false false false true false boolean +**thumbnailbasecallerargs** 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 +**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 @@ -107,56 +107,56 @@ Example Response { "meta": { - "previous": null, - "total_count": 112, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/experimentanalysissettings/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/experimentanalysissettings/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 136 + }, "objects": [ { - "ionstatsargs": "", - "isEditable": true, - "endBarcodeKitName": "", - "hotSpotRegionBedFile": "", - "results": [], - "mixedTypeRNA_reference": null, - "mixedTypeRNA_targetRegionBedFile": null, - "targetRegionBedFile": "", - "thumbnailalignmentargs": "", - "thumbnailanalysisargs": "", - "id": 2, - "barcodedSamples": {}, - "base_recalibration_mode": "standard_recal", - "reference": "", - "isOneTimeOverride": false, - "mixedTypeRNA_hotSpotRegionBedFile": null, - "analysisargs": "", - "thumbnailcalibrateargs": "", - "realign": false, - "selectedPlugins": {}, - "experiment": "/rundb/api/v1/experiment/2/", - "barcodeKitName": "", - "beadfindargs": "", - "threePrimeAdapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC", - "thumbnailbasecallerargs": "", - "status": "planned", - "prebasecallerargs": "", - "thumbnailionstatsargs": "", - "prethumbnailbasecallerargs": "", - "alignmentargs": "", - "isDuplicateReads": false, - "libraryKey": "TCAG", - "date": "2017-07-22T06:43:55.000629+00:00", - "libraryKitName": "Ion Xpress Plus Fragment Library Kit", - "thumbnailbeadfindargs": "", - "calibrateargs": "", - "tfKey": "ATCG", - "libraryKitBarcode": null, - "sseBedFile": "", - "basecallerargs": "", - "custom_args": false, - "resource_uri": "/rundb/api/v1/experimentanalysissettings/2/" + "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": "" } ] } diff --git a/source/api/references_auto_generated/filemonitor.rst b/source/api/references_auto_generated/filemonitor.rst index dead9f7..d919921 100644 --- a/source/api/references_auto_generated/filemonitor.rst +++ b/source/api/references_auto_generated/filemonitor.rst @@ -15,31 +15,31 @@ Resource Fields ================== ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================== ==================================================== ======= ======== ======== ===== ====== ======== -**status** 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 ------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**name** Unicode string data. Ex: "Hello World" false false false false string +**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 ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**url** Unicode string data. Ex: "Hello World" n/a false false false false string +**id** Integer data. Ex: 2673 false false true true integer ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**md5sum** Unicode string data. Ex: "Hello World" None true false false false string +**local_dir** Unicode string data. Ex: "Hello World" false false false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**celery_task_id** Unicode string data. Ex: "Hello World" false false true false string +**md5sum** Unicode string data. Ex: "Hello World" None true false false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**local_dir** Unicode string data. Ex: "Hello World" false 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 ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**status** Unicode string data. Ex: "Hello World" false false false false string ------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **tags** 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 +**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 @@ -49,27 +49,27 @@ Example Response { "meta": { - "previous": null, - "total_count": 9, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/filemonitor/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/filemonitor/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 9 + }, "objects": [ { - "status": "Complete", - "updated": "2018-04-13T18:54:39.000796+00:00", - "name": "gene.gtf", - "created": "2018-04-13T18:54:08.000422+00:00", - "url": "http://updates.itw/internal_reference_downloads/hg19/gene.gtf", - "md5sum": "72fbd490a4d3be60e53e642d4401c944", - "celery_task_id": "7db1de03-b295-4b62-9cdc-9cbb4c6065b0", - "local_dir": "/tmp/tmppTeNvf", - "progress": "1111970946", - "size": "1111970946", - "id": 7, - "tags": "annotation", - "resource_uri": "/rundb/api/v1/filemonitor/7/" + "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" } ] } diff --git a/source/api/references_auto_generated/fileserver.rst b/source/api/references_auto_generated/fileserver.rst index 9f56c78..0428f6b 100644 --- a/source/api/references_auto_generated/fileserver.rst +++ b/source/api/references_auto_generated/fileserver.rst @@ -15,16 +15,16 @@ Resource Fields ================ ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================ ====================================== ======= ======== ======== ===== ====== ======= -**percentfull** Floating point numeric data. Ex: 26.73 0 true false false false float ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**name** Unicode string data. Ex: "Hello World" n/a false false false false string +**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 ---------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**comments** 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 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 ================ ====================================== ======= ======== ======== ===== ====== ======= @@ -35,19 +35,19 @@ Example Response { "meta": { - "previous": null, - "total_count": 1, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 1 + }, "objects": [ { - "percentfull": 39.0445528646121, - "name": "Home", - "filesPrefix": "/results/", - "comments": "", - "id": 1, + "comments": "", + "filesPrefix": "/results/", + "id": 1, + "name": "Home", + "percentfull": 40.1362957221239, "resource_uri": "/rundb/api/v1/fileserver/1/" } ] diff --git a/source/api/references_auto_generated/floworder.rst b/source/api/references_auto_generated/floworder.rst index e2e4d09..762389d 100644 --- a/source/api/references_auto_generated/floworder.rst +++ b/source/api/references_auto_generated/floworder.rst @@ -17,19 +17,19 @@ field help text default nullable readonl ================ ====================================== ======= ======== ======== ===== ====== ======= **description** 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 ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **flowOrder** Unicode string data. Ex: "Hello World" false false true false string ---------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**isActive** Boolean data. Ex: True true false false true false boolean ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**isSystem** Boolean data. Ex: True false false false true false boolean ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **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 @@ -39,22 +39,22 @@ Example Response { "meta": { - "previous": null, - "total_count": 7, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/floworder/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/floworder/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 7 + }, "objects": [ { - "description": "Ion contradanzon flow order", - "resource_uri": "/rundb/api/v1/floworder/3/", - "flowOrder": "TACGTACGTAGCTTGACGTACGTCATGCATCGATCAGCTAAGCTGACGTAGCTAGCATCGATCCAGTCATGACTGACGTAGCTGACTGGATCAGTCATGCATCG", - "isActive": false, - "isSystem": true, - "id": 3, - "isDefault": false, - "name": "Ion contradanzon" + "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/" } ] } diff --git a/source/api/references_auto_generated/getchefcartridgeusage.rst b/source/api/references_auto_generated/getchefcartridgeusage.rst index be4bba8..4abca5f 100644 --- a/source/api/references_auto_generated/getchefcartridgeusage.rst +++ b/source/api/references_auto_generated/getchefcartridgeusage.rst @@ -36,17 +36,17 @@ Example Response .. code-block:: javascript { - "hoursSinceSolutionFirstUse": "", - "numberSolutionSerialUsage": 0, - "errorCodes": [ - "E305" - ], - "allowRunToContinue": false, + "allowRunToContinue": false, "detailMessages": { "E305": "Missing chef inputs filter option ['chefReagentsSerialNum', 'chefSolutionsSerialNum', 'kitName']" - }, - "numberReagentSerialUsage": 0, - "hoursSinceReagentFirstUse": "" + }, + "errorCodes": [ + "E305" + ], + "hoursSinceReagentFirstUse": "", + "hoursSinceSolutionFirstUse": "", + "numberReagentSerialUsage": 0, + "numberSolutionSerialUsage": 0 } Allowed list HTTP methods diff --git a/source/api/references_auto_generated/getchefscriptinfo.rst b/source/api/references_auto_generated/getchefscriptinfo.rst index d3ca6c0..7bad5b1 100644 --- a/source/api/references_auto_generated/getchefscriptinfo.rst +++ b/source/api/references_auto_generated/getchefscriptinfo.rst @@ -26,10 +26,10 @@ Example Response { "object": { "availableversion": { - "IS_scripts": "000803", "Compatible_Chef_release": [ - "IC.5.10.0" - ] + "IC.5.12.1.RC.1" + ], + "IS_scripts": "000905" } } } diff --git a/source/api/references_auto_generated/globalconfig.rst b/source/api/references_auto_generated/globalconfig.rst index ad007d1..4c94b7e 100644 --- a/source/api/references_auto_generated/globalconfig.rst +++ b/source/api/references_auto_generated/globalconfig.rst @@ -15,61 +15,61 @@ Resource Fields ============================= ====================================== ============== ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================= ====================================== ============== ======== ======== ===== ====== ======= -**enable_version_lock** Boolean data. Ex: True false false false true false boolean ------------------------------ -------------------------------------- -------------- -------- -------- ----- ------ ------- -**site_name** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ -------------------------------------- -------------- -------- -------- ----- ------ ------- -**enable_support_upload** Boolean data. Ex: True false false false true false boolean ------------------------------ -------------------------------------- -------------- -------- -------- ----- ------ ------- -**plugin_output_folder** Unicode string data. Ex: "Hello World" false false true false string ------------------------------ -------------------------------------- -------------- -------- -------- ----- ------ ------- **auto_archive_ack** Boolean data. Ex: True false false false true false boolean ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**enable_compendia_OCP** Boolean data. Ex: True false false false true false boolean ------------------------------ -------------------------------------- -------------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true integer +**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 ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**default_storage_options** Unicode string data. Ex: "Hello World" D false false true false string +**check_news_posts** Boolean data. Ex: True true false false true false boolean ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**selected** Boolean data. Ex: True false false true false boolean +**cluster_auto_disable** Boolean data. Ex: True true false false true false boolean ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**check_news_posts** Boolean data. Ex: True true false false true false boolean +**default_flow_order** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**realign** Boolean data. Ex: True false false false true false boolean +**default_library_key** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**ts_update_status** 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 ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**mark_duplicates** Boolean data. Ex: True false false false true false boolean +**default_test_fragment_key** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**auto_archive_enable** Boolean data. Ex: True false false false true false boolean +**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 ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**sec_update_status** Unicode string data. Ex: "Hello World" false false true false string +**enable_support_upload** Boolean data. Ex: True false false false true false boolean ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**default_flow_order** Unicode string data. Ex: "Hello World" false false true false string +**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 ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**telemetry_enabled** 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 ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**default_library_key** Unicode string data. Ex: "Hello World" false false true false string +**sec_update_status** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**cluster_auto_disable** Boolean data. Ex: True true false false true false boolean +**selected** Boolean data. Ex: True false false true false boolean ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**web_root** Unicode string data. Ex: "Hello World" false false true false string +**site_name** Unicode string data. Ex: "Hello World" false false true false string ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**default_test_fragment_key** Unicode string data. Ex: "Hello World" false false true false string +**telemetry_enabled** Boolean data. Ex: True true false false true false boolean ----------------------------- -------------------------------------- -------------- -------- -------- ----- ------ ------- -**enable_auto_pkg_dl** Boolean data. Ex: True true false false true false boolean +**ts_update_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 +**web_root** Unicode string data. Ex: "Hello World" false false true false string ============================= ====================================== ============== ======== ======== ===== ====== ======= Example Response @@ -79,42 +79,42 @@ Example Response { "meta": { - "previous": null, - "total_count": 1, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 1 + }, "objects": [ { - "enable_version_lock": false, - "site_name": "Torrent Server", - "enable_support_upload": false, - "plugin_output_folder": "plugin_out", - "auto_archive_ack": true, - "enable_compendia_OCP": true, - "id": 1, - "base_recalibration_mode": "standard_recal", - "default_storage_options": "A", - "selected": false, - "check_news_posts": true, - "realign": false, - "ts_update_status": "Ready to install", - "mark_duplicates": false, - "auto_archive_enable": true, - "enable_auto_security": true, - "enable_nightly_email": true, - "sec_update_status": "", - "default_flow_order": "TACG", - "name": "Config", - "records_to_display": 20, - "telemetry_enabled": true, - "default_library_key": "TCAG", - "cluster_auto_disable": true, - "web_root": "", - "default_test_fragment_key": "ATCG", - "enable_auto_pkg_dl": true, - "resource_uri": "/rundb/api/v1/globalconfig/1/" + "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": "" } ] } diff --git a/source/api/references_auto_generated/ionchefplantemplate.rst b/source/api/references_auto_generated/ionchefplantemplate.rst index 24cb350..61cae5a 100644 --- a/source/api/references_auto_generated/ionchefplantemplate.rst +++ b/source/api/references_auto_generated/ionchefplantemplate.rst @@ -15,193 +15,193 @@ Resource Fields ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**planDisplayedName** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean +**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodeId** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**platform** Unicode string data. Ex: "Hello World" n/a 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string +**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string +**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**chipBarcode** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" true false true false string +**chipType** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**base_recalibration_mode** Unicode string data. Ex: "Hello World" true false true false string +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storageHost** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string +**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**expName** 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 +**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" false false false false string +**flows** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**library** Unicode string data. Ex: "Hello World" true false true false string +**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string +**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**id** Integer data. Ex: 2673 false false true true integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodeId** Unicode string data. Ex: "Hello World" true false true false string +**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**realign** Boolean data. Ex: True n/a false false false false boolean +**isFavorite** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**bedfile** Unicode string data. Ex: "Hello World" false false true false string +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean +**libkit** Unicode string data. Ex: "Hello World" n/a 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 +**library** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**librarykitname** Unicode string data. Ex: "Hello World" true false true false string +**libraryKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string +**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string +**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string +**librarykitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**origin** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string +**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean +**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**notes** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**planDisplayedName** 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 +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**tfKey** Unicode string data. Ex: "Hello World" false false true false string +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string +**platform** Unicode string data. Ex: "Hello World" n/a true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string +**project** Unicode string data. Ex: "Hello World" n/a false true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** Unicode string data. Ex: "Hello World" false false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**irworkflow** Unicode string data. Ex: "Hello World" false false true false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**realign** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**project** Unicode string data. Ex: "Hello World" n/a false true true false string +**regionfile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict +**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**runType** Unicode string data. Ex: "Hello World" GENS false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** Unicode string data. Ex: "Hello World" n/a true 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**regionfile** Unicode string data. Ex: "Hello World" false false true false string +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string +**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoName** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryKey** Unicode string data. Ex: "Hello World" false false true false string +**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flows** Integer data. Ex: 2673 0 false false false false integer +**seqKitBarcode** 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 +**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string +**storageHost** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string +**templatingKitName** 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 +**tfKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipBarcode** Unicode string data. Ex: "Hello World" false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string -------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string +**username** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string +**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -211,188 +211,169 @@ Example Response { "meta": { - "previous": null, - "total_count": 66, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/ionchefplantemplate/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/ionchefplantemplate/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 89 + }, "objects": [ { - "planDisplayedName": "Ion AmpliSeq HD for Tumor - DNA and Fusions - Separate Libraries", - "autoAnalyze": true, - "endBarcodeKitName": "", - "templatingKitBarcode": null, - "preAnalysis": true, - "thumbnailanalysisargs": "", - "applicationGroup": "/rundb/api/v1/applicationgroup/5/", - "mixedTypeRNA_hotSpotRegionBedFile": null, - "mixedTypeRNA_targetRegionBedFile": null, - "platform": "S5", - "categories": "onco_solidTumor;onco_heme;", - "planPGM": "", - "prebasecallerargs": "", - "alignmentargs": "", - "thumbnailbasecallerargs": "", - "libkit": null, - "projects": [], - "notes": "", - "sequencekitname": "Ion S5 Sequencing Kit", - "base_recalibration_mode": "standard_recal", - "storageHost": null, - "expName": "", - "thumbnailionstatsargs": "", - "cycles": null, - "isReverseRun": false, - "storage_options": "A", - "thumbnailalignmentargs": "", - "chipType": "540", - "library": "hg19", - "runMode": "single", - "sampleTubeLabel": null, - "seqKitBarcode": null, - "barcodeId": "Ion AmpliSeq HD Dual Barcode Kit 1-24", - "isPlanGroup": false, - "realign": false, - "sampleGroupingName": "DNA and Fusions", - "experiment": "/rundb/api/v1/experiment/134/", - "bedfile": "", - "applicationCategoryDisplayedName": "Oncology - Solid Tumor | Oncology - HemeOnc", - "isReusable": true, - "isDuplicateReads": false, - "sampleSets": [], - "thumbnailbeadfindargs": "", - "librarykitname": "Ion AmpliSeq HD Library Kit", - "sseBedFile": "", - "adapter": null, - "basecallerargs": "", - "earlyDatFileDeletion": false, - "parentPlan": null, - "origin": "|5.10.0.RC4", - "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC", - "planStatus": "planned", - "isCustom_kitSettings": false, - "samplePrepKitName": null, - "applicationGroupDisplayedName": "DNA and Fusions (Separate Libraries)", - "metaData": {}, - "isFavorite": false, + "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": [ { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/141/", - "id": 400, + "id": 487, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Bead Loading (%)", - "id": 1, + "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/400/" - }, + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/487/", + "threshold": 30 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/141/", - "id": 401, + "id": 488, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 1, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Key Signal (1-100)", - "id": 2, + "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/401/" - }, + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/488/", + "threshold": 30 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/141/", - "id": 402, + "id": 489, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Usable Sequence (%)", - "id": 3, + "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/402/" - } - ], - "analysisargs": "", - "thumbnailcalibrateargs": "", - "templatingKitName": "Ion Chef S540 V1", - "runType": "AMPS_HD_DNA_RNA", - "username": null, - "planShortID": "A628Z", - "sampleDisplayedName": "", - "prethumbnailbasecallerargs": "", - "controlSequencekitname": null, - "tfKey": "ATCG", - "mixedTypeRNA_reference": null, - "childPlans": [], - "pairedEndLibraryAdapterName": null, - "reverselibrarykey": "", - "irworkflow": "", - "planExecuted": false, - "project": "", - "usePostBeadfind": false, - "libraryReadLength": 200, - "runname": null, - "chefInfo": {}, - "planGUID": "e52fac66-4086-433e-b8e7-ad1d1403946f", - "ionstatsargs": "", - "samplePrepProtocol": "", - "sample": "", - "planExecutedDate": null, - "reverse_primer": null, - "id": 141, - "barcodedSamples": {}, - "custom_args": false, - "regionfile": "", - "selectedPlugins": { - "coverageAnalysis": { - "userInput": {}, - "version": "5.8.0.8", - "features": [], - "name": "coverageAnalysis", - "id": 41 - }, - "variantCaller": { - "userInput": { - "meta": { - "configuration": "ampliseq_hd_ffpe" - } - }, - "version": "5.8.0.19", - "features": [], - "name": "variantCaller", - "id": 36 + }, + "resource_uri": "/rundb/api/v1/plannedexperimentqc/489/", + "threshold": 30 } - }, - "beadfindargs": "", - "isSystemDefault": false, - "autoName": null, - "libraryKey": "TCAG", - "flows": 500, - "date": "2018-04-12T05:54:10.000222+00:00", - "isSystem": true, - "variantfrequency": "", - "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA_and_Fusions_-_Separate_Libraries", - "calibrateargs": "", - "flowsInOrder": "", - "libraryPrepType": "", - "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/6/", - "chipBarcode": "", - "sampleSetDisplayedName": "", - "usePreBeadfind": true, - "resource_uri": "/rundb/api/v1/ionchefplantemplate/141/", - "libraryPrepTypeDisplayedName": "", - "reverse3primeadapter": "" + ], + "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": "" } ] } diff --git a/source/api/references_auto_generated/ionchefplantemplatesummary.rst b/source/api/references_auto_generated/ionchefplantemplatesummary.rst index d0bf353..5fb20ee 100644 --- a/source/api/references_auto_generated/ionchefplantemplatesummary.rst +++ b/source/api/references_auto_generated/ionchefplantemplatesummary.rst @@ -15,97 +15,97 @@ Resource Fields =============================== ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =============================== ==================================================== ======= ======== ======== ===== ====== ======== -**origin** Unicode string data. Ex: "Hello World" true false false false string +**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**autoName** 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 +**categories** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storage_options** Unicode string data. Ex: "Hello World" A false false false false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**expName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**isFavorite** 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 +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitName** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planDisplayedName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**planGUID** 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 +**planName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**reverse_primer** 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 +**runMode** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string +**runname** 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 +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** Boolean data. Ex: True true false false true false boolean +**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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string -------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** Unicode string data. Ex: "Hello World" n/a true false false false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePreBeadfind** Boolean data. Ex: True true false false true false boolean +**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string +**usePostBeadfind** Boolean data. Ex: True true false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**usePreBeadfind** 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 +**username** Unicode string data. Ex: "Hello World" n/a true false false false string =============================== ==================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -115,60 +115,60 @@ Example Response { "meta": { - "previous": null, - "total_count": 66, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/ionchefplantemplatesummary/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/ionchefplantemplatesummary/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 89 + }, "objects": [ { - "origin": "|5.10.0.RC4", - "isReverseRun": false, - "planDisplayedName": "Ion AmpliSeq HD for Tumor - DNA and Fusions - Separate Libraries", - "storage_options": "A", - "preAnalysis": true, - "planShortID": "A628Z", - "planStatus": "planned", - "runMode": "single", - "isCustom_kitSettings": false, - "sampleTubeLabel": null, - "planExecutedDate": null, - "samplePrepKitName": null, - "reverse_primer": null, - "seqKitBarcode": null, - "id": 141, - "metaData": {}, - "isFavorite": false, - "samplePrepProtocol": "", - "isPlanGroup": false, - "templatingKitName": "Ion Chef S540 V1", - "runType": "AMPS_HD_DNA_RNA", - "templatingKitBarcode": null, - "planPGM": "", - "isSystemDefault": false, - "autoName": null, - "isReusable": true, - "controlSequencekitname": null, - "date": "2018-04-12T05:54:10.000222+00:00", - "isSystem": true, - "libkit": null, - "categories": "onco_solidTumor;onco_heme;", - "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA_and_Fusions_-_Separate_Libraries", - "pairedEndLibraryAdapterName": null, - "adapter": null, - "irworkflow": "", - "planExecuted": false, - "username": null, - "usePostBeadfind": false, - "storageHost": null, - "expName": "", - "libraryReadLength": 200, - "runname": null, - "usePreBeadfind": true, - "planGUID": "e52fac66-4086-433e-b8e7-ad1d1403946f", - "cycles": null, - "resource_uri": "/rundb/api/v1/ionchefplantemplatesummary/141/" + "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 } ] } diff --git a/source/api/references_auto_generated/ionchefprepkitinfo.rst b/source/api/references_auto_generated/ionchefprepkitinfo.rst index edab76e..55f1e62 100644 --- a/source/api/references_auto_generated/ionchefprepkitinfo.rst +++ b/source/api/references_auto_generated/ionchefprepkitinfo.rst @@ -15,45 +15,45 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** 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 +**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 @@ -63,41 +63,47 @@ Example Response { "meta": { - "previous": null, - "total_count": 14, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/ionchefprepkitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/ionchefprepkitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 13 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "IC", - "kitType": "IonChefPrepKit", - "description": "Precision ID Chef Reagents", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "S5", - "chipTypes": "510;520;530", - "runMode": "", + "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": "A32882C", - "id": 20246, - "resource_uri": "/rundb/api/v1/kitpart/20246/", - "kit": "/rundb/api/v1/kitinfo/20106/" + "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/" } - ], - "flowCount": 0, - "applicationType": "AMPS", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/ionchefprepkitinfo/20106/", - "uid": "ICPREP0011", - "id": 20106, - "categories": "filter_s5HidKit;samplePrepProtocol;s5hidSamplePrep", - "name": "Ion Chef HID S530 V2" + ], + "resource_uri": "/rundb/api/v1/ionchefprepkitinfo/20113/", + "runMode": "", + "samplePrep_instrumentType": "IC", + "uid": "ICPREP0014" } ] } diff --git a/source/api/references_auto_generated/ionmeshnode.rst b/source/api/references_auto_generated/ionmeshnode.rst index ac062c5..d478183 100644 --- a/source/api/references_auto_generated/ionmeshnode.rst +++ b/source/api/references_auto_generated/ionmeshnode.rst @@ -15,21 +15,21 @@ 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 ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true 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 ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**system_id** Unicode string data. Ex: "Hello World" n/a false false false true string ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**active** Boolean data. Ex: True true false false true false boolean ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**apikey_remote** Unicode string data. Ex: "Hello World" n/a 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 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 @@ -39,22 +39,22 @@ Example Response { "meta": { - "previous": null, - "total_count": 1, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": "/rundb/api/v1/ionmeshnode/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 4 + }, "objects": [ { - "apikey_local": "2ef92cb0069d1d1b156fa081ec1717807c1cd105", - "resource_uri": "/rundb/api/v1/ionmeshnode/4/", - "hostname": "tsvm.itw", - "system_id": "tsvm", - "active": true, - "apikey_remote": "f45e8c2251095469140a12bf47349d72c68422e9", - "id": 4, - "name": "" + "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" } ] } diff --git a/source/api/references_auto_generated/kitinfo.rst b/source/api/references_auto_generated/kitinfo.rst index a299604..1d5146c 100644 --- a/source/api/references_auto_generated/kitinfo.rst +++ b/source/api/references_auto_generated/kitinfo.rst @@ -15,47 +15,47 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** 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 +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**name** Unicode string data. Ex: "Hello World" n/a false false false true string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**defaultFlowOrder** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** 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 @@ -65,48 +65,42 @@ Example Response { "meta": { - "previous": null, - "total_count": 114, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/kitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/kitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 113 + }, "objects": [ { - "isActive": false, - "samplePrep_instrumentType": "", - "kitType": "ControlSequenceKit", - "defaultFlowOrder": null, - "name": "Ion PGM Controls Kit v2", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "pgm", - "chipTypes": "", - "runMode": "", + "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": "4482010", - "id": 20072, - "resource_uri": "/rundb/api/v1/kitpart/20072/", - "kit": "/rundb/api/v1/kitinfo/20037/" - }, - { - "barcode": "4482011", - "id": 20073, - "resource_uri": "/rundb/api/v1/kitpart/20073/", - "kit": "/rundb/api/v1/kitinfo/20037/" + "barcode": "A43587", + "id": 20269, + "kit": "/rundb/api/v1/kitinfo/20118/", + "resource_uri": "/rundb/api/v1/kitpart/20269/" } - ], - "flowCount": 0, - "applicationType": "", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/kitinfo/20037/", - "uid": "CONSEQ0003", - "id": 20037, - "categories": "", - "description": "Ion PGM Controls Kit v2" + ], + "resource_uri": "/rundb/api/v1/kitinfo/20118/", + "runMode": "", + "samplePrep_instrumentType": "", + "uid": "LIB0030" } ] } diff --git a/source/api/references_auto_generated/kitpart.rst b/source/api/references_auto_generated/kitpart.rst index 355b9ca..cf91f6b 100644 --- a/source/api/references_auto_generated/kitpart.rst +++ b/source/api/references_auto_generated/kitpart.rst @@ -19,9 +19,9 @@ field help text ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- **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 ----------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- **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 @@ -31,18 +31,18 @@ Example Response { "meta": { - "previous": null, - "total_count": 263, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/kitpart/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/kitpart/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 253 + }, "objects": [ { - "barcode": "100020580", - "id": 20086, - "resource_uri": "/rundb/api/v1/kitpart/20086/", - "kit": "/rundb/api/v1/kitinfo/20042/" + "barcode": "A43587", + "id": 20269, + "kit": "/rundb/api/v1/kitinfo/20118/", + "resource_uri": "/rundb/api/v1/kitpart/20269/" } ] } diff --git a/source/api/references_auto_generated/libmetrics.rst b/source/api/references_auto_generated/libmetrics.rst index 0395bb4..3594848 100644 --- a/source/api/references_auto_generated/libmetrics.rst +++ b/source/api/references_auto_generated/libmetrics.rst @@ -15,201 +15,201 @@ Resource Fields ============================= ============================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================= ============================================================================== ======= ======== ======== ===== ====== ======= -**i350Q17_reads** Integer data. Ex: 2673 n/a false false false false integer +**Genome_Version** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i150Q47_reads** Integer data. Ex: 2673 n/a false false false false integer +**Index_Version** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i300Q47_reads** Integer data. Ex: 2673 n/a false false false false integer +**align_sample** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i600Q20_reads** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i300Q20_reads** Integer data. Ex: 2673 n/a false false false false integer +**cf** Floating point numeric data. Ex: 26.73 n/a false false false false float ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i250Q17_reads** Integer data. Ex: 2673 n/a false false false false integer +**dr** Floating point numeric data. Ex: 26.73 n/a false false false false float ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q10_longest_alignment** Integer data. Ex: 2673 n/a false false false false integer +**duplicate_reads** Integer data. Ex: 2673 n/a true false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i50Q10_reads** Integer data. Ex: 2673 n/a false false false false integer +**genome** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**aveKeyCounts** Floating point numeric data. Ex: 26.73 n/a false false false false float +**genomesize** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i50Q17_reads** Integer data. Ex: 2673 n/a false false false false integer +**i100Q10_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**total_mapped_target_bases** Unicode string data. Ex: "Hello World" n/a false false false false string +**i100Q17_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 +**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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i50Q20_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i450Q7_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**genomesize** Unicode string data. Ex: "Hello World" n/a false false false false string +**i150Q17_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 +**i150Q20_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 +**i150Q47_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 +**i150Q7_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**dr** Floating point numeric data. Ex: 26.73 n/a false false false false float +**i200Q10_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 +**i200Q17_reads** 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 +**i200Q20_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 +**i200Q47_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 +**i200Q7_reads** 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 +**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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q47_longest_alignment** Integer data. Ex: 2673 n/a false false false false integer +**i250Q7_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 +**i300Q10_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 +**i300Q17_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 +**i300Q20_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 +**i300Q47_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q47_alignments** Integer data. Ex: 2673 n/a false false false false integer +**i300Q7_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**align_sample** Integer data. Ex: 2673 n/a false false false false integer +**i350Q10_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i100Q10_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i100Q7_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i400Q17_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i500Q47_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i450Q20_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q7_mean_alignment_length** Integer data. Ex: 2673 n/a false false false false integer +**i400Q20_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q7_alignments** Integer data. Ex: 2673 n/a false false false false integer +**i400Q47_reads** 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 +**i400Q7_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 +**i450Q10_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 +**i450Q17_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**cf** Floating point numeric data. Ex: 26.73 n/a false false false false float +**i450Q20_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 +**i450Q47_reads** 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 +**i450Q7_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 +**i500Q10_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**duplicate_reads** Integer data. Ex: 2673 n/a true false false false integer +**i500Q17_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 +**i500Q20_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**totalNumReads** Integer data. Ex: 2673 n/a false false false false integer +**i500Q47_reads** 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 +**i500Q7_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 +**i50Q10_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 +**i50Q17_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q20_mean_alignment_length** Integer data. Ex: 2673 n/a false false false false integer +**i50Q20_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 +**i50Q47_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 +**i50Q7_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 +**i550Q10_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 +**i550Q17_reads** 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 +**i550Q20_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 +**i550Q47_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**Genome_Version** Unicode string data. Ex: "Hello World" n/a false false false false string +**i550Q7_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 +**i600Q10_reads** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q10_alignments** Integer data. Ex: 2673 n/a false false false false integer +**i600Q17_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 +**i600Q20_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 +**i600Q47_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 +**i600Q7_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 +**id** Integer data. Ex: 2673 false false true true integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i400Q47_reads** Integer data. Ex: 2673 n/a false false false false integer +**ie** Floating point numeric data. Ex: 26.73 n/a false false false false float ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q17_longest_alignment** Integer data. Ex: 2673 n/a false false false false integer +**q10_alignments** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i150Q7_reads** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i400Q10_reads** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**raw_accuracy** Floating point numeric data. Ex: 26.73 n/a false false false false float +**q17_alignments** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**sysSNR** Floating point numeric data. Ex: 26.73 n/a false false false false float +**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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**Index_Version** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i300Q17_reads** Integer data. Ex: 2673 n/a false false false false integer ------------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- **q17_mean_alignment_length** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**ie** Floating point numeric data. Ex: 26.73 n/a false false false false float +**q20_alignments** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true integer +**q20_longest_alignment** 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_mapped_bases** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q47_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**genome** Unicode string data. Ex: "Hello World" n/a false false false false string +**q47_alignments** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i300Q7_reads** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i150Q20_reads** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i550Q47_reads** Integer data. Ex: 2673 n/a false false false false integer +**q47_mean_alignment_length** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i600Q47_reads** Integer data. Ex: 2673 n/a false false false false integer +**q7_alignments** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i100Q17_reads** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q47_mean_alignment_length** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i50Q7_reads** Integer data. Ex: 2673 n/a false false false false integer +**q7_mean_alignment_length** Integer data. Ex: 2673 n/a false false false false integer ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i600Q7_reads** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i600Q17_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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q17_alignments** 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 ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i500Q17_reads** Integer data. Ex: 2673 n/a false false false false integer +**sysSNR** Floating point numeric data. Ex: 26.73 n/a false false false false float ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i150Q10_reads** Integer data. Ex: 2673 n/a false false false false integer +**totalNumReads** 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 +**total_mapped_reads** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**i200Q20_reads** Integer data. Ex: 2673 n/a false false false false integer +**total_mapped_target_bases** Unicode string data. Ex: "Hello World" n/a false false false false string ============================= ============================================================================== ======= ======== ======== ===== ====== ======= Example Response @@ -219,112 +219,112 @@ Example Response { "meta": { - "previous": null, - "total_count": 6, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/libmetrics/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/libmetrics/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 6 + }, "objects": [ { - "i350Q17_reads": 0, - "i150Q47_reads": 0, - "i300Q47_reads": 0, - "i600Q20_reads": 0, - "i300Q20_reads": 0, - "i250Q17_reads": 0, - "q10_longest_alignment": 0, - "i50Q10_reads": 0, - "aveKeyCounts": 88, - "i50Q17_reads": 0, - "total_mapped_target_bases": "0", - "i200Q7_reads": 0, - "i100Q47_reads": 0, - "i50Q20_reads": 0, - "i450Q7_reads": 0, - "genomesize": "0", - "i550Q20_reads": 0, - "report": "/rundb/api/v1/results/3/", - "i450Q47_reads": 0, - "dr": 0.168037705589086, - "i150Q17_reads": 0, - "q7_mapped_bases": "0", - "i350Q7_reads": 0, - "i500Q20_reads": 0, - "q20_mapped_bases": "0", - "i250Q47_reads": 0, - "q47_longest_alignment": 0, - "i550Q17_reads": 0, - "i50Q47_reads": 0, - "i200Q17_reads": 0, - "i250Q20_reads": 0, - "q47_alignments": 0, - "align_sample": -1, - "i100Q10_reads": 0, - "i350Q20_reads": 0, - "i100Q7_reads": 0, - "i400Q17_reads": 0, - "i500Q47_reads": 0, - "i450Q20_reads": 0, - "q7_mean_alignment_length": 0, - "q7_alignments": 0, - "total_mapped_reads": "0", - "i600Q10_reads": 0, - "i250Q10_reads": 0, - "cf": 0.603865925222635, - "i500Q7_reads": 0, - "q10_mapped_bases": "0", - "i550Q7_reads": 0, - "duplicate_reads": null, - "i350Q47_reads": 0, - "totalNumReads": 93969124, - "resource_uri": "/rundb/api/v1/libmetrics/1/", - "i350Q10_reads": 0, - "i300Q10_reads": 0, - "q20_mean_alignment_length": 0, - "i250Q7_reads": 0, - "i200Q10_reads": 0, - "i400Q7_reads": 0, - "i200Q47_reads": 0, - "q7_longest_alignment": 0, - "i500Q10_reads": 0, - "Genome_Version": "None", - "i400Q20_reads": 0, - "q10_alignments": 0, - "i450Q17_reads": 0, - "i100Q20_reads": 0, - "i550Q10_reads": 0, - "i450Q10_reads": 0, - "i400Q47_reads": 0, - "q17_longest_alignment": 0, - "i150Q7_reads": 0, - "i400Q10_reads": 0, - "q10_mean_alignment_length": 0, - "raw_accuracy": 0, - "sysSNR": 0.103568483421323, - "q17_mapped_bases": "0", - "Index_Version": "None", - "i300Q17_reads": 0, - "q17_mean_alignment_length": 0, - "ie": 0.465626595541835, - "id": 1, - "q20_alignments": 0, - "q47_mapped_bases": "0", - "genome": "None", - "i300Q7_reads": 0, - "i150Q20_reads": 0, - "i550Q47_reads": 0, - "i600Q47_reads": 0, - "i100Q17_reads": 0, - "q47_mean_alignment_length": 0, - "i50Q7_reads": 0, - "i600Q7_reads": 0, - "i600Q17_reads": 0, - "q17_alignments": 0, - "i500Q17_reads": 0, - "i150Q10_reads": 0, - "q20_longest_alignment": 0, - "i200Q20_reads": 0 + "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" } ] } diff --git a/source/api/references_auto_generated/librarykey.rst b/source/api/references_auto_generated/librarykey.rst index 77d3b21..c4ecbf0 100644 --- a/source/api/references_auto_generated/librarykey.rst +++ b/source/api/references_auto_generated/librarykey.rst @@ -15,21 +15,21 @@ Resource Fields ================ ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================ ====================================== ======= ======== ======== ===== ====== ======= -**direction** Unicode string data. Ex: "Hello World" Forward false false false false string ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**name** Unicode string data. Ex: "Hello World" n/a false false false true string ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**sequence** Unicode string data. Ex: "Hello World" n/a false false false false string ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **description** Unicode string data. Ex: "Hello World" false false true false string ---------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" single 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 @@ -39,22 +39,22 @@ Example Response { "meta": { - "previous": null, - "total_count": 3, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/librarykey/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/librarykey/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 3 + }, "objects": [ { - "direction": "Forward", - "name": "Ion TCAG", - "sequence": "TCAG", - "description": "Default forward library key", - "runMode": "single", - "id": 1, - "isDefault": true, - "resource_uri": "/rundb/api/v1/librarykey/1/" + "description": "Ion TCAGT", + "direction": "Forward", + "id": 3, + "isDefault": false, + "name": "Ion TCAGT", + "resource_uri": "/rundb/api/v1/librarykey/3/", + "runMode": "single", + "sequence": "TCAGT" } ] } diff --git a/source/api/references_auto_generated/librarykitinfo.rst b/source/api/references_auto_generated/librarykitinfo.rst index 62a48f9..e45e534 100644 --- a/source/api/references_auto_generated/librarykitinfo.rst +++ b/source/api/references_auto_generated/librarykitinfo.rst @@ -15,45 +15,45 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** 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 +**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 @@ -63,34 +63,41 @@ Example Response { "meta": { - "previous": null, - "total_count": 27, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/librarykitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/librarykitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 29 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "", - "kitType": "LibraryKit", - "description": "MuSeek Library Preparation Kit", - "nucleotideType": "dna", - "defaultCartridgeUsageCount": null, - "instrumentType": "", - "chipTypes": "", - "runMode": "", - "parts": [], - "flowCount": 0, - "applicationType": "GENS", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/librarykitinfo/20025/", - "uid": "LIB0012", - "id": 20025, - "categories": "filter_muSeek", - "name": "MuSeek(tm) Library Preparation Kit" + "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" } ] } diff --git a/source/api/references_auto_generated/librarykitpart.rst b/source/api/references_auto_generated/librarykitpart.rst index 71c833f..86614c1 100644 --- a/source/api/references_auto_generated/librarykitpart.rst +++ b/source/api/references_auto_generated/librarykitpart.rst @@ -19,9 +19,9 @@ field help text ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- **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 ----------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- **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 @@ -31,18 +31,18 @@ Example Response { "meta": { - "previous": null, - "total_count": 35, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/librarykitpart/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/librarykitpart/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 37 + }, "objects": [ { - "barcode": "A31204", - "id": 20243, - "resource_uri": "/rundb/api/v1/librarykitpart/20243/", - "kit": "/rundb/api/v1/kitinfo/20103/" + "barcode": "A43587", + "id": 20269, + "kit": "/rundb/api/v1/kitinfo/20118/", + "resource_uri": "/rundb/api/v1/librarykitpart/20269/" } ] } diff --git a/source/api/references_auto_generated/location.rst b/source/api/references_auto_generated/location.rst index a66b583..df1777a 100644 --- a/source/api/references_auto_generated/location.rst +++ b/source/api/references_auto_generated/location.rst @@ -15,15 +15,15 @@ Resource Fields =================== ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type =================== ====================================== ======= ======== ======== ===== ====== ======= -**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 +**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 ------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**comments** 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 false string +------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- +**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string =================== ====================================== ======= ======== ======== ===== ====== ======= Example Response @@ -33,19 +33,19 @@ Example Response { "meta": { - "previous": null, - "total_count": 2, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/location/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/location/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "name": "Disabled", - "resource_uri": "/rundb/api/v1/location/2/", - "defaultlocation": false, - "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.", - "id": 2 + "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/" } ] } diff --git a/source/api/references_auto_generated/log.rst b/source/api/references_auto_generated/log.rst index 81f3783..e849627 100644 --- a/source/api/references_auto_generated/log.rst +++ b/source/api/references_auto_generated/log.rst @@ -15,15 +15,15 @@ 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 ----------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**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 ================ ============================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -33,12 +33,12 @@ Example Response { "meta": { - "previous": null, - "total_count": 0, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 0 + }, "objects": [] } diff --git a/source/api/references_auto_generated/message.rst b/source/api/references_auto_generated/message.rst index c954ba0..bb96fa4 100644 --- a/source/api/references_auto_generated/message.rst +++ b/source/api/references_auto_generated/message.rst @@ -17,21 +17,21 @@ field help text default nu ================ ==================================================== ======= ======== ======== ===== ====== ======== **body** Unicode string data. Ex: "Hello World" false false true false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**status** Unicode string data. Ex: "Hello World" unread false false true false string +**expires** Unicode string data. Ex: "Hello World" read false false true false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**level** Integer data. Ex: 2673 20 false false false false integer +**id** Integer data. Ex: 2673 false false true true integer ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**route** Unicode string data. Ex: "Hello World" false false true false string +**level** Integer data. Ex: 2673 20 false false false false integer ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expires** Unicode string data. Ex: "Hello World" read false false true false string +**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**time** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime +**route** Unicode string data. Ex: "Hello World" false false true false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**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 ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string +**time** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ================ ==================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -41,25 +41,13 @@ Example Response { "meta": { - "previous": null, - "total_count": 1, - "offset": 0, - "limit": 1, - "next": null - }, - "objects": [ - { - "body": "There is an update available for your Torrent Server. Update Now", - "status": "unread", - "level": 20, - "route": "_StaffOnly", - "expires": "read", - "time": "2018-06-15T18:51:37.000649+00:00", - "id": 40, - "tags": "new-upgrade", - "resource_uri": "/rundb/api/v1/message/40/" - } - ] + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 0 + }, + "objects": [] } Allowed list HTTP methods diff --git a/source/api/references_auto_generated/monitordata.rst b/source/api/references_auto_generated/monitordata.rst index cd7f8cd..3a328bd 100644 --- a/source/api/references_auto_generated/monitordata.rst +++ b/source/api/references_auto_generated/monitordata.rst @@ -15,13 +15,13 @@ Resource Fields ================ ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================ ====================================== ======= ======== ======== ===== ====== ======= -**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 ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **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 @@ -31,12 +31,12 @@ Example Response { "meta": { - "previous": null, - "total_count": 0, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 0 + }, "objects": [] } diff --git a/source/api/references_auto_generated/monitorresult.rst b/source/api/references_auto_generated/monitorresult.rst index 869a6c0..325d91c 100644 --- a/source/api/references_auto_generated/monitorresult.rst +++ b/source/api/references_auto_generated/monitorresult.rst @@ -15,41 +15,43 @@ Resource Fields =================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**status** Unicode string data. Ex: "Hello World" n/a false false false false string -------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**processedflows** Integer data. Ex: 2673 n/a false false false false integer +**analysismetrics** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libmetrics** 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**timeStamp** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime +**barcodeId** Unicode string data. Ex: "Hello World" n/a true true false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**analysismetrics** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**eas** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reportLink** Unicode string data. Ex: "Hello World" n/a false false false false string +**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**library** Unicode string data. Ex: "Hello World" n/a true true false false string +**i18nstatus** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **id** Integer data. Ex: 2673 false false true true integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reportStatus** Unicode string data. Ex: "Hello World" Nothing true false false false string +**libmetrics** A single related resource. Can be either a URI or set of nested resource data. n/a true 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 +**library** Unicode string data. Ex: "Hello World" n/a true true false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultsName** Unicode string data. Ex: "Hello World" n/a false false 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**eas** A single related resource. Can be either a URI or set of nested resource data. n/a false 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodeId** Unicode string data. Ex: "Hello World" n/a true true false false string +**resultsName** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoExempt** Boolean data. Ex: True false false false true false boolean +**status** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**representative** Boolean data. Ex: True false false false true false boolean +**timeStamp** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime =================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -59,12 +61,12 @@ Example Response { "meta": { - "previous": null, - "total_count": 0, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 0 + }, "objects": [] } diff --git a/source/api/references_auto_generated/network.rst b/source/api/references_auto_generated/network.rst index a1e5b73..dfc580e 100644 --- a/source/api/references_auto_generated/network.rst +++ b/source/api/references_auto_generated/network.rst @@ -30,9 +30,9 @@ Example Response .. code-block:: javascript { - "eth_device": true, - "external_ip": "12.27.71.34", - "internal_ip": "10.45.2.119", + "eth_device": true, + "external_ip": "12.27.71.34", + "internal_ip": "10.45.2.119", "route": true } diff --git a/source/api/references_auto_generated/onetouchplantemplate.rst b/source/api/references_auto_generated/onetouchplantemplate.rst index 0db73a7..4fbddab 100644 --- a/source/api/references_auto_generated/onetouchplantemplate.rst +++ b/source/api/references_auto_generated/onetouchplantemplate.rst @@ -15,193 +15,193 @@ Resource Fields ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**planDisplayedName** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean +**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodeId** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**platform** Unicode string data. Ex: "Hello World" n/a 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string +**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string +**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**chipBarcode** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" true false true false string +**chipType** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**base_recalibration_mode** Unicode string data. Ex: "Hello World" true false true false string +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storageHost** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string +**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**expName** 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 +**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" false false false false string +**flows** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**library** Unicode string data. Ex: "Hello World" true false true false string +**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string +**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**id** Integer data. Ex: 2673 false false true true integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodeId** Unicode string data. Ex: "Hello World" true false true false string +**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**realign** Boolean data. Ex: True n/a false false false false boolean +**isFavorite** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**bedfile** Unicode string data. Ex: "Hello World" false false true false string +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean +**libkit** Unicode string data. Ex: "Hello World" n/a 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 +**library** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**librarykitname** Unicode string data. Ex: "Hello World" true false true false string +**libraryKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string +**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string +**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string +**librarykitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**origin** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string +**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean +**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**notes** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**planDisplayedName** 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 +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**tfKey** Unicode string data. Ex: "Hello World" false false true false string +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string +**platform** Unicode string data. Ex: "Hello World" n/a true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string +**project** Unicode string data. Ex: "Hello World" n/a false true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** Unicode string data. Ex: "Hello World" false false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**irworkflow** Unicode string data. Ex: "Hello World" false false true false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**realign** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**project** Unicode string data. Ex: "Hello World" n/a false true true false string +**regionfile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict +**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**runType** Unicode string data. Ex: "Hello World" GENS false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** Unicode string data. Ex: "Hello World" n/a true 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**regionfile** Unicode string data. Ex: "Hello World" false false true false string +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string +**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoName** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryKey** Unicode string data. Ex: "Hello World" false false true false string +**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flows** Integer data. Ex: 2673 0 false false false false integer +**seqKitBarcode** 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 +**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string +**storageHost** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string +**templatingKitName** 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 +**tfKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipBarcode** Unicode string data. Ex: "Hello World" false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string -------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string +**username** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string +**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -211,304 +211,304 @@ Example Response { "meta": { - "previous": null, - "total_count": 37, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/onetouchplantemplate/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/onetouchplantemplate/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 36 + }, "objects": [ { - "planDisplayedName": "PGx Research Panel", - "autoAnalyze": true, - "endBarcodeKitName": "", - "templatingKitBarcode": null, - "preAnalysis": true, - "thumbnailanalysisargs": "", - "applicationGroup": "/rundb/api/v1/applicationgroup/6/", - "mixedTypeRNA_hotSpotRegionBedFile": null, - "mixedTypeRNA_targetRegionBedFile": null, - "platform": "PGM", - "categories": "", - "planPGM": null, - "prebasecallerargs": "", - "alignmentargs": "", - "thumbnailbasecallerargs": "", - "libkit": null, - "projects": [], - "notes": "", - "sequencekitname": "IonPGMHiQ", - "base_recalibration_mode": "standard_recal", - "storageHost": null, - "expName": "", - "thumbnailionstatsargs": "", - "cycles": null, - "isReverseRun": false, - "storage_options": "A", - "thumbnailalignmentargs": "", - "chipType": "", - "library": "hg19", - "runMode": "", - "sampleTubeLabel": null, - "seqKitBarcode": null, - "barcodeId": "IonXpress", - "isPlanGroup": false, - "realign": false, - "sampleGroupingName": "", - "experiment": "/rundb/api/v1/experiment/122/", - "bedfile": "/results/uploads/BED/5/hg19/unmerged/detail/PGx.20150728.designed.bed", - "applicationCategoryDisplayedName": "", - "isReusable": true, - "isDuplicateReads": false, - "sampleSets": [], - "thumbnailbeadfindargs": "", - "librarykitname": "Ion AmpliSeq 2.0 Library Kit", - "sseBedFile": "", - "adapter": null, - "basecallerargs": "", - "earlyDatFileDeletion": false, - "parentPlan": null, - "origin": "ampliseq.com|5.8.0", - "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC", - "planStatus": "planned", - "isCustom_kitSettings": false, - "samplePrepKitName": null, - "applicationGroupDisplayedName": "Pharmacogenomics", - "metaData": {}, - "isFavorite": false, - "qcValues": [], - "analysisargs": "", - "thumbnailcalibrateargs": "", - "templatingKitName": "Ion PGM Hi-Q OT2 Kit - 200", - "runType": "AMPS", - "username": "ionuser", - "planShortID": "OO9C5", - "sampleDisplayedName": "", - "prethumbnailbasecallerargs": "", - "controlSequencekitname": "", - "tfKey": "ATCG", - "mixedTypeRNA_reference": null, - "childPlans": [], - "pairedEndLibraryAdapterName": "", - "reverselibrarykey": "", - "irworkflow": "", - "planExecuted": false, - "project": "", - "usePostBeadfind": true, - "libraryReadLength": 0, - "runname": null, - "chefInfo": {}, - "planGUID": "7489c32d-d3ed-4cc1-a7a2-e59b819ea395", - "ionstatsargs": "", - "samplePrepProtocol": "", - "sample": "", - "planExecutedDate": null, - "reverse_primer": null, - "id": 130, - "barcodedSamples": {}, - "custom_args": false, - "regionfile": "/results/uploads/BED/15/hg19/unmerged/detail/PGx.20180131.hotspots.bed", + "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": { - "features": [], "ampliSeqVariantCallerConfig": { - "torrent_variant_caller": { - "snp_min_allele_freq": "0.1", - "snp_strand_bias": "0.95", - "hotspot_min_coverage": 6, - "hotspot_min_cov_each_strand": 3, - "position_bias": "0.75", - "hotspot_min_allele_freq": "0.1", - "snp_min_variant_score": 10, - "mnp_min_variant_score": 10, - "hotspot_strand_bias": "0.98", - "hp_max_length": 10, - "filter_insertion_predictions": "0.4", - "indel_min_variant_score": 10, - "indel_min_coverage": 15, - "heavy_tailed": 3, - "outlier_probability": "0.01", - "position_bias_ref_fraction": "0.05", - "indel_strand_bias_pval": 1, - "data_quality_stringency": "6.5", - "snp_min_cov_each_strand": 0, - "indel_as_hpindel": 0, - "snp_strand_bias_pval": 1, - "mnp_strand_bias": "0.95", - "mnp_strand_bias_pval": 1, - "process_input_positions_only": 1, - "hotspot_strand_bias_pval": "0.01", - "hotspot_min_variant_score": 4, - "do_mnp_realignment": 1, - "indel_strand_bias": "0.85", - "downsample_to_coverage": 4000, - "filter_unusual_predictions": "0.7", - "indel_min_allele_freq": "0.1", - "mnp_min_allele_freq": "0.1", - "mnp_min_coverage": 6, - "do_snp_realignment": 1, - "mnp_min_cov_each_strand": 0, - "snp_min_coverage": 6, - "prediction_precision": 1, - "indel_min_cov_each_strand": 5, - "filter_deletion_predictions": "0.2", - "realignment_threshold": 1, - "suppress_recalibration": 0, - "position_bias_pval": "0.05", - "use_position_bias": 0 - }, + "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": { - "repository_id": "", - "ts_version": "5.0", - "name": "PGx - Germ Line - Customized parameters", - "user_selections": { - "chip": "pgm", - "frequency": "germline", - "library": "ampliseq", - "panel": "/rundb/api/v1/contentupload/15/" - }, - "tooltip": "Panel-optimized parameters from AmpliSeq.com", - "tvcargs": "tvc --use-input-allele-only", - "built_in": true, - "configuration": "PGx_germline_low_stringency", + "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/" } - }, - "long_indel_assembler": { - "min_indel_size": 4, - "short_suffix_match": 5, - "output_mnv": 0, - "min_var_count": 5, - "min_var_freq": "0.15", - "kmer_len": 19, - "max_hp_length": 8, - "relative_strand_bias": "0.8" - }, - "freebayes": { - "gen_min_coverage": 10, - "allow_mnps": 1, - "allow_complex": 0, - "read_snp_limit": 10, - "read_max_mismatch_fraction": 1, - "allow_indels": 1, - "min_mapping_qv": 4, - "gen_min_alt_allele_freq": "0.15", - "allow_snps": 1, - "gen_min_indel_alt_allele_freq": "0.15" - } - }, - "userInput": { + }, "torrent_variant_caller": { - "snp_min_allele_freq": "0.1", - "snp_strand_bias": "0.95", - "hotspot_min_coverage": 6, - "hotspot_min_cov_each_strand": 3, - "position_bias": "0.75", - "hotspot_min_allele_freq": "0.1", - "snp_min_variant_score": 10, - "mnp_min_variant_score": 10, - "hotspot_strand_bias": "0.98", - "hp_max_length": 10, - "filter_insertion_predictions": "0.4", - "indel_min_variant_score": 10, - "indel_min_coverage": 15, - "heavy_tailed": 3, - "outlier_probability": "0.01", - "position_bias_ref_fraction": "0.05", - "indel_strand_bias_pval": 1, - "data_quality_stringency": "6.5", - "snp_min_cov_each_strand": 0, - "indel_as_hpindel": 0, - "snp_strand_bias_pval": 1, - "mnp_strand_bias": "0.95", - "mnp_strand_bias_pval": 1, - "process_input_positions_only": 1, - "hotspot_strand_bias_pval": "0.01", - "hotspot_min_variant_score": 4, - "do_mnp_realignment": 1, - "indel_strand_bias": "0.85", - "downsample_to_coverage": 4000, - "filter_unusual_predictions": "0.7", - "indel_min_allele_freq": "0.1", - "mnp_min_allele_freq": "0.1", - "mnp_min_coverage": 6, - "do_snp_realignment": 1, - "mnp_min_cov_each_strand": 0, - "snp_min_coverage": 6, - "prediction_precision": 1, - "indel_min_cov_each_strand": 5, - "filter_deletion_predictions": "0.2", - "realignment_threshold": 1, - "suppress_recalibration": 0, - "position_bias_pval": "0.05", + "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": { - "repository_id": "", - "ts_version": "5.0", - "name": "PGx - Germ Line - Customized parameters", - "user_selections": { - "chip": "pgm", - "frequency": "germline", - "library": "ampliseq", - "panel": "/rundb/api/v1/contentupload/15/" - }, - "tooltip": "Panel-optimized parameters from AmpliSeq.com", - "tvcargs": "tvc --use-input-allele-only", - "built_in": true, - "configuration": "PGx_germline_low_stringency", + "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/" } - }, - "long_indel_assembler": { - "min_indel_size": 4, - "short_suffix_match": 5, - "output_mnv": 0, - "min_var_count": 5, - "min_var_freq": "0.15", - "kmer_len": 19, - "max_hp_length": 8, - "relative_strand_bias": "0.8" - }, - "freebayes": { - "gen_min_coverage": 10, - "allow_mnps": 1, - "allow_complex": 0, - "read_snp_limit": 10, - "read_max_mismatch_fraction": 1, - "allow_indels": 1, - "min_mapping_qv": 4, - "gen_min_alt_allele_freq": "0.15", - "allow_snps": 1, - "gen_min_indel_alt_allele_freq": "0.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", - "id": 36, - "name": "variantCaller" + }, + "version": "5.8.0.19" } - }, - "beadfindargs": "", - "isSystemDefault": false, - "autoName": null, - "libraryKey": "TCAG", - "flows": 500, - "date": "2018-02-08T19:41:44.000698+00:00", - "isSystem": false, - "variantfrequency": "", - "planName": "PGx_Research_Panel", - "calibrateargs": "", - "flowsInOrder": "", - "libraryPrepType": "", - "sampleGrouping": null, - "chipBarcode": "", - "sampleSetDisplayedName": "", - "usePreBeadfind": true, - "resource_uri": "/rundb/api/v1/onetouchplantemplate/130/", - "libraryPrepTypeDisplayedName": "", - "reverse3primeadapter": "" + }, + "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": "" } ] } diff --git a/source/api/references_auto_generated/plannedexperiment.rst b/source/api/references_auto_generated/plannedexperiment.rst index f7651cc..7db30fb 100644 --- a/source/api/references_auto_generated/plannedexperiment.rst +++ b/source/api/references_auto_generated/plannedexperiment.rst @@ -15,193 +15,193 @@ Resource Fields ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**planDisplayedName** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean +**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**autoAnalyze** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodeId** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string +**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**platform** Unicode string data. Ex: "Hello World" n/a 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string +**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string +**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**chipBarcode** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" true false true false string +**chipType** Unicode string data. Ex: "Hello World" false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**base_recalibration_mode** Unicode string data. Ex: "Hello World" true false true false string +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storageHost** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string +**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**endBarcodeKitName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**expName** 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 +**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipType** Unicode string data. Ex: "Hello World" false false false false string +**flows** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**library** Unicode string data. Ex: "Hello World" true false true false string +**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string +**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**id** Integer data. Ex: 2673 false false true true integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodeId** Unicode string data. Ex: "Hello World" true false true false string +**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**realign** Boolean data. Ex: True n/a false false false false boolean +**isFavorite** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**bedfile** Unicode string data. Ex: "Hello World" false false true false string +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isDuplicateReads** Boolean data. Ex: True n/a false false false false boolean +**libkit** Unicode string data. Ex: "Hello World" n/a 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 +**library** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**librarykitname** Unicode string data. Ex: "Hello World" true false true false string +**libraryKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string +**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string +**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**earlyDatFileDeletion** Boolean data. Ex: True false false true false false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string +**librarykitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**origin** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**forward3primeadapter** Unicode string data. Ex: "Hello World" true false true false string +**mixedTypeRNA_hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean +**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**mixedTypeRNA_targetRegionBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**notes** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**planDisplayedName** 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 +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**tfKey** Unicode string data. Ex: "Hello World" false false true false string +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**mixedTypeRNA_reference** Unicode string data. Ex: "Hello World" true false true false string +**platform** Unicode string data. Ex: "Hello World" n/a true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false false string +**project** Unicode string data. Ex: "Hello World" n/a false true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** Unicode string data. Ex: "Hello World" false false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**irworkflow** Unicode string data. Ex: "Hello World" false false true false string +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**realign** Boolean data. Ex: True n/a false false false false boolean ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**project** Unicode string data. Ex: "Hello World" n/a false true true false string +**regionfile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chefInfo** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict +**reverselibrarykey** Unicode string data. Ex: "Hello World" false true false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**runType** Unicode string data. Ex: "Hello World" GENS false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** Unicode string data. Ex: "Hello World" n/a true 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**sampleDisplayedName** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**sampleGroupingName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**barcodedSamples** Unicode string data. Ex: "Hello World" true false true false string +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**regionfile** Unicode string data. Ex: "Hello World" false false true false string +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string +**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoName** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryKey** Unicode string data. Ex: "Hello World" false false true false string +**selectedPlugins** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flows** Integer data. Ex: 2673 0 false false false false integer +**seqKitBarcode** 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 +**sequencekitname** Unicode string data. Ex: "Hello World" true false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**sseBedFile** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string +**storageHost** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleSetDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**flowsInOrder** Unicode string data. Ex: "Hello World" true false true false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepType** Unicode string data. Ex: "Hello World" true true true false string +**templatingKitName** 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 +**tfKey** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**chipBarcode** Unicode string data. Ex: "Hello World" false 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 ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string -------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" true true true false string +**username** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse3primeadapter** Unicode string data. Ex: "Hello World" false true false false string +**variantfrequency** Unicode string data. Ex: "Hello World" false true false false string ===================================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -211,392 +211,169 @@ Example Response { "meta": { - "previous": null, - "total_count": 111, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/plannedexperiment/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/plannedexperiment/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 135 + }, "objects": [ { - "planDisplayedName": "Ion AmpliSeq HD for Tumor - DNA", - "autoAnalyze": true, - "endBarcodeKitName": "", - "templatingKitBarcode": null, - "preAnalysis": true, - "thumbnailanalysisargs": "Analysis --args-json /opt/ion/config/args_540_analysis.json --thumbnail true", - "applicationGroup": "/rundb/api/v1/applicationgroup/1/", - "mixedTypeRNA_hotSpotRegionBedFile": "", - "mixedTypeRNA_targetRegionBedFile": "", - "platform": "", - "categories": "onco_solidTumor;onco_heme;", - "planPGM": null, - "prebasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --max-phasing-levels 2 --wells-normalization on --read-structure AmpliseqHD --tag-filter-method need-prefix", - "alignmentargs": "tmap mapall -g 0 ... --context stage1 map4", - "thumbnailbasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --wells-normalization on --read-structure AmpliseqHD", - "libkit": null, - "projects": [], - "notes": "", - "sequencekitname": "Ion S5 Sequencing Kit", - "base_recalibration_mode": "standard_recal", - "storageHost": null, - "expName": "", - "thumbnailionstatsargs": "ionstats alignment", - "cycles": null, - "isReverseRun": false, - "storage_options": "A", - "thumbnailalignmentargs": "tmap mapall -g 0 ... --context stage1 map4", - "chipType": "540", - "library": "hg19", - "runMode": "single", - "sampleTubeLabel": "", - "seqKitBarcode": null, - "barcodeId": "Ion AmpliSeq HD Dual Barcode Kit 1-24", - "isPlanGroup": false, - "realign": false, - "sampleGroupingName": "Self", - "experiment": "/rundb/api/v1/experiment/136/", - "bedfile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "applicationCategoryDisplayedName": "Oncology - Solid Tumor | Oncology - HemeOnc", - "isReusable": false, - "isDuplicateReads": false, - "sampleSets": [], - "thumbnailbeadfindargs": "justBeadFind --args-json /opt/ion/config/args_540_beadfind.json --thumbnail true", - "librarykitname": "Ion AmpliSeq HD Library Kit", - "sseBedFile": "", - "adapter": null, - "basecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --max-phasing-levels 2 --num-unfiltered 1000 --barcode-filter-postpone 1 --wells-normalization on --read-structure AmpliseqHD", - "earlyDatFileDeletion": false, - "parentPlan": null, - "origin": "gui|5.10.0.RC4", - "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC", - "planStatus": "pending", - "isCustom_kitSettings": false, - "samplePrepKitName": null, - "applicationGroupDisplayedName": "DNA", - "metaData": { - "fromTemplate": "Ion_AmpliSeq_HD_for_Tumor_-_DNA", - "fromTemplateSource": "ION" - }, - "isFavorite": false, + "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": [ { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/143/", - "id": 407, + "id": 487, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 1, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Key Signal (1-100)", - "id": 2, - "resource_uri": "/rundb/api/v1/qctype/2/" - }, - "resource_uri": "/rundb/api/v1/plannedexperimentqc/407/" - }, + "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 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/143/", - "id": 408, + "id": 488, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Usable Sequence (%)", - "id": 3, - "resource_uri": "/rundb/api/v1/qctype/3/" - }, - "resource_uri": "/rundb/api/v1/plannedexperimentqc/408/" - }, + "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 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/143/", - "id": 406, + "id": 489, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Bead Loading (%)", - "id": 1, - "resource_uri": "/rundb/api/v1/qctype/1/" - }, - "resource_uri": "/rundb/api/v1/plannedexperimentqc/406/" - } - ], - "analysisargs": "Analysis --args-json /opt/ion/config/args_540_analysis.json", - "thumbnailcalibrateargs": "Calibration", - "templatingKitName": "Ion Chef S540 V1", - "runType": "AMPS_HD_DNA", - "username": "ionadmin", - "planShortID": "SP1XE", - "sampleDisplayedName": "", - "prethumbnailbasecallerargs": "BaseCaller --barcode-filter-minreads 10 --phasing-residual-filter=2.0 --wells-normalization on --read-structure AmpliseqHD --tag-filter-method need-prefix", - "controlSequencekitname": null, - "tfKey": "ATCG", - "mixedTypeRNA_reference": "", - "childPlans": [], - "pairedEndLibraryAdapterName": "", - "reverselibrarykey": "", - "irworkflow": "", - "planExecuted": false, - "project": "", - "usePostBeadfind": false, - "libraryReadLength": 200, - "runname": null, - "chefInfo": {}, - "planGUID": "1d75abf5-4d15-43f5-bb08-1c89d7344175", - "ionstatsargs": "ionstats alignment", - "samplePrepProtocol": "", - "sample": "", - "planExecutedDate": null, - "reverse_primer": null, - "id": 143, - "barcodedSamples": { - "Sample 10": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0110": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0110" - ] - }, - "Sample 8": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0108": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0108" - ] - }, - "Sample 9": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0109": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0109" - ] - }, - "Sample 6": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0106": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0106" - ] - }, - "Sample 7": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0107": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0107" - ] - }, - "Sample 4": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0104": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0104" - ] - }, - "Sample 5": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0105": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0105" - ] - }, - "Sample 2": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0102": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0102" - ] - }, - "Sample 3": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0103": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0103" - ] - }, - "Sample 1": { - "dualBarcodes": [], - "barcodeSampleInfo": { - "IonHDdual_0101": { - "description": "", - "reference": "hg19", - "targetRegionBedFile": "/results/uploads/BED/2/hg19/unmerged/detail/AmpliSeqExome.20141113.designed.bed", - "hotSpotRegionBedFile": "", - "nucleotideType": "DNA", - "controlSequenceType": "", - "externalId": "", - "endBarcode": "", - "controlType": "", - "sseBedFile": "" - } - }, - "barcodes": [ - "IonHDdual_0101" - ] - } - }, - "custom_args": false, - "regionfile": "", - "selectedPlugins": { - "coverageAnalysis": { - "userInput": {}, - "version": "5.8.0.8", - "features": [], - "name": "coverageAnalysis", - "id": 41 - }, - "variantCaller": { - "userInput": { - "meta": { - "configuration": "ampliseq_hd_ffpe" - } - }, - "version": "5.8.0.19", - "features": [], - "name": "variantCaller", - "id": 36 + "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 } - }, - "beadfindargs": "justBeadFind --args-json /opt/ion/config/args_540_beadfind.json", - "isSystemDefault": false, - "autoName": null, - "libraryKey": "TCAG", - "flows": 500, - "date": "2018-04-13T22:17:13.000108+00:00", - "isSystem": false, - "variantfrequency": "", - "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA", - "calibrateargs": "Calibration", - "flowsInOrder": "", - "libraryPrepType": "", - "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/2/", - "chipBarcode": "", - "sampleSetDisplayedName": "", - "usePreBeadfind": true, - "resource_uri": "/rundb/api/v1/plannedexperiment/143/", - "libraryPrepTypeDisplayedName": "", - "reverse3primeadapter": "" + ], + "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": "" } ] } diff --git a/source/api/references_auto_generated/plannedexperimentdb.rst b/source/api/references_auto_generated/plannedexperimentdb.rst index b7cc6e8..49d4d4c 100644 --- a/source/api/references_auto_generated/plannedexperimentdb.rst +++ b/source/api/references_auto_generated/plannedexperimentdb.rst @@ -15,115 +15,115 @@ Resource Fields =============================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =============================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**origin** Unicode string data. Ex: "Hello World" true false false false string +**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**applicationGroup** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planDisplayedName** 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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storage_options** Unicode string data. Ex: "Hello World" A false false false false string +**categories** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** Unicode string data. Ex: "Hello World" n/a true false false false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** 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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**expName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean +**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**id** Integer data. Ex: 2673 false false true true integer ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecutedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**irworkflow** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**isCustom_kitSettings** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string +**isFavorite** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationGroup** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**origin** 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 +**pairedEndLibraryAdapterName** Unicode string data. Ex: "Hello World" n/a true false false 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 +**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planDisplayedName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitName** 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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string +**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**planName** 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 +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**planShortID** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**project** Unicode string data. Ex: "Hello World" n/a false true true false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false 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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planName** 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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**parentPlan** Unicode string data. Ex: "Hello World" None false false true false string +**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**childPlans** A list of data. Ex: ['abc', 26.73, 8] [] false false false false list +**runMode** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** 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 +------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- +**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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** 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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**irworkflow** Unicode string data. Ex: "Hello World" false false true false string +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**project** Unicode string data. Ex: "Hello World" n/a false true true false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** Boolean data. Ex: True true false false true false boolean +**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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** Unicode string data. Ex: "Hello World" n/a true false false false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePreBeadfind** Boolean data. Ex: True true false false true false boolean +**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string +**usePostBeadfind** Boolean data. Ex: True true false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**usePreBeadfind** 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 +**username** Unicode string data. Ex: "Hello World" n/a true false false false string =============================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -133,118 +133,115 @@ Example Response { "meta": { - "previous": null, - "total_count": 111, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/plannedexperimentdb/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/plannedexperimentdb/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 135 + }, "objects": [ { - "origin": "gui|5.10.0.RC4", - "isReverseRun": false, - "planDisplayedName": "Ion AmpliSeq HD for Tumor - DNA", - "storage_options": "A", - "preAnalysis": true, - "planShortID": "SP1XE", - "username": "ionadmin", - "planStatus": "pending", - "runMode": "single", - "isCustom_kitSettings": false, - "sampleTubeLabel": "", - "planExecutedDate": null, - "samplePrepKitName": null, - "reverse_primer": null, - "applicationGroup": "/rundb/api/v1/applicationgroup/1/", - "seqKitBarcode": null, - "id": 143, - "metaData": { - "fromTemplate": "Ion_AmpliSeq_HD_for_Tumor_-_DNA", - "fromTemplateSource": "ION" - }, - "sampleSets": [], - "isFavorite": false, + "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": [ { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/143/", - "id": 407, + "id": 487, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 1, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Key Signal (1-100)", - "id": 2, - "resource_uri": "/rundb/api/v1/qctype/2/" - }, - "resource_uri": "/rundb/api/v1/plannedexperimentqc/407/" - }, + "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 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/143/", - "id": 408, + "id": 488, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Usable Sequence (%)", - "id": 3, - "resource_uri": "/rundb/api/v1/qctype/3/" - }, - "resource_uri": "/rundb/api/v1/plannedexperimentqc/408/" - }, + "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 + }, { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/143/", - "id": 406, + "id": 489, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Bead Loading (%)", - "id": 1, - "resource_uri": "/rundb/api/v1/qctype/1/" - }, - "resource_uri": "/rundb/api/v1/plannedexperimentqc/406/" + "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 } - ], - "samplePrepProtocol": "", - "isPlanGroup": false, - "experiment": "/rundb/api/v1/experiment/136/", - "projects": [], - "runType": "AMPS_HD_DNA", - "templatingKitBarcode": null, - "templatingKitName": "Ion Chef S540 V1", - "planPGM": null, - "isSystemDefault": false, - "autoName": null, - "isReusable": false, - "controlSequencekitname": null, - "date": "2018-04-13T22:17:13.000108+00:00", - "isSystem": false, - "libkit": null, - "categories": "onco_solidTumor;onco_heme;", - "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA", - "parentPlan": null, - "childPlans": [], - "pairedEndLibraryAdapterName": "", - "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/2/", - "adapter": null, - "irworkflow": "", - "planExecuted": false, - "project": "", - "usePostBeadfind": false, - "storageHost": null, - "expName": "", - "libraryReadLength": 200, - "runname": null, - "usePreBeadfind": true, - "planGUID": "1d75abf5-4d15-43f5-bb08-1c89d7344175", - "cycles": null, - "resource_uri": "/rundb/api/v1/plannedexperimentdb/143/" + ], + "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 } ] } diff --git a/source/api/references_auto_generated/plannedexperimentqc.rst b/source/api/references_auto_generated/plannedexperimentqc.rst index d9e49dd..b68d131 100644 --- a/source/api/references_auto_generated/plannedexperimentqc.rst +++ b/source/api/references_auto_generated/plannedexperimentqc.rst @@ -15,15 +15,15 @@ Resource Fields ===================== ============================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ===================== ============================================================================== ======= ======== ======== ===== ====== ======= -**threshold** Integer data. Ex: 2673 0 false false false false integer +**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 --------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true integer ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- **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 @@ -33,27 +33,27 @@ Example Response { "meta": { - "previous": null, - "total_count": 318, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/plannedexperimentqc/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/plannedexperimentqc/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 390 + }, "objects": [ { - "threshold": 30, - "plannedExperiment": "/rundb/api/v1/plannedexperiment/43/", - "id": 127, + "id": 489, + "plannedExperiment": "/rundb/api/v1/plannedexperiment/170/", "qcType": { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Bead Loading (%)", - "id": 1, - "resource_uri": "/rundb/api/v1/qctype/1/" - }, - "resource_uri": "/rundb/api/v1/plannedexperimentqc/127/" + "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 } ] } diff --git a/source/api/references_auto_generated/plantemplatebasicinfo.rst b/source/api/references_auto_generated/plantemplatebasicinfo.rst index b854c02..9891107 100644 --- a/source/api/references_auto_generated/plantemplatebasicinfo.rst +++ b/source/api/references_auto_generated/plantemplatebasicinfo.rst @@ -15,127 +15,127 @@ 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 +**adapter** 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 +**applicationCategoryDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storage_options** Unicode string data. Ex: "Hello World" A false 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reference** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" true true true false string +**categories** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**controlSequencekitname** 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 +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isCustom_kitSettings** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**eas** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecutedDate** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string +**hotSpotRegionBedFile** Unicode string data. Ex: "Hello World" 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 +**id** Integer data. Ex: 2673 false false true true integer ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**applicationGroupDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**irAccountName** Unicode string data. Ex: "Hello World" n/a true true 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleGroupName** Unicode string data. Ex: "Hello World" n/a true true true false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related +**isSystemDefault** Boolean data. Ex: True false 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 +**libkit** 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 +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**notes** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**planDisplayedName** 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 +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoName** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sequencingInstrumentType** Unicode string data. Ex: "Hello World" n/a true true true false string +**planPGM** 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 +**planShortID** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**eas** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** Unicode string data. Ex: "Hello World" n/a true false false 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**reference** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planName** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**irAccountName** Unicode string data. Ex: "Hello World" n/a true true true false string +**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatePrepInstrumentType** Unicode string data. Ex: "Hello World" n/a true true true false string +**runMode** Unicode string data. Ex: "Hello World" false false true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**targetRegionBedFile** Unicode string data. Ex: "Hello World" true true true false string +**runname** 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 +**sampleGroupName** 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 +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** Boolean data. Ex: True true false false true false boolean +**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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**targetRegionBedFile** Unicode string data. Ex: "Hello World" true true true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** Unicode string data. Ex: "Hello World" n/a true false false false string +**templatePrepInstrumentType** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePreBeadfind** Boolean data. Ex: True true false false true false boolean +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** 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 ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**usePostBeadfind** Boolean data. Ex: True true false false true false boolean ------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**notes** Unicode string data. Ex: "Hello World" true true true false string +**usePreBeadfind** 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 +**username** Unicode string data. Ex: "Hello World" n/a true false false false string ==================================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -145,75 +145,75 @@ Example Response { "meta": { - "previous": null, - "total_count": 96, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/plantemplatebasicinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/plantemplatebasicinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 103 + }, "objects": [ { - "origin": "|5.10.0.RC4", - "isReverseRun": false, - "planDisplayedName": "Ion AmpliSeq HD for Tumor - DNA and Fusions - Separate Libraries", - "storage_options": "A", - "preAnalysis": true, - "reference": "hg19", - "planShortID": "A628Z", - "hotSpotRegionBedFile": "", - "planStatus": "planned", - "runMode": "single", - "isCustom_kitSettings": false, - "sampleTubeLabel": null, - "planExecutedDate": null, - "samplePrepKitName": null, - "reverse_primer": null, - "applicationGroup": "/rundb/api/v1/applicationgroup/5/", - "applicationGroupDisplayedName": "DNA and Fusions (Separate Libraries)", - "id": 141, - "metaData": {}, - "isFavorite": false, - "seqKitBarcode": null, - "samplePrepProtocol": "", - "isPlanGroup": false, - "sampleGroupName": "DNA and Fusions", - "experiment": "/rundb/api/v1/experiment/134/", - "projects": "", - "barcodeKitName": "Ion AmpliSeq HD Dual Barcode Kit 1-24", - "runType": "AMPS_HD_DNA_RNA", - "templatingKitBarcode": null, - "templatingKitName": "Ion Chef S540 V1", - "planPGM": "", - "isSystemDefault": false, - "applicationCategoryDisplayedName": "Oncology - Solid Tumor | Oncology - HemeOnc", - "autoName": null, - "isReusable": true, - "controlSequencekitname": null, - "sequencingInstrumentType": "s5", - "date": "2018-04-12T05:54:10.000222+00:00", - "eas": "/rundb/api/v1/experimentanalysissettings/133/", - "isSystem": true, - "libkit": null, - "categories": "onco_solidTumor;onco_heme;", - "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA_and_Fusions_-_Separate_Libraries", - "irAccountName": "", - "templatePrepInstrumentType": "IonChef", - "pairedEndLibraryAdapterName": null, - "targetRegionBedFile": "", - "adapter": null, - "irworkflow": "", - "planExecuted": false, - "username": null, - "usePostBeadfind": false, - "storageHost": null, - "expName": "", - "libraryReadLength": 200, - "runname": null, - "usePreBeadfind": true, - "planGUID": "e52fac66-4086-433e-b8e7-ad1d1403946f", - "cycles": null, - "notes": "", - "resource_uri": "/rundb/api/v1/plantemplatebasicinfo/141/" + "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 } ] } diff --git a/source/api/references_auto_generated/plantemplatesummary.rst b/source/api/references_auto_generated/plantemplatesummary.rst index b943f59..0ee2c37 100644 --- a/source/api/references_auto_generated/plantemplatesummary.rst +++ b/source/api/references_auto_generated/plantemplatesummary.rst @@ -15,97 +15,97 @@ Resource Fields =============================== ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =============================== ==================================================== ======= ======== ======== ===== ====== ======== -**origin** Unicode string data. Ex: "Hello World" true false false false string +**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReverseRun** Boolean data. Ex: True false false false true false boolean +**autoName** 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 +**categories** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**storage_options** Unicode string data. Ex: "Hello World" A false false false false string +**controlSequencekitname** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**preAnalysis** Boolean data. Ex: True true false false true false boolean +**cycles** Integer data. Ex: 2673 n/a true false false false integer ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planShortID** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planStatus** Unicode string data. Ex: "Hello World" false false true false string +**expName** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runMode** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string +**isFavorite** 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 +**isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReusable** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reverse_primer** Unicode string data. Ex: "Hello World" n/a true false false false string +**isReverseRun** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**seqKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**isSystem** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**isSystemDefault** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**libkit** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isFavorite** Boolean data. Ex: True false false false true false boolean +**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanGroup** Boolean data. Ex: True false false false true false boolean +**origin** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitName** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runType** Unicode string data. Ex: "Hello World" GENS false false false false string +**planDisplayedName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string +**planExecuted** Boolean data. Ex: True false false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planPGM** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystemDefault** Boolean data. Ex: True false false false true false boolean +**planGUID** 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 +**planName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isReusable** Boolean data. Ex: True false false false true false boolean +**planPGM** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**controlSequencekitname** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime +**planStatus** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSystem** Boolean data. Ex: True false false false true false boolean +**preAnalysis** Boolean data. Ex: True true false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libkit** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**reverse_primer** 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 +**runMode** Unicode string data. Ex: "Hello World" false false true false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pairedEndLibraryAdapterName** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**adapter** Unicode string data. Ex: "Hello World" n/a true false false false string +**runname** 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 +**samplePrepKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planExecuted** Boolean data. Ex: True false false false true false boolean +**samplePrepProtocol** Unicode string data. Ex: "Hello World" true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**username** Unicode string data. Ex: "Hello World" n/a true false false false string +**sampleTubeLabel** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePostBeadfind** Boolean data. Ex: True true false false true false boolean +**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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**expName** Unicode string data. Ex: "Hello World" false false true false string -------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer +**storage_options** Unicode string data. Ex: "Hello World" A false false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runname** Unicode string data. Ex: "Hello World" n/a true false false false string +**templatingKitBarcode** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**usePreBeadfind** Boolean data. Ex: True true false false true false boolean +**templatingKitName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**planGUID** Unicode string data. Ex: "Hello World" n/a true false false false string +**usePostBeadfind** Boolean data. Ex: True true false false true false boolean ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**cycles** Integer data. Ex: 2673 n/a true false false false integer +**usePreBeadfind** 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 +**username** Unicode string data. Ex: "Hello World" n/a true false false false string =============================== ==================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -115,60 +115,60 @@ Example Response { "meta": { - "previous": null, - "total_count": 103, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/plantemplatesummary/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/plantemplatesummary/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 126 + }, "objects": [ { - "origin": "|5.10.0.RC4", - "isReverseRun": false, - "planDisplayedName": "Ion AmpliSeq HD for Tumor - DNA and Fusions - Separate Libraries", - "storage_options": "A", - "preAnalysis": true, - "planShortID": "A628Z", - "planStatus": "planned", - "runMode": "single", - "isCustom_kitSettings": false, - "sampleTubeLabel": null, - "planExecutedDate": null, - "samplePrepKitName": null, - "reverse_primer": null, - "seqKitBarcode": null, - "id": 141, - "metaData": {}, - "isFavorite": false, - "samplePrepProtocol": "", - "isPlanGroup": false, - "templatingKitName": "Ion Chef S540 V1", - "runType": "AMPS_HD_DNA_RNA", - "templatingKitBarcode": null, - "planPGM": "", - "isSystemDefault": false, - "autoName": null, - "isReusable": true, - "controlSequencekitname": null, - "date": "2018-04-12T05:54:10.000222+00:00", - "isSystem": true, - "libkit": null, - "categories": "onco_solidTumor;onco_heme;", - "planName": "Ion_AmpliSeq_HD_for_Tumor_-_DNA_and_Fusions_-_Separate_Libraries", - "pairedEndLibraryAdapterName": null, - "adapter": null, - "irworkflow": "", - "planExecuted": false, - "username": null, - "usePostBeadfind": false, - "storageHost": null, - "expName": "", - "libraryReadLength": 200, - "runname": null, - "usePreBeadfind": true, - "planGUID": "e52fac66-4086-433e-b8e7-ad1d1403946f", - "cycles": null, - "resource_uri": "/rundb/api/v1/plantemplatesummary/141/" + "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 } ] } diff --git a/source/api/references_auto_generated/plugin.rst b/source/api/references_auto_generated/plugin.rst index d91ba57..346a7e4 100644 --- a/source/api/references_auto_generated/plugin.rst +++ b/source/api/references_auto_generated/plugin.rst @@ -19,57 +19,57 @@ field help text -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **availableVersions** A list of data. Ex: ['abc', 26.73, 8] [] false true false false list -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**config** Unicode string data. Ex: "Hello World" true false false false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isPlanConfig** Boolean data. Ex: True n/a false true false false boolean +**date** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isSupported** Boolean data. Ex: True n/a false true false false boolean +**defaultSelected** Boolean data. Ex: True false false false true false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**script** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**selected** Boolean data. Ex: True false false false true false boolean +**hasAbout** Boolean data. Ex: True n/a false true false false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**requires_configuration** Boolean data. Ex: True false false false true false boolean +**id** Integer data. Ex: 2673 false false true true integer -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**version** Unicode string data. Ex: "Hello World" n/a false false false false string +**input** Unicode string data. Ex: "Hello World" n/a false true false false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**hasAbout** Boolean data. Ex: True n/a false true false false boolean +**isConfig** Boolean data. Ex: True n/a false true false false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**input** Unicode string data. Ex: "Hello World" n/a false true false false string +**isInstance** Boolean data. Ex: True n/a false true false false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**majorBlock** Boolean data. Ex: True false false false true false boolean +**isPlanConfig** Boolean data. Ex: True n/a false true false false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**status** Unicode string data. Ex: "Hello World" true false false false string +**isSupported** Boolean data. Ex: True n/a false true false false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**isUpgradable** Boolean data. Ex: True false false true false false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**defaultSelected** Boolean data. Ex: True false false false true false boolean +**majorBlock** Boolean data. Ex: True false false false true false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pluginsettings** Unicode string data. Ex: "Hello World" true false false false string +**name** 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" true false false true false datetime +**packageName** Unicode string data. Ex: "Hello World" false false true false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **path** Unicode string data. Ex: "Hello World" false false true false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isConfig** Boolean data. Ex: True n/a false true false false boolean +**pluginsettings** Unicode string data. Ex: "Hello World" true false false false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isInstance** Boolean data. Ex: True n/a false true false false boolean +**requires_configuration** Boolean data. Ex: True false 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 -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**userinputfields** Unicode string data. Ex: "Hello World" {} true false false false string +**script** Unicode string data. Ex: "Hello World" false false true false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**url** Unicode string data. Ex: "Hello World" false false true false string +**selected** Boolean data. Ex: True false false false true false boolean -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**config** Unicode string data. Ex: "Hello World" true false false false string +**status** Unicode string data. Ex: "Hello World" true false false false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**packageName** Unicode string data. Ex: "Hello World" false false true false string +**url** Unicode string data. Ex: "Hello World" false false true false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**versionedName** Unicode string data. Ex: "Hello World" n/a false true false false string +**userinputfields** 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 +**version** Unicode string data. Ex: "Hello World" n/a false false false false string -------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**isUpgradable** Boolean data. Ex: True false false true false false boolean +**versionedName** Unicode string data. Ex: "Hello World" n/a false true false false string ========================== ==================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -79,55 +79,55 @@ Example Response { "meta": { - "previous": null, - "total_count": 16, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/plugin/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/plugin/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 16 + }, "objects": [ { - "active": true, + "active": true, "availableVersions": [ - "5.8.0.0" - ], - "id": 30, - "isPlanConfig": true, - "isSupported": true, - "script": "smallRNA.py", - "selected": true, - "requires_configuration": false, - "version": "5.8.0.0", - "hasAbout": false, - "input": "/configure/plugins/plugin/30/configure/report/", - "majorBlock": true, - "status": {}, - "description": "Run the small RNA pipeline.", - "defaultSelected": false, + "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": [], - "runtypes": [ - "wholechip", - "thumbnail", - "composite" - ], + "depends": [], + "features": [], "runlevels": [ "default" + ], + "runtypes": [ + "wholechip", + "thumbnail", + "composite" ] - }, - "date": "2017-12-05T00:11:04.000271+00:00", - "path": "/results/plugins/smallRNA", - "isConfig": true, - "isInstance": true, - "name": "smallRNA", - "userinputfields": {}, - "url": "", - "config": {}, - "packageName": "ion-plugin-smallrna", - "versionedName": "smallRNA--v5.8.0.0", - "resource_uri": "/rundb/api/v1/plugin/30/", - "isUpgradable": false + }, + "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" } ] } diff --git a/source/api/references_auto_generated/pluginresult.rst b/source/api/references_auto_generated/pluginresult.rst index f3ddf7b..ffccd61 100644 --- a/source/api/references_auto_generated/pluginresult.rst +++ b/source/api/references_auto_generated/pluginresult.rst @@ -15,51 +15,51 @@ Resource Fields ====================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ====================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**major** Boolean data. Ex: True n/a false true false false boolean ----------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**can_terminate** Boolean data. Ex: True n/a false true false false boolean +**URL** Unicode string data. Ex: "Hello World" n/a false true false false string ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultName** 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 ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pluginVersion** Unicode string data. Ex: "Hello World" n/a false true false false string +**can_terminate** Boolean data. Ex: True n/a false true false false boolean ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**result** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related +**endtime** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false true false false datetime ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**owner** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related +**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 ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**size** Unicode string data. Ex: "Hello World" -1 false false false false string +**inodes** Unicode string data. Ex: "Hello World" -1 false false false false string ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**validation_errors** Unicode string data. Ex: "Hello World" {} false false true false string +**major** Boolean data. Ex: True n/a false true false false boolean ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**state** Unicode string data. Ex: "Hello World" n/a false true false false string +**owner** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**store** Unicode string data. Ex: "Hello World" {} false false true false string +**path** Unicode string data. Ex: "Hello World" n/a false true false false string ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**files** A list of data. Ex: ['abc', 26.73, 8] n/a false true false false list +**plugin** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**URL** Unicode string data. Ex: "Hello World" n/a false true false false string +**pluginName** 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 +**pluginVersion** Unicode string data. Ex: "Hello World" n/a false true false false string ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**path** 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 ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**endtime** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false true false false datetime +**reportLink** 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 +**resource_uri** 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 +**result** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reportLink** Unicode string data. Ex: "Hello World" n/a false true false false string +**resultName** Unicode string data. Ex: "Hello World" n/a false true false false string ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pluginName** 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 ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**inodes** Unicode string data. Ex: "Hello World" -1 false false false false string +**state** 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 +**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 @@ -69,67 +69,72 @@ Example Response { "meta": { - "previous": null, - "total_count": 17, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/pluginresult/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/pluginresult/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 18 + }, "objects": [ { - "major": true, - "can_terminate": false, - "resultName": "Auto_user_CB1-42-r9723-314wfa-tl_94", - "pluginVersion": "5.8.0.0", - "result": "/rundb/api/v1/results/6/", - "owner": "/rundb/api/v1/user/2/", - "id": 24, - "size": "344884433", - "validation_errors": { - "validation_errors": [] - }, - "state": "Error", - "store": { - "reference": "/results/referenceLibrary/tmap-f3/hg19/hg19.fasta", - "barcoded": false, - "Error": "Failed running run_rnaseqanalysis.py.", - "genome": "hg19", - "launch_mode": "Manual", - "fpkm_thres": "0.3", - "cutadapt": "None", - "fraction_of_reads": "1" - }, + "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": [ - "RNASeqAnalysis.html" - ], - "URL": "/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/plugin_out/RNASeqAnalysis_out.24/", + "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": [ { - "grid_engine_jobid": 517, - "id": 24, - "state": "Error", - "starttime": "2018-04-25T22:22:52.000576+00:00", - "endtime": "2018-04-25T22:28:47.000816+00:00", "config": { - "cutadapt": "None", - "fraction_of_reads": "1", - "reference": "/results/referenceLibrary/tmap-f3/hg19/hg19.fasta", - "genome": "hg19", - "launch_mode": "Manual" - }, - "run_level": "default", - "resource_uri": "/rundb/api/v1/PluginResultJob/24/" + "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" } - ], - "path": "/results/analysis/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/plugin_out/RNASeqAnalysis_out.24", - "endtime": "2018-04-25T22:28:47.000816+00:00", - "apikey": "5a4f5fb12ef3d6c5490b3a41501097a506cd8d85", - "plugin": "/rundb/api/v1/plugin/29/", - "reportLink": "/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/", - "pluginName": "RNASeqAnalysis", - "starttime": "2018-04-25T22:22:52.000576+00:00", - "inodes": "33", - "resource_uri": "/rundb/api/v1/pluginresult/24/" + ], + "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": [] + } } ] } diff --git a/source/api/references_auto_generated/pluginresultjob.rst b/source/api/references_auto_generated/pluginresultjob.rst index f0da80b..296c720 100644 --- a/source/api/references_auto_generated/pluginresultjob.rst +++ b/source/api/references_auto_generated/pluginresultjob.rst @@ -15,21 +15,21 @@ Resource Fields ===================== ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ===================== ==================================================== ======= ======== ======== ===== ====== ======== -**grid_engine_jobid** Integer data. Ex: 2673 n/a true false false false integer ---------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**config** Unicode string data. Ex: "Hello World" false false true false string --------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**state** Unicode string data. Ex: "Hello World" n/a false false false false string +**endtime** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime --------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**starttime** 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 --------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 --------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**config** 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 --------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **run_level** 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 +**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 @@ -39,42 +39,42 @@ Example Response { "meta": { - "previous": null, - "total_count": 17, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/PluginResultJob/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/PluginResultJob/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 18 + }, "objects": [ { - "grid_engine_jobid": -1, - "id": 19, - "state": "Completed", - "starttime": "2017-08-09T20:26:03.000549+00:00", - "endtime": "2017-08-09T20:30:11.000942+00:00", "config": { - "compressedType": "zip", - "bamCreate": "on", - "xlsCreate": "off", - "zipFASTQ": "off", - "vcfCreate": "on", - "zipXLS": "off", - "delimiter_select": ".", - "zipVCF": "on", - "zipBAM": "on", - "fastqCreate": "off", - "select_dialog": [ - "run_name", - "samplename", - "instrument", - "", - "", - "", - "" - ] - }, - "run_level": "last", - "resource_uri": "/rundb/api/v1/PluginResultJob/19/" + "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" } ] } diff --git a/source/api/references_auto_generated/project.rst b/source/api/references_auto_generated/project.rst index da3a581..e327c88 100644 --- a/source/api/references_auto_generated/project.rst +++ b/source/api/references_auto_generated/project.rst @@ -15,21 +15,21 @@ Resource Fields ================ ============================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================ ============================================================================== ======= ======== ======== ===== ====== ======== -**name** Unicode string data. Ex: "Hello World" n/a false false false true string +**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 ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**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 ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- **modified** 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 ----------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**resultsCount** Integer data. Ex: 2673 n/a false true false false integer +**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 @@ -39,22 +39,22 @@ Example Response { "meta": { - "previous": null, - "total_count": 2, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/project/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/project/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "name": "demo", - "creator": "/rundb/api/v1/user/1/", - "created": "2017-07-22T06:59:07.000475+00:00", - "modified": "2018-02-28T17:32:01.000703+00:00", - "id": 1, - "resultsCount": 6, - "public": true, - "resource_uri": "/rundb/api/v1/project/1/" + "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 } ] } diff --git a/source/api/references_auto_generated/projectresults.rst b/source/api/references_auto_generated/projectresults.rst index 6eeff85..d14a141 100644 --- a/source/api/references_auto_generated/projectresults.rst +++ b/source/api/references_auto_generated/projectresults.rst @@ -15,49 +15,49 @@ Resource Fields =================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**reference** Unicode string data. Ex: "Hello World" n/a true false false false string +**analysisVersion** 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 +**autoExempt** Boolean data. Ex: True false false false true false boolean ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runid** Unicode string data. Ex: "Hello World" false false true false string +**diskusage** Integer data. Ex: 2673 n/a true false false false integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**framesProcessed** Integer data. Ex: 2673 n/a false false false false integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**id** Integer data. Ex: 2673 false false true true integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **log** 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 +**metaData** Unicode string data. Ex: "Hello World" {} false false true false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultsName** Unicode string data. Ex: "Hello World" n/a false false false false string +**parentIDs** 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 +**processedCycles** Integer data. Ex: 2673 n/a false false false false integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **processedflows** Integer data. Ex: 2673 n/a false false false false integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**processedCycles** 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**representative** Boolean data. Ex: True false false false true false boolean +**reference** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**diskusage** Integer data. Ex: 2673 n/a true false false false integer +**reportLink** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**reportStatus** Unicode string data. Ex: "Hello World" Nothing true false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultsType** Unicode string data. Ex: "Hello World" false false true false string +**representative** Boolean data. Ex: True false false false true false boolean ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**parentIDs** 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**timeToComplete** Unicode string data. Ex: "Hello World" n/a false false false false string +**resultsName** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reportLink** 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string +**runid** Unicode string data. Ex: "Hello World" false false true false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**framesProcessed** Integer data. Ex: 2673 n/a false false false false integer +**status** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoExempt** Boolean data. Ex: True false false false true false boolean +**timeStamp** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**analysisVersion** Unicode string data. Ex: "Hello World" n/a false false false false string +**timeToComplete** Unicode string data. Ex: "Hello World" n/a false false false false string =================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -67,38 +67,38 @@ Example Response { "meta": { - "previous": null, - "total_count": 7, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/projectresults/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/projectresults/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 7 + }, "objects": [ { - "reference": "", - "reportStatus": "Nothing", - "runid": "MJMQ3", - "id": 3, - "metaData": {}, - "log": "/output/Home/Auto_S5-540_WholeTranscriptomeRNA_91_003/log.html", - "timeStamp": "2017-07-22T13:15:56.000197+00:00", - "resultsName": "Auto_S5-540_WholeTranscriptomeRNA_91", - "status": "Completed", - "processedflows": 0, - "processedCycles": 0, - "representative": false, - "diskusage": 229301, + "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/" - ], - "resultsType": "", - "parentIDs": "", - "timeToComplete": "0", - "reportLink": "/output/Home/Auto_S5-540_WholeTranscriptomeRNA_91_003/", - "resource_uri": "/rundb/api/v1/projectresults/3/", - "framesProcessed": 0, - "autoExempt": false, - "analysisVersion": "db:5.6.18-1,an:5.6.5-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" } ] } diff --git a/source/api/references_auto_generated/publisher.rst b/source/api/references_auto_generated/publisher.rst index c8d8d12..a77b8bf 100644 --- a/source/api/references_auto_generated/publisher.rst +++ b/source/api/references_auto_generated/publisher.rst @@ -15,19 +15,19 @@ Resource Fields ================ ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================ ==================================================== ======= ======== ======== ===== ====== ======== -**name** Unicode string data. Ex: "Hello World" n/a false false false true string ----------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**version** 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 ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **global_meta** Unicode string data. Ex: "Hello World" {} false false true false string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false false false false datetime +**id** Integer data. Ex: 2673 false false true true integer ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**path** 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 true string ---------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**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 @@ -37,21 +37,21 @@ Example Response { "meta": { - "previous": null, - "total_count": 2, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/publisher/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/publisher/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "name": "BED", - "version": "1.0", - "global_meta": {}, - "date": "2017-07-22T21:17:13.000054+00:00", - "path": "/results/publishers/BED", - "id": 2, - "resource_uri": "/rundb/api/v1/publisher/BED/" + "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" } ] } diff --git a/source/api/references_auto_generated/qctype.rst b/source/api/references_auto_generated/qctype.rst index d1885eb..399c488 100644 --- a/source/api/references_auto_generated/qctype.rst +++ b/source/api/references_auto_generated/qctype.rst @@ -15,18 +15,18 @@ 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 -------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**minThreshold** Integer data. Ex: 2673 0 false false false false integer +**id** Integer data. Ex: 2673 false false true true integer -------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **maxThreshold** Integer data. Ex: 2673 100 false false false false integer -------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**defaultThreshold** Integer data. Ex: 2673 0 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 -------------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**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 ==================== ====================================== ======= ======== ======== ===== ====== ======= @@ -37,21 +37,21 @@ Example Response { "meta": { - "previous": null, - "total_count": 3, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/qctype/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/qctype/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 3 + }, "objects": [ { - "description": "", - "minThreshold": 0, - "maxThreshold": 100, - "defaultThreshold": 30, - "qcName": "Bead Loading (%)", - "id": 1, - "resource_uri": "/rundb/api/v1/qctype/1/" + "defaultThreshold": 30, + "description": "", + "id": 3, + "maxThreshold": 100, + "minThreshold": 0, + "qcName": "Usable Sequence (%)", + "resource_uri": "/rundb/api/v1/qctype/3/" } ] } diff --git a/source/api/references_auto_generated/qualitymetrics.rst b/source/api/references_auto_generated/qualitymetrics.rst index 6ec388d..4e5fec0 100644 --- a/source/api/references_auto_generated/qualitymetrics.rst +++ b/source/api/references_auto_generated/qualitymetrics.rst @@ -15,65 +15,65 @@ Resource Fields ========================== ============================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ========================== ============================================================================== ======= ======== ======== ===== ====== ======= -**q0_reads** Integer data. Ex: 2673 n/a false false false false integer --------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q17_max_read_length** Integer data. Ex: 2673 n/a false false false false integer +**id** Integer data. Ex: 2673 false false true true integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q20_median_read_length** Integer data. Ex: 2673 0 false false false false integer +**q0_100bp_reads** Integer data. Ex: 2673 n/a false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q20_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 -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**report** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related +**q0_50bp_reads** 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 +**q0_bases** Unicode string data. Ex: "Hello World" n/a false false false false string -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q17_100bp_reads** Integer data. Ex: 2673 n/a false false false false integer +**q0_max_read_length** 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 +**q0_mean_read_length** Floating point numeric data. Ex: 26.73 n/a false false false false float -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q0_max_read_length** Integer data. Ex: 2673 n/a false false false false integer +**q0_median_read_length** Integer data. Ex: 2673 0 false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q20_100bp_reads** Integer data. Ex: 2673 n/a false false false false integer +**q0_mode_read_length** Integer data. Ex: 2673 0 false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true integer +**q0_reads** Integer data. Ex: 2673 n/a false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q20_mean_read_length** 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 -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q20_150bp_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 -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q0_bases** Unicode string data. Ex: "Hello World" n/a false false false false string +**q17_50bp_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 +**q17_bases** Unicode string data. Ex: "Hello World" n/a false false false false string -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q17_reads** Integer data. Ex: 2673 n/a false false false false integer +**q17_max_read_length** 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_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 -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q0_50bp_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_mode_read_length** Integer data. Ex: 2673 0 false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q0_150bp_reads** Integer data. Ex: 2673 0 false false false false integer +**q17_reads** 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 +**q20_100bp_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 +**q20_150bp_reads** Integer data. Ex: 2673 n/a false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q0_mode_read_length** Integer data. Ex: 2673 0 false false false false integer +**q20_50bp_reads** Integer data. Ex: 2673 n/a false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q20_mode_read_length** Integer data. Ex: 2673 0 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_bases** Unicode string data. Ex: "Hello World" n/a false false false false string +**q20_mean_read_length** Integer data. Ex: 2673 n/a false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q0_median_read_length** Integer data. Ex: 2673 0 false false false false integer +**q20_median_read_length** Integer data. Ex: 2673 0 false false false false integer -------------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**q0_100bp_reads** Integer data. Ex: 2673 n/a false false false false integer +**q20_mode_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 +**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 @@ -83,44 +83,44 @@ Example Response { "meta": { - "previous": null, - "total_count": 6, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/qualitymetrics/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/qualitymetrics/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 6 + }, "objects": [ { - "q0_reads": 93969124, - "q17_max_read_length": 361, - "q20_median_read_length": 149, - "q20_reads": 93969124, - "report": "/rundb/api/v1/results/3/", - "q17_mean_read_length": 149.579903660696, - "q17_100bp_reads": 82389255, - "resource_uri": "/rundb/api/v1/qualitymetrics/1/", - "q0_max_read_length": 361, - "q20_100bp_reads": 82389255, - "id": 1, - "q20_mean_read_length": 149, - "q20_150bp_reads": 46834701, - "q0_bases": "14055892515", - "q20_50bp_reads": 91801424, - "q17_reads": 93969124, - "q17_50bp_reads": 91801424, - "q17_median_read_length": 149, - "q0_50bp_reads": 91801424, - "q17_150bp_reads": 46834701, - "q0_150bp_reads": 46834701, - "q0_mean_read_length": 149.579903660696, - "q17_bases": "12627160533", - "q0_mode_read_length": 141, - "q20_mode_read_length": 141, - "q20_max_read_length": 361, - "q20_bases": "11916010889", - "q0_median_read_length": 149, - "q0_100bp_reads": 82389255, - "q17_mode_read_length": 141 + "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/" } ] } diff --git a/source/api/references_auto_generated/referencegenome.rst b/source/api/references_auto_generated/referencegenome.rst index 882a446..b551f77 100644 --- a/source/api/references_auto_generated/referencegenome.rst +++ b/source/api/references_auto_generated/referencegenome.rst @@ -15,37 +15,37 @@ Resource Fields ================== ==================================================== ================================ ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================== ==================================================== ================================ ======== ======== ===== ====== ======== -**status** Unicode string data. Ex: "Hello World" false false true false string +**celery_task_id** Unicode string data. Ex: "Hello World" false false true false string ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**reference_path** 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 ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**name** Unicode string data. Ex: "Hello World" n/a false false false false string +**enabled** Boolean data. Ex: True true false false true false boolean ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**short_name** Unicode string data. Ex: "Hello World" n/a false false false false string +**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 ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**enabled** Boolean data. Ex: True true false false true false boolean +**reference_path** Unicode string data. Ex: "Hello World" false false true false string ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**species** 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 ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**identity_hash** Unicode string data. Ex: "Hello World" None true false 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 ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**version** Unicode string data. Ex: "Hello World" false false true false string ------------------- ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**celery_task_id** Unicode string data. Ex: "Hello World" false false true false string +**species** Unicode string data. Ex: "Hello World" false false true false string ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**date** A date & time as a string. Ex: "2010-11-10T03:07:43" 2018-06-19T20:40:12.000844+00:00 false false false false datetime +**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 ------------------ ---------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**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 +**version** Unicode string data. Ex: "Hello World" false false true false string ================== ==================================================== ================================ ======== ======== ===== ====== ======== Example Response @@ -55,30 +55,30 @@ Example Response { "meta": { - "previous": null, - "total_count": 6, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/referencegenome/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/referencegenome/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 7 + }, "objects": [ { - "status": "complete", - "reference_path": "/results/referenceLibrary/tmap-f3/AmpliSeq_Mouse_Transcriptome_v1", - "name": "AmpliSeq Mouse Transcriptome v1", - "short_name": "AmpliSeq_Mouse_Transcriptome_v1", - "index_version": "tmap-f3", - "notes": "", - "enabled": true, - "species": "", - "identity_hash": "92e672f416392e46e3137388d878efe7", - "source": "http://ionupdates.com/reference_downloads/AmpliSeq_Mouse_Transcriptome_v1.zip", - "version": "", - "celery_task_id": "370dd08d-d9d0-4f9f-8965-d0563a4461b7", - "date": "2018-01-23T22:42:16.000613+00:00", - "verbose_error": "", - "id": 4, - "resource_uri": "/rundb/api/v1/referencegenome/4/" + "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": "" } ] } diff --git a/source/api/references_auto_generated/results.rst b/source/api/references_auto_generated/results.rst index 5e5bcb1..36e6762 100644 --- a/source/api/references_auto_generated/results.rst +++ b/source/api/references_auto_generated/results.rst @@ -15,75 +15,77 @@ Resource Fields =================== ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type =================== ================================================================================================== ======= ======== ======== ===== ====== ======== -**reference** Unicode string data. Ex: "Hello World" n/a true false false false string +**analysisVersion** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**processedflows** Integer data. Ex: 2673 n/a false false false false integer +**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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reportStatus** Unicode string data. Ex: "Hello World" Nothing true false false false string +**autoExempt** Boolean data. Ex: True false false false true false boolean ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reportstorage** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related +**bamLink** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**analysisVersion** 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**runid** Unicode string data. Ex: "Hello World" false false true false string +**eas** 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 +**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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**metaData** Unicode string data. Ex: "Hello World" {} false false true false string +**framesProcessed** Integer data. Ex: 2673 n/a false false false false integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**log** Unicode string data. Ex: "Hello World" false false true false string +**i18nstatus** 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 +**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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**experiment** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related +**log** Unicode string data. Ex: "Hello World" false false true false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resultsName** Unicode string data. Ex: "Hello World" n/a false false false false string +**metaData** 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 +**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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**processedCycles** Integer data. Ex: 2673 n/a false false false false integer +**pluginState** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} n/a false true false false dict ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**bamLink** Unicode string data. Ex: "Hello World" n/a false false false false string +**pluginStore** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} n/a false true false false dict ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**representative** Boolean data. Ex: True false false false true false boolean +**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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pluginState** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} n/a false true false false dict +**processedCycles** Integer data. Ex: 2673 n/a false false false false integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**processedflows** Integer data. Ex: 2673 n/a false false false false integer ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**diskusage** Integer data. Ex: 2673 n/a true 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**eas** A single related resource. Can be either a URI or set of nested resource data. n/a true false true 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pluginStore** A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} n/a false true false false dict +**reportLink** 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 +**reportStatus** Unicode string data. Ex: "Hello World" Nothing true 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 +**reportstorage** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**parentIDs** Unicode string data. Ex: "Hello World" false false true false string +**representative** Boolean data. Ex: True false false false true false boolean ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**timeToComplete** Unicode string data. Ex: "Hello World" n/a false false false false string +**resultsName** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reportLink** 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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**runid** Unicode string data. Ex: "Hello World" false false true false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**framesProcessed** Integer data. Ex: 2673 n/a false false false false integer +**status** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**autoExempt** Boolean data. Ex: True false false false true false boolean +**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 ------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true 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 @@ -93,69 +95,60 @@ Example Response { "meta": { - "previous": null, - "total_count": 7, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/results/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/results/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 7 + }, "objects": [ { - "reference": "", - "processedflows": 0, - "reportStatus": "Nothing", - "reportstorage": { - "name": "Home", - "default": true, - "webServerPath": "/output", - "dirPath": "/results/analysis/output", - "id": 1, - "resource_uri": "" - }, - "analysisVersion": "db:5.6.18-1,an:5.6.5-1,", - "runid": "MJMQ3", - "id": 3, - "filesystempath": "/results/analysis/output/Home/Auto_S5-540_WholeTranscriptomeRNA_91_003", - "metaData": {}, - "log": "/output/Home/Auto_S5-540_WholeTranscriptomeRNA_91_003/log.html", - "timeStamp": "2017-07-22T13:15:56.000197+00:00", - "libmetrics": [ - "/rundb/api/v1/libmetrics/1/" - ], - "experiment": "/rundb/api/v1/experiment/91/", - "resultsName": "Auto_S5-540_WholeTranscriptomeRNA_91", - "status": "Completed", - "planShortID": "RI63N", - "processedCycles": 0, - "bamLink": "/output/Home/Auto_S5-540_WholeTranscriptomeRNA_91_003/download_links/S5-540_WholeTranscriptomeRNA_Auto_S5-540_WholeTranscriptomeRNA_91.bam", - "representative": false, - "qualitymetrics": [ - "/rundb/api/v1/qualitymetrics/1/" - ], - "diskusage": 229301, - "eas": "/rundb/api/v1/experimentanalysissettings/90/", + "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/" - ], - "resultsType": "", - "tfmetrics": [ - "/rundb/api/v1/tfmetrics/2/", - "/rundb/api/v1/tfmetrics/1/" - ], - "parentIDs": "", - "analysismetrics": [ - "/rundb/api/v1/analysismetrics/1/" - ], - "timeToComplete": "0", - "reportLink": "/output/Home/Auto_S5-540_WholeTranscriptomeRNA_91_003/", - "pluginresults": [ - "/rundb/api/v1/pluginresult/9/", - "/rundb/api/v1/pluginresult/8/", - "/rundb/api/v1/pluginresult/3/" - ], - "framesProcessed": 0, - "autoExempt": false, - "resource_uri": "/rundb/api/v1/results/3/" + ], + "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" } ] } diff --git a/source/api/references_auto_generated/rig.rst b/source/api/references_auto_generated/rig.rst index f0253f2..709fcb8 100644 --- a/source/api/references_auto_generated/rig.rst +++ b/source/api/references_auto_generated/rig.rst @@ -15,47 +15,47 @@ Resource Fields =================== ============================================================================== ============= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type =================== ============================================================================== ============= ======== ======== ===== ====== ======= -**display_state** Unicode string data. Ex: "Hello World" false false true false string +**alarms** 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 +**comments** Unicode string data. Ex: "Hello World" false false true false string ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**state** Unicode string data. Ex: "Hello World" false false true false string +**display_state** Unicode string data. Ex: "Hello World" false false true false string ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**version** 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 ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**last_clean_date** Unicode string data. Ex: "Hello World" false false true false string +**ftpserver** Unicode string data. Ex: "Hello World" 192.168.201.1 false false false false string ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**updatehome** 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 ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**ftpserver** Unicode string data. Ex: "Hello World" 192.168.201.1 false false false false string +**host_address** Unicode string data. Ex: "Hello World" false false true false string ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**comments** 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 ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**ftppassword** Unicode string data. Ex: "Hello World" ionguest false false false false string -------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**updateflag** Boolean data. Ex: True false false false true false boolean +**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 ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**last_init_date** Unicode string data. Ex: "Hello World" false false true false string -------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**updateCommand** 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 ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**alarms** 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 ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- **serial** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**host_address** Unicode string data. Ex: "Hello World" false false true 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 ------------------- ------------------------------------------------------------------------------ ------------- -------- -------- ----- ------ ------- -**ftpusername** Unicode string data. Ex: "Hello World" ionguest false false false false string +**updateCommand** 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 +**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 @@ -65,41 +65,41 @@ Example Response { "meta": { - "previous": null, - "total_count": 4, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/rig/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/rig/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 4 + }, "objects": [ { - "display_state": "", - "name": "default", - "state": "", - "version": {}, - "ftprootdir": "results", - "last_clean_date": "", - "updatehome": "192.168.201.1", - "ftpserver": "192.168.201.1", - "comments": "This is a model PGM. Do not delete.", - "last_experiment": "", - "ftppassword": "ionguest", - "updateflag": false, + "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": { - "name": "Home", - "resource_uri": "/rundb/api/v1/location/1/", - "defaultlocation": true, - "comments": "", - "id": 1 - }, - "last_init_date": "", - "updateCommand": {}, - "alarms": {}, - "serial": null, - "host_address": "", - "type": "", - "ftpusername": "ionguest", - "resource_uri": "/rundb/api/v1/rig/default/" + "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": {} } ] } diff --git a/source/api/references_auto_generated/runtype.rst b/source/api/references_auto_generated/runtype.rst index fd1351c..1da3c66 100644 --- a/source/api/references_auto_generated/runtype.rst +++ b/source/api/references_auto_generated/runtype.rst @@ -15,25 +15,25 @@ Resource Fields ===================== ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ===================== ================================================================================================== ======= ======== ======== ===== ====== ======= -**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 ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** Unicode string data. Ex: "Hello World" false false true false string +**alternate_name** Unicode string data. Ex: "Hello World" true false false false string --------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" dna false false true 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 --------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**meta** Unicode string data. Ex: "Hello World" true false false false string ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**alternate_name** Unicode string data. Ex: "Hello World" true false false false string ---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runType** Unicode string data. Ex: "Hello World" n/a false false false true 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 @@ -43,28 +43,26 @@ Example Response { "meta": { - "previous": null, - "total_count": 15, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/runtype/?offset=1&limit=1&format=json" - }, + "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/1/", - "/rundb/api/v1/applicationgroup/3/", - "/rundb/api/v1/applicationgroup/4/" - ], - "description": "Generic Sequencing", - "nucleotideType": "dna", - "barcode": "", - "meta": {}, - "alternate_name": "Other", - "runType": "GENS", - "id": 1, - "isActive": true, - "resource_uri": "/rundb/api/v1/runtype/1/" + "/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" } ] } diff --git a/source/api/references_auto_generated/sample.rst b/source/api/references_auto_generated/sample.rst index db748de..203993e 100644 --- a/source/api/references_auto_generated/sample.rst +++ b/source/api/references_auto_generated/sample.rst @@ -15,9 +15,7 @@ Resource Fields ================= ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================= ================================================================================================== ======= ======== ======== ===== ====== ======== -**status** Unicode string data. Ex: "Hello World" false false 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 +**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 ----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- @@ -27,13 +25,15 @@ field help text ----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **externalId** 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 true false false false datetime +**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 ----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**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 ----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**name** Unicode string data. Ex: "Hello World" n/a true false false false string +**status** Unicode string data. Ex: "Hello World" false false true false string ================= ================================================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -43,26 +43,26 @@ Example Response { "meta": { - "previous": null, - "total_count": 23, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/sample/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/sample/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 23 + }, "objects": [ { - "status": "run", - "sampleSets": [], - "description": null, - "displayedName": "e5272-wfa-l165", + "date": "2018-04-13T22:17:13.000114+00:00", + "description": "", + "displayedName": "Sample 9", "experiments": [ - "/rundb/api/v1/experiment/94/" - ], - "externalId": "", - "date": "2017-08-23T21:42:01.000299+00:00", - "resource_uri": "/rundb/api/v1/sample/4/", - "id": 4, - "name": "e5272-wfa-l165" + "/rundb/api/v1/experiment/136/" + ], + "externalId": "", + "id": 26, + "name": "Sample_9", + "resource_uri": "/rundb/api/v1/sample/26/", + "sampleSets": [], + "status": "planned" } ] } diff --git a/source/api/references_auto_generated/sampleannotation_cv.rst b/source/api/references_auto_generated/sampleannotation_cv.rst index 313f13e..29974f6 100644 --- a/source/api/references_auto_generated/sampleannotation_cv.rst +++ b/source/api/references_auto_generated/sampleannotation_cv.rst @@ -17,23 +17,23 @@ field help text ====================== ============================================================================== ======= ======== ======== ===== ====== ======= **annotationType** 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 ----------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**isIRCompatible** Boolean data. Ex: True false false false true false boolean ----------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**sampleGroupType_CV** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ----------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**value** Unicode string data. Ex: "Hello World" false false true 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 ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**iRAnnotationType** 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 @@ -43,24 +43,24 @@ Example Response { "meta": { - "previous": null, - "total_count": 50, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/sampleannotation_cv/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/sampleannotation_cv/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 90 + }, "objects": [ { - "annotationType": "relationshipRole", - "uid": "SAMPLEANNOTATE_CV_0006", - "isIRCompatible": true, - "sampleGroupType_CV": "/rundb/api/v1/samplegrouptype_cv/4/", - "value": "Father", - "iRValue": "Father", - "iRAnnotationType": "Relation", - "id": 6, - "isActive": true, - "resource_uri": "/rundb/api/v1/sampleannotation_cv/6/" + "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" } ] } diff --git a/source/api/references_auto_generated/sampleattribute.rst b/source/api/references_auto_generated/sampleattribute.rst index 6035da8..643e886 100644 --- a/source/api/references_auto_generated/sampleattribute.rst +++ b/source/api/references_auto_generated/sampleattribute.rst @@ -15,27 +15,27 @@ 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 --------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**dataType_name** Unicode string data. Ex: "Hello World" n/a true true true false string +**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 -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**displayedName** Unicode string data. Ex: "Hello World" n/a false false false true string --------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**isMandatory** Boolean data. Ex: True false false false true false boolean --------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sampleCount** Integer data. Ex: 2673 n/a false true false false integer +**dataType_name** Unicode string data. Ex: "Hello World" n/a true true true false string -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**lastModifiedDate** 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" n/a true false false false string -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**creationDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime +**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 @@ -45,13 +45,27 @@ Example Response { "meta": { - "previous": null, - "total_count": 0, - "offset": 0, - "limit": 1, - "next": null - }, - "objects": [] + "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 diff --git a/source/api/references_auto_generated/sampleattributedatatype.rst b/source/api/references_auto_generated/sampleattributedatatype.rst index 7c1554d..3f00d18 100644 --- a/source/api/references_auto_generated/sampleattributedatatype.rst +++ b/source/api/references_auto_generated/sampleattributedatatype.rst @@ -17,13 +17,13 @@ field help text default nullable readonl ================ ====================================== ======= ======== ======== ===== ====== ======= **dataType** 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 ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **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 ---------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**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 ================ ====================================== ======= ======== ======== ===== ====== ======= Example Response @@ -33,19 +33,19 @@ Example Response { "meta": { - "previous": null, - "total_count": 2, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/sampleattributedatatype/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/sampleattributedatatype/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "dataType": "Text", - "resource_uri": "/rundb/api/v1/sampleattributedatatype/1/", - "description": "Up to 1024 characters", - "isActive": true, - "id": 1 + "dataType": "Integer", + "description": "Whole number", + "id": 2, + "isActive": true, + "resource_uri": "/rundb/api/v1/sampleattributedatatype/2/" } ] } diff --git a/source/api/references_auto_generated/samplegrouptype_cv.rst b/source/api/references_auto_generated/samplegrouptype_cv.rst index fd45348..bd5d322 100644 --- a/source/api/references_auto_generated/samplegrouptype_cv.rst +++ b/source/api/references_auto_generated/samplegrouptype_cv.rst @@ -15,27 +15,27 @@ Resource Fields ======================== ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ======================== ================================================================================================== ======= ======== ======== ===== ====== ======= -**isIRCompatible** Boolean data. Ex: True false false false true false boolean ------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- **description** Unicode string data. Ex: "Hello World" n/a true false 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 ------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- **displayedName** Unicode string data. Ex: "Hello World" n/a false false false true string ------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**iRValue** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- **iRAnnotationType** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**uid** Unicode string data. Ex: "Hello World" n/a false false false true 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 +**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 @@ -45,28 +45,25 @@ Example Response { "meta": { - "previous": null, - "total_count": 7, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/samplegrouptype_cv/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/samplegrouptype_cv/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 7 + }, "objects": [ { - "isIRCompatible": true, - "description": "", - "sampleAnnotation_set": [ - "/rundb/api/v1/sampleannotation_cv/1/", - "/rundb/api/v1/sampleannotation_cv/2/" - ], - "displayedName": "Sample_Control", - "iRValue": "Paired_Sample|Sample_Control", - "iRAnnotationType": "RelationshipType", - "uid": "SAMPLEGROUP_CV_0001", - "sampleSets": [], - "id": 1, - "isActive": true, - "resource_uri": "/rundb/api/v1/samplegrouptype_cv/1/" + "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" } ] } diff --git a/source/api/references_auto_generated/sampleprepdata.rst b/source/api/references_auto_generated/sampleprepdata.rst index b1f9cc6..fa9b897 100644 --- a/source/api/references_auto_generated/sampleprepdata.rst +++ b/source/api/references_auto_generated/sampleprepdata.rst @@ -15,51 +15,51 @@ Resource Fields ======================= ==================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ======================= ==================================================== ======= ======== ======== ===== ====== ======== -**instrumentName** 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 ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**kitType** Unicode string data. Ex: "Hello World" false false true false string +**id** Integer data. Ex: 2673 false false true true integer ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**tipRackBarcode** Unicode string data. Ex: "Hello World" false false true false string +**instrumentName** Unicode string data. Ex: "Hello World" false false true false string ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**remainingSeconds** Integer data. Ex: 2673 n/a true false false false integer +**instrumentStatus** Unicode string data. Ex: "Hello World" false false true false string ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reagentsExpiration** Unicode string data. Ex: "Hello World" false false true false string +**kitType** Unicode string data. Ex: "Hello World" false false true false string ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**instrumentStatus** 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 ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**solutionsExpiration** Unicode string data. Ex: "Hello World" false false true false string +**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 ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer ------------------------ ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reagentsPart** 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 ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**reagentsExpiration** Unicode string data. Ex: "Hello World" false false true false string ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**solutionsLot** Unicode string data. Ex: "Hello World" false false true false string +**reagentsLot** Unicode string data. Ex: "Hello World" false false true false string ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**scriptVersion** Unicode string data. Ex: "Hello World" false false true false string +**reagentsPart** 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 +**remainingSeconds** Integer data. Ex: 2673 n/a true false false false integer ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**operationMode** 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 ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **samplePrepDataType** Unicode string data. Ex: "Hello World" false false true false string ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**solutionsPart** Unicode string data. Ex: "Hello World" false false true false string +**scriptVersion** Unicode string data. Ex: "Hello World" false false true false string ----------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- -**reagentsLot** Unicode string data. Ex: "Hello World" false false true false string +**solutionsExpiration** 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 +**solutionsLot** 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 +**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 @@ -69,12 +69,12 @@ Example Response { "meta": { - "previous": null, - "total_count": 0, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 0 + }, "objects": [] } diff --git a/source/api/references_auto_generated/sampleset.rst b/source/api/references_auto_generated/sampleset.rst index a311b9d..c988d79 100644 --- a/source/api/references_auto_generated/sampleset.rst +++ b/source/api/references_auto_generated/sampleset.rst @@ -15,45 +15,49 @@ Resource Fields ================================ ================================================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================================ ================================================================================================== ======= ======== ======== ===== ====== ======== -**status** Unicode string data. Ex: "Hello World" false false true false string --------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepInstrument** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepType** Unicode string data. Ex: "Hello World" false false true false string +**additionalCycles** 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 +**combinedLibraryTubeLabel** Unicode string data. Ex: "Hello World" false false true false string -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**description** Unicode string data. Ex: "Hello World" n/a true false false false string +**creationDate** 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 +**cyclingProtocols** Unicode string data. Ex: "Hello World" n/a true false false false string -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleCount** Integer data. Ex: 2673 n/a false true false false integer +**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 -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**SampleGroupType_CV** 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 -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**pcrPlateSerialNum** Unicode string data. Ex: "Hello World" true false false false string +**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 -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**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 +**libraryPrepPlateType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**lastModifiedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime +**libraryPrepType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**sampleGroupTypeName** Unicode string data. Ex: "Hello World" n/a true true true false string +**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**combinedLibraryTubeLabel** Unicode string data. Ex: "Hello World" false false true false string +**pcrPlateSerialNum** 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 +**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepTypeDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string +**sampleCount** Integer data. Ex: 2673 n/a false true false false integer -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**sampleGroupTypeName** Unicode string data. Ex: "Hello World" n/a true true true false string -------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- -**libraryPrepKitDisplayedName** 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 @@ -63,44 +67,46 @@ Example Response { "meta": { - "previous": null, - "total_count": 2, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/sampleset/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/sampleset/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 2 + }, "objects": [ { - "readyForPlanning": true, - "status": "created", - "libraryPrepInstrument": "", - "libraryPrepType": "", - "libraryPrepPlateType": "", - "description": "", - "resource_uri": "/rundb/api/v1/sampleset/1/", - "sampleCount": 8, - "displayedName": "Ampliseq on Chef", - "SampleGroupType_CV": null, - "pcrPlateSerialNum": "", - "libraryPrepInstrumentData": null, - "libraryPrepKitName": "", + "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/3/", - "/rundb/api/v1/samplesetitem/5/", - "/rundb/api/v1/samplesetitem/7/", - "/rundb/api/v1/samplesetitem/9/", - "/rundb/api/v1/samplesetitem/11/", - "/rundb/api/v1/samplesetitem/13/", - "/rundb/api/v1/samplesetitem/15/", - "/rundb/api/v1/samplesetitem/17/" - ], - "lastModifiedDate": "2017-08-28T21:21:14.000027+00:00", - "sampleGroupTypeName": "", - "combinedLibraryTubeLabel": "", - "creationDate": "2017-08-28T21:21:14.000027+00:00", - "libraryPrepTypeDisplayedName": "", - "id": 1, - "libraryPrepKitDisplayedName": "" + "/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" } ] } diff --git a/source/api/references_auto_generated/samplesetitem.rst b/source/api/references_auto_generated/samplesetitem.rst index 9b0a49a..6b4d6ae 100644 --- a/source/api/references_auto_generated/samplesetitem.rst +++ b/source/api/references_auto_generated/samplesetitem.rst @@ -12,51 +12,67 @@ Sample Set Item Resource Resource Fields --------------- -===================== ============================================================================== ======= ======== ======== ===== ====== ======== -field help text default nullable readonly blank unique type -===================== ============================================================================== ======= ======== ======== ===== ====== ======== -**sample** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**cellNum** Unicode string data. Ex: "Hello World" true false false false string ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**biopsyDays** Integer data. Ex: 2673 0 true false false false integer ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true false string ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**gender** 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 ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**coupleId** Unicode string data. Ex: "Hello World" true false false false string ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**cellularityPct** Integer data. Ex: 2673 n/a true false false false integer ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**relationshipRole** 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 ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**cancerType** Unicode string data. Ex: "Hello World" n/a true false false false string ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**controlType** Unicode string data. Ex: "Hello World" true false false false string ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sampleSet** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**lastModifiedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**dnabarcode** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**pcrPlateRow** 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 ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**embryoId** Unicode string data. Ex: "Hello World" true false false false string ---------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**description** Unicode string data. Ex: "Hello World" true false false false string -===================== ============================================================================== ======= ======== ======== ===== ====== ======== +======================== ============================================================================== ======= ======== ======== ===== ====== ======== +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 ^^^^^^^^^^^^^^^^ @@ -65,35 +81,43 @@ Example Response { "meta": { - "previous": null, - "total_count": 16, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/samplesetitem/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/samplesetitem/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 16 + }, "objects": [ { - "sample": "/rundb/api/v1/sample/8/", - "cellNum": "", - "biopsyDays": 0, - "resource_uri": "/rundb/api/v1/samplesetitem/3/", - "nucleotideType": "", - "gender": "", - "relationshipGroup": 0, - "coupleId": "", - "cellularityPct": null, - "id": 3, - "relationshipRole": "", - "pcrPlateColumn": "", - "cancerType": "", - "controlType": "", - "sampleSet": "/rundb/api/v1/sampleset/1/", - "lastModifiedDate": "2017-11-01T16:19:12.000420+00:00", - "dnabarcode": null, - "pcrPlateRow": "", - "creationDate": "2017-11-01T16:19:12.000420+00:00", - "embryoId": "", - "description": "" + "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": "" } ] } diff --git a/source/api/references_auto_generated/samplesetiteminfo.rst b/source/api/references_auto_generated/samplesetiteminfo.rst index b6341b5..67ef314 100644 --- a/source/api/references_auto_generated/samplesetiteminfo.rst +++ b/source/api/references_auto_generated/samplesetiteminfo.rst @@ -12,65 +12,81 @@ Sample Set Item Info Resource Resource Fields --------------- -======================= ============================================================================== ======= ======== ======== ===== ====== ======== -field help text default nullable readonly blank unique type -======================= ============================================================================== ======= ======== ======== ===== ====== ======== -**relationshipGroup** Integer data. Ex: 2673 n/a true true true false integer ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sampleDescription** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**dnabarcodeKit** Unicode string data. Ex: "Hello World" n/a true true true 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 ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**pcrPlateColumn** Unicode string data. Ex: "Hello World" true false false false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**cancerType** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sampleDisplayedName** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**cellNum** Unicode string data. Ex: "Hello World" true false false false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sampleExternalId** Unicode string data. Ex: "Hello World" n/a true true true false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**coupleId** Unicode string data. Ex: "Hello World" true false false false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**pcrPlateRow** Unicode string data. Ex: "Hello World" true false false false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**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 ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**embryoId** Unicode string data. Ex: "Hello World" true false false false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**sampleSet** A single related resource. Can be either a URI or set of nested resource data. n/a true false true false related ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**description** Unicode string data. Ex: "Hello World" true false false false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**lastModifiedDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**relationshipRole** 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 ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**dnabarcode** A single related resource. Can be either a URI or set of nested resource data. n/a true true true false related ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**creationDate** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**biopsyDays** Integer data. Ex: 2673 0 true false false false integer ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true false string ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**gender** Unicode string data. Ex: "Hello World" n/a 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 ------------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string -======================= ============================================================================== ======= ======== ======== ===== ====== ======== +======================== ============================================================================== ======= ======== ======== ===== ====== ======== +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 ^^^^^^^^^^^^^^^^ @@ -79,44 +95,55 @@ Example Response { "meta": { - "previous": null, - "total_count": 16, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/samplesetiteminfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/samplesetiteminfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 16 + }, "objects": [ { - "relationshipGroup": 0, - "sampleDescription": "", - "dnabarcodeKit": "", - "sample": "/rundb/api/v1/sample/8/", - "pcrPlateColumn": "", - "cancerType": "", - "attribute_dict": {}, - "id": 3, - "sampleDisplayedName": "1", - "cellNum": "", - "sampleExternalId": "", - "coupleId": "", - "pcrPlateRow": "", - "sampleSetPk": 1, - "sampleSetStatus": "created", - "embryoId": "", - "sampleSet": "/rundb/api/v1/sampleset/1/", - "description": "", - "lastModifiedDate": "2017-11-01T16:19:12.000420+00:00", - "sampleSetGroupType": "", - "relationshipRole": "", - "samplePk": 8, - "dnabarcode": "", - "creationDate": "2017-11-01T16:19:12.000420+00:00", - "biopsyDays": 0, - "nucleotideType": "", - "gender": "", - "cellularityPct": null, - "controlType": "", - "resource_uri": "/rundb/api/v1/samplesetiteminfo/3/" + "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": "" } ] } diff --git a/source/api/references_auto_generated/sequencingkitinfo.rst b/source/api/references_auto_generated/sequencingkitinfo.rst index 789d833..ac41a78 100644 --- a/source/api/references_auto_generated/sequencingkitinfo.rst +++ b/source/api/references_auto_generated/sequencingkitinfo.rst @@ -15,47 +15,47 @@ Resource Fields ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ============================================ ================================================================================================== ======= ======== ======== ===== ====== ======= -**isActive** Boolean data. Ex: True true false false true false boolean --------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**applicationType** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string +**cartridgeBetweenUsageAbsoluteMaxDayLimit** 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 +**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**name** Unicode string data. Ex: "Hello World" n/a false false false true string +**categories** Unicode string data. Ex: "Hello World" true false false false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**nucleotideType** Unicode string data. Ex: "Hello World" false false true 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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**instrumentType** Unicode string data. Ex: "Hello World" false false true false string +**defaultFlowOrder** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**chipTypes** Unicode string data. Ex: "Hello World" false false true false string +**description** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" false false true false string +**flowCount** Integer data. Ex: 2673 n/a false false false false integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +**id** Integer data. Ex: 2673 false false true true integer -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**flowCount** Integer data. Ex: 2673 n/a false false false false integer +**instrumentType** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**applicationType** Unicode string data. Ex: "Hello World" true false false false string +**isActive** Boolean data. Ex: True true false false true false boolean -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeExpirationDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**cartridgeBetweenUsageAbsoluteMaxDayLimit** Integer data. Ex: 2673 n/a true false false false integer +**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 +**nucleotideType** 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 +**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**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 -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**categories** Unicode string data. Ex: "Hello World" true false false false string +**runMode** Unicode string data. Ex: "Hello World" false false true false string -------------------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ ------- -**description** 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 @@ -65,54 +65,60 @@ Example Response { "meta": { - "previous": null, - "total_count": 28, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/sequencingkitinfo/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/sequencingkitinfo/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 27 + }, "objects": [ { - "isActive": true, - "samplePrep_instrumentType": "OT_IC", - "kitType": "SequencingKit", - "defaultFlowOrder": null, - "name": "IonPGMInstallKit", - "nucleotideType": "", - "defaultCartridgeUsageCount": null, - "instrumentType": "pgm", - "chipTypes": "", - "runMode": "", + "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": "4480217", - "id": 20019, - "resource_uri": "/rundb/api/v1/kitpart/20019/", - "kit": "/rundb/api/v1/kitinfo/20020/" - }, + "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": "4480282", - "id": 20020, - "resource_uri": "/rundb/api/v1/kitpart/20020/", - "kit": "/rundb/api/v1/kitinfo/20020/" - }, + "barcode": "A33208", + "id": 20260, + "kit": "/rundb/api/v1/kitinfo/20111/", + "resource_uri": "/rundb/api/v1/kitpart/20260/" + }, { - "barcode": "4480284", - "id": 20021, - "resource_uri": "/rundb/api/v1/kitpart/20021/", - "kit": "/rundb/api/v1/kitinfo/20020/" + "barcode": "100049484", + "id": 20263, + "kit": "/rundb/api/v1/kitinfo/20111/", + "resource_uri": "/rundb/api/v1/kitpart/20263/" } - ], - "flowCount": 100, - "applicationType": "", - "cartridgeExpirationDayLimit": null, - "libraryReadLength": 0, - "cartridgeBetweenUsageAbsoluteMaxDayLimit": null, - "resource_uri": "/rundb/api/v1/sequencingkitinfo/20020/", - "uid": "SEQ0006", - "id": 20020, - "categories": "readLengthDerivableFromFlows;", - "description": "Ion PGM Install Kit" + ], + "resource_uri": "/rundb/api/v1/sequencingkitinfo/20111/", + "runMode": "", + "samplePrep_instrumentType": "", + "uid": "SEQ0028" } ] } diff --git a/source/api/references_auto_generated/sequencingkitpart.rst b/source/api/references_auto_generated/sequencingkitpart.rst index a7c8299..3ea487c 100644 --- a/source/api/references_auto_generated/sequencingkitpart.rst +++ b/source/api/references_auto_generated/sequencingkitpart.rst @@ -15,15 +15,15 @@ Resource Fields ==================== ============================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ==================== ============================================================================== ======= ======== ======== ===== ====== ======= -**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string --------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- **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 -------------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**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 ==================== ============================================================================== ======= ======== ======== ===== ====== ======= Example Response @@ -33,19 +33,19 @@ Example Response { "meta": { - "previous": null, - "total_count": 104, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/sequencingkitpart/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/sequencingkitpart/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 99 + }, "objects": [ { - "resource_uri": "/rundb/api/v1/sequencingkitpart/20021/", - "barcode": "4480284", - "defaultFlowOrder": null, - "kit": "/rundb/api/v1/kitinfo/20020/", - "id": 20021 + "barcode": "100049484", + "defaultFlowOrder": null, + "id": 20263, + "kit": "/rundb/api/v1/kitinfo/20111/", + "resource_uri": "/rundb/api/v1/sequencingkitpart/20263/" } ] } diff --git a/source/api/references_auto_generated/supportupload.rst b/source/api/references_auto_generated/supportupload.rst index 0fc657d..3d568ad 100644 --- a/source/api/references_auto_generated/supportupload.rst +++ b/source/api/references_auto_generated/supportupload.rst @@ -15,33 +15,33 @@ Resource Fields ================== ============================================================================== ======= ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================== ============================================================================== ======= ======== ======== ===== ====== ======== -**ticket_id** Unicode string data. Ex: "Hello World" false false true false string +**celery_task_id** 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 +**contact_email** Unicode string data. Ex: "Hello World" false false false false string ------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**local_message** 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 ------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- **description** 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 +**file** A single related resource. Can be either a URI or set of nested resource data. n/a true false false false related ------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**ticket_status** Unicode string data. Ex: "Hello World" false false true false string +**id** Integer data. Ex: 2673 false false true true integer ------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**contact_email** Unicode string data. Ex: "Hello World" false false false false string +**local_message** Unicode string data. Ex: "Hello World" false false true 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 +**local_status** Unicode string data. Ex: "Hello World" false false true 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 +**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string ------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**celery_task_id** Unicode string data. Ex: "Hello World" false false true 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_message** Unicode string data. Ex: "Hello World" false false true false string +**ticket_id** Unicode string data. Ex: "Hello World" false false true false string ------------------ ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer +**ticket_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 +**ticket_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 +**updated** A date & time as a string. Ex: "2010-11-10T03:07:43" true false false true false datetime ================== ============================================================================== ======= ======== ======== ===== ====== ======== Example Response @@ -51,12 +51,12 @@ Example Response { "meta": { - "previous": null, - "total_count": 0, - "offset": 0, - "limit": 1, - "next": null - }, + "limit": 1, + "next": null, + "offset": 0, + "previous": null, + "total_count": 0 + }, "objects": [] } diff --git a/source/api/references_auto_generated/template.rst b/source/api/references_auto_generated/template.rst index 84418b2..089a951 100644 --- a/source/api/references_auto_generated/template.rst +++ b/source/api/references_auto_generated/template.rst @@ -15,19 +15,19 @@ Resource Fields ================ ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================ ====================================== ======= ======== ======== ===== ====== ======= -**isofficial** Boolean data. Ex: True true false false true false boolean ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**name** Unicode string data. Ex: "Hello World" n/a false false false false string +**comments** Unicode string data. Ex: "Hello World" false false true false string ---------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**sequence** Unicode string data. Ex: "Hello World" false false true false string +**id** Integer data. Ex: 2673 false false true true integer ---------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**comments** Unicode string data. Ex: "Hello World" false false true false string +**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 ---------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**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 +---------------- -------------------------------------- ------- -------- -------- ----- ------ ------- +**sequence** Unicode string data. Ex: "Hello World" false false true false string ================ ====================================== ======= ======== ======== ===== ====== ======= Example Response @@ -37,21 +37,21 @@ Example Response { "meta": { - "previous": null, - "total_count": 6, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/template/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/template/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 6 + }, "objects": [ { - "isofficial": true, - "name": "TF_A", - "sequence": "TGTTTTAGGGTCCCCGGGGTTAAAAGGTTTCGAACTCAACAGCTGTCTGGCAGCTCGCTCTACGATCTGAGACTGCCAAGGCACACAGGGGATAGG", - "comments": " ", - "key": "ATCG", - "id": 1, - "resource_uri": "/rundb/api/v1/template/1/" + "comments": " ", + "id": 6, + "isofficial": true, + "key": "ATCG", + "name": "TF_1", + "resource_uri": "/rundb/api/v1/template/6/", + "sequence": "GAATAATCCAGCCCGCCAGGCATGGAAGAGCGTCGTAAAGTATTGCAGGTTCAGGCGGCGGAAAGCGTGATTGACTACTGGCAAATAAAGTACGTTCCACCTTTGACACCATTTTCCGTAGTGAACTGACGCTGCCAAACGCCGACCGCG" } ] } diff --git a/source/api/references_auto_generated/tfmetrics.rst b/source/api/references_auto_generated/tfmetrics.rst index 8b8ad9a..c1951e2 100644 --- a/source/api/references_auto_generated/tfmetrics.rst +++ b/source/api/references_auto_generated/tfmetrics.rst @@ -15,39 +15,39 @@ Resource Fields ================ ============================================================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================ ============================================================================== ======= ======== ======== ===== ====== ======= -**corrHPSNR** Unicode string data. Ex: "Hello World" false false true false string +**HPAccuracy** 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 +**Q10Histo** Unicode string data. Ex: "Hello World" false false true false string ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**SysSNR** Floating point numeric data. Ex: 26.73 n/a false false false false float +**Q10Mean** Floating point numeric data. Ex: 26.73 n/a false false false false float ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**HPAccuracy** Unicode string data. Ex: "Hello World" false false true false string +**Q10ReadCount** 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 +**Q17Histo** Unicode string data. Ex: "Hello World" false false true false string ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**sequence** Unicode string data. Ex: "Hello World" n/a false false false false string +**Q17Mean** 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 +**Q17ReadCount** 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 +**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 ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**number** 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 ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**Q10ReadCount** 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 ---------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**Q17Mean** Floating point numeric data. Ex: 26.73 n/a false false false false float ----------------- ------------------------------------------------------------------------------ ------- -------- -------- ----- ------ ------- -**Q10Histo** Unicode string data. Ex: "Hello World" false false true false string +**sequence** Unicode string data. Ex: "Hello World" n/a false false false false string ================ ============================================================================== ======= ======== ======== ===== ====== ======= Example Response @@ -57,31 +57,31 @@ Example Response { "meta": { - "previous": null, - "total_count": 10, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/tfmetrics/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/tfmetrics/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 10 + }, "objects": [ { - "corrHPSNR": "", - "Q10Mean": 92, - "SysSNR": 8.90596237826753, - "HPAccuracy": "0 : 92614661/92987980, 1 : 66459432/67074439, 2 : 2982150/3047963, 3 : 0/0, 4 : 701514/761937, 5 : 0/0, 6 : 0/0, 7 : 0/0", - "Q17ReadCount": 663166, - "sequence": "TACGAGCGTGTAGACGTGTCGTACGTGCGACGTAGTGAGTATACATGCTCTGACACTATGTACGATCTGAGACTGCCAAGGCACACAGGGGATAGG", - "Q17Histo": "6186 2376 12408 3441 8 196 6739 944 62 3088 1321 1740 5837 11552 5171 6973 3499 3109 2311 5441 1418 861 889 476 632 693 1993 587 208 2048 844 951 799 535 202 53 989 443 213 222 160 499 378 235 56 39 90 71 81 57 2773 919 753 845 411 2087 578 481 895 330 492 337 365 1146 474 624 457 442 282 657 888 422 270 290 412 457 1321 78 431 97 612 84 734 210 135 550 274 1025 151 1225 20936 9776 1625 338 780 18329 551335 35033 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0", - "name": "TF_C", - "aveKeyCount": 95, - "number": 762290, - "id": 1, - "keypass": 762290, - "Q10ReadCount": 732661, - "report": "/rundb/api/v1/results/3/", - "resource_uri": "/rundb/api/v1/tfmetrics/1/", - "Q17Mean": 83, - "Q10Histo": "1963 514 2070 833 2 15 20 52 29 47 959 452 1823 2178 2099 2088 1338 678 623 514 695 769 435 231 218 209 304 449 377 132 307 482 698 667 494 262 254 250 389 312 653 356 312 392 457 376 233 206 171 242 355 428 368 376 328 274 160 128 127 117 208 147 128 140 112 122 101 86 101 116 167 130 137 107 110 134 188 165 147 120 189 174 179 153 208 284 358 416 548 1770 22262 10956 4925 3780 3745 21341 555735 39369 18315 11400 8819 7006 5487 4258 3206 1865 586 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0" + "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" } ] } diff --git a/source/api/references_auto_generated/threeprimeadapter.rst b/source/api/references_auto_generated/threeprimeadapter.rst index 4c1ccb9..93f34cc 100644 --- a/source/api/references_auto_generated/threeprimeadapter.rst +++ b/source/api/references_auto_generated/threeprimeadapter.rst @@ -15,27 +15,27 @@ Resource Fields ================= ====================================== ======= ======== ======== ===== ====== ======= field help text default nullable readonly blank unique type ================= ====================================== ======= ======== ======== ===== ====== ======= -**direction** Unicode string data. Ex: "Hello World" Forward false false false false string +**chemistryType** Unicode string data. Ex: "Hello World" false false true false string ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- **description** Unicode string data. Ex: "Hello World" false false true false string ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**sequence** Unicode string data. Ex: "Hello World" n/a false false false false string ------------------ -------------------------------------- ------- -------- -------- ----- ------ ------- -**chemistryType** Unicode string data. Ex: "Hello World" false false true false string +**direction** Unicode string data. Ex: "Hello World" Forward false false false false string ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**runMode** Unicode string data. Ex: "Hello World" single 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 ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**uid** Unicode string data. Ex: "Hello World" n/a false false false true string +**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 ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**id** Integer data. Ex: 2673 false false true true integer +**runMode** Unicode string data. Ex: "Hello World" single false false true false string ----------------- -------------------------------------- ------- -------- -------- ----- ------ ------- -**isDefault** Boolean data. Ex: True false false false true false boolean +**sequence** 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 true string +**uid** Unicode string data. Ex: "Hello World" n/a false false false true string ================= ====================================== ======= ======== ======== ===== ====== ======= Example Response @@ -45,25 +45,25 @@ Example Response { "meta": { - "previous": null, - "total_count": 8, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/threeprimeadapter/?offset=1&limit=1&format=json" - }, + "limit": 1, + "next": "/rundb/api/v1/threeprimeadapter/?offset=1&limit=1&format=json", + "offset": 0, + "previous": null, + "total_count": 8 + }, "objects": [ { - "direction": "Forward", - "description": "Default forward adapter", - "sequence": "ATCACCGACTGCCCATAGAGAGGCTGAGAC", - "chemistryType": "", - "runMode": "single", - "isActive": true, - "uid": "FWD_0001", - "resource_uri": "/rundb/api/v1/threeprimeadapter/1/", - "id": 1, - "isDefault": true, - "name": "Ion P1B" + "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" } ] } diff --git a/source/api/references_auto_generated/torrentsuite.rst b/source/api/references_auto_generated/torrentsuite.rst index 91017d4..728de15 100644 --- a/source/api/references_auto_generated/torrentsuite.rst +++ b/source/api/references_auto_generated/torrentsuite.rst @@ -30,25 +30,25 @@ Example Response .. code-block:: javascript { - "meta_version": "5.10.0", - "locked": false, - "logs": false, + "locked": false, + "logs": false, + "meta_version": "5.12.1", "versions": { - "ion-docs": "5.10.2", - "ion-gpu": "5.10.0-1", - "ion-pipeline": "5.10.8-1", - "ion-torrentpy": "5.10.8-1", - "ion-tsconfig": "5.10.4-1", - "ion-chefupdates": "5.10.0", - "ion-rsmts": "5.6.1-1", - "ion-sampledata": "1.2.0-1", - "ion-publishers": "5.10.2-1", - "ion-dbreports": "5.10.26-1", - "ion-analysis": "5.10.10-1", - "ion-onetouchupdater": "5.0.2-1", - "ion-torrentr": "5.10.9-1", - "ion-plugins": "5.10.12-1", - "ion-referencelibrary": "2.2.0" + "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" } } diff --git a/source/api/references_auto_generated/user.rst b/source/api/references_auto_generated/user.rst index 5ed282c..2b0e2db 100644 --- a/source/api/references_auto_generated/user.rst +++ b/source/api/references_auto_generated/user.rst @@ -15,27 +15,27 @@ Resource Fields ================ ===================================================================================================== ================================ ======== ======== ===== ====== ======== field help text default nullable readonly blank unique type ================ ===================================================================================================== ================================ ======== ======== ===== ====== ======== -**profile** A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related +**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 ---------------- ----------------------------------------------------------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**username** Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters n/a false false false true string +**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 ---------------- ----------------------------------------------------------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**last_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 ---------------- ----------------------------------------------------------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**email** Unicode string data. Ex: "Hello World" false false true false string +**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_login** A date & time as a string. Ex: "2010-11-10T03:07:43" 2018-06-19T20:40:18.000722+00:00 false false false false datetime +**last_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 +**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 ---------------- ----------------------------------------------------------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**id** Integer data. Ex: 2673 false false true true integer ----------------- ----------------------------------------------------------------------------------------------------- -------------------------------- -------- -------- ----- ------ -------- -**date_joined** A date & time as a string. Ex: "2010-11-10T03:07:43" 2018-06-19T20:40:18.000722+00:00 false false false false datetime +**username** Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters n/a false false false true string ================ ===================================================================================================== ================================ ======== ======== ===== ====== ======== Example Response @@ -45,33 +45,34 @@ Example Response { "meta": { - "previous": null, - "total_count": 6, - "offset": 0, - "limit": 1, - "next": "/rundb/api/v1/user/?offset=1&limit=1&format=json" - }, + "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": { - "phone_number": "", - "name": "", - "title": "Lab Contact", - "last_read_news_post": "1984-11-06T00:00:00+00:00", - "note": "", - "id": 3, - "resource_uri": "" - }, - "username": "lab_contact", - "first_name": "", - "last_name": "", - "is_active": true, - "email": "ionuser@iontorrent.com", - "last_login": "2017-07-22T06:43:37.000251+00:00", - "full_name": "", - "resource_uri": "/rundb/api/v1/user/3/", - "id": 3, - "date_joined": "2017-07-22T06:43:37.000251+00:00" + "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" } ] } diff --git a/source/conf.py b/source/conf.py index f1a070f..9c740be 100644 --- a/source/conf.py +++ b/source/conf.py @@ -43,16 +43,16 @@ # General information about the project. project = u'Ion Torrent SDK' -copyright = u'2018 Thermo Fisher Scientific Inc. All rights reserved' +copyright = u'2019 Thermo Fisher Scientific Inc. All rights reserved' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '5.10' +version = '5.12' # The full version, including alpha/beta/rc tags. -release = '5.10' +release = '5.12.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -260,4 +260,4 @@ def setup(app): - app.add_stylesheet('theme_overrides.css') \ No newline at end of file + app.add_stylesheet('theme_overrides.css')