Onetouchplantemplate Resource¶

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

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

Fields table¶

field	help text	default	nullable	readonly	blank	unique	type
isReverseRun	Boolean data. Ex: True	false	false	false	true	false	boolean
planDisplayedName	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
sequencekitname	Unicode string data. Ex: “Hello World”		true	false	true	false	string
forward3primeadapter	Unicode string data. Ex: “Hello World”		true	false	true	false	string
preAnalysis	Boolean data. Ex: True	false	false	false	true	false	boolean
chipType	Unicode string data. Ex: “Hello World”		false	false	false	false	string
planShortID	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
sampleSetDisplayedName	Unicode string data. Ex: “Hello World”	n/a	true	true	true	false	string
sampleSetGroupType	Unicode string data. Ex: “Hello World”	n/a	true	true	true	false	string
library	Unicode string data. Ex: “Hello World”		true	false	true	false	string
planStatus	Unicode string data. Ex: “Hello World”		false	false	true	false	string
sample	Unicode string data. Ex: “Hello World”		true	false	true	false	string
reverselibrarykey	Unicode string data. Ex: “Hello World”		false	true	false	false	string
storage_options	Unicode string data. Ex: “Hello World”	A	false	false	false	false	string
planName	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
planExecutedDate	A date & time as a string. Ex: “2010-11-10T03:07:43”	n/a	true	false	false	false	datetime
samplePrepKitName	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
reverse_primer	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
applicationGroup	A single related resource. Can be either a URI or set of nested resource data.	n/a	true	false	true	false	related
seqKitBarcode	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
id	Integer data. Ex: 2673		false	false	true	true	integer
barcodedSamples	Unicode string data. Ex: “Hello World”		true	false	true	false	string
metaData	Unicode string data. Ex: “Hello World”	{}	false	false	true	false	string
sampleSet_uid	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
isFavorite	Boolean data. Ex: True	false	false	false	true	false	boolean
sampleSet_planIndex	Integer data. Ex: 2673	0	false	false	false	false	integer
barcodeId	Unicode string data. Ex: “Hello World”		true	false	true	false	string
runMode	Unicode string data. Ex: “Hello World”		false	false	true	false	string
regionfile	Unicode string data. Ex: “Hello World”		false	false	true	false	string
isPlanGroup	Boolean data. Ex: True	false	false	false	true	false	boolean
sampleSet_planTotal	Integer data. Ex: 2673	0	false	false	false	false	integer
selectedPlugins	Unicode string data. Ex: “Hello World”		true	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
bedfile	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
runType	Unicode string data. Ex: “Hello World”	GENS	false	false	false	false	string
templatingKitBarcode	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
sampleDisplayedName	Unicode string data. Ex: “Hello World”		true	false	true	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
planPGM	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
isSystemDefault	Boolean data. Ex: True	false	false	false	true	false	boolean
autoName	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
isReusable	Boolean data. Ex: True	false	false	false	true	false	boolean
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
isDuplicateReads	Boolean data. Ex: True	n/a	false	false	false	false	boolean
controlSequencekitname	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
tfKey	Unicode string data. Ex: “Hello World”		false	false	true	false	string
flows	Integer data. Ex: 2673	0	false	false	false	false	integer
sampleTubeLabel	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
librarykitname	Unicode string data. Ex: “Hello World”		true	false	true	false	string
isSystem	Boolean data. Ex: True	false	false	false	true	false	boolean
libkit	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
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
variantfrequency	Unicode string data. Ex: “Hello World”		false	true	false	false	string
autoAnalyze	Boolean data. Ex: True	n/a	false	false	false	false	boolean
flowsInOrder	Unicode string data. Ex: “Hello World”		true	false	true	false	string
parentPlan	Unicode string data. Ex: “Hello World”	None	false	false	true	false	string
childPlans	A list of data. Ex: [‘abc’, 26.73, 8]	[]	false	false	false	false	list
pairedEndLibraryAdapterName	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
adapter	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
irworkflow	Unicode string data. Ex: “Hello World”		false	false	true	false	string
chipBarcode	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
planExecuted	Boolean data. Ex: True	false	false	false	true	false	boolean
project	Unicode string data. Ex: “Hello World”	n/a	false	true	true	false	string
usePostBeadfind	Boolean data. Ex: True	false	false	false	true	false	boolean
storageHost	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
expName	Unicode string data. Ex: “Hello World”		false	false	true	false	string
runname	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
usePreBeadfind	Boolean data. Ex: True	false	false	false	true	false	boolean
planGUID	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
cycles	Integer data. Ex: 2673	n/a	true	false	false	false	integer
notes	Unicode string data. Ex: “Hello World”		true	false	true	false	string
resource_uri	Unicode string data. Ex: “Hello World”	n/a	false	true	false	false	string

Example request¶

Request URL: http://mytorrentserver/rundb/api/v1/onetouchplantemplate/?format=json&limit=1

Python example¶

import requests

ts_api_request = requests.get("http://mytorrentserver/rundb/api/v1/onetouchplantemplate/", params={"format": "json", "limit": 1})
ts_api_response = ts_api_request.json()

onetouchplantemplates = ts_api_response["objects"]

for onetouchplantemplate in onetouchplantemplates:
    print onetouchplantemplate

Torrent Server response¶

{
    "meta": {
        "previous": null,
        "total_count": 22,
        "offset": 0,
        "limit": 1,
        "next": "/rundb/api/v1/onetouchplantemplate/?offset=1&limit=1&format=json"
    },
    "objects": [
        {
            "planDisplayedName": "Ion 16S Metagenomics Template",
            "autoAnalyze": true,
            "templatingKitBarcode": null,
            "preAnalysis": true,
            "thumbnailanalysisargs": "",
            "applicationGroup": "/rundb/api/v1/applicationgroup/3/",
            "libkit": null,
            "planPGM": "",
            "prebasecallerargs": "",
            "alignmentargs": "",
            "thumbnailbasecallerargs": "",
            "sampleSet_planTotal": 0,
            "projects": [],
            "notes": "",
            "sequencekitname": "IonPGM400Kit",
            "storageHost": null,
            "expName": "",
            "cycles": null,
            "isReverseRun": false,
            "storage_options": "A",
            "thumbnailalignmentargs": "",
            "chipType": "316v2",
            "library": "",
            "reverselibrarykey": "",
            "planName": "Ion_16S_Metagenomics_Template",
            "seqKitBarcode": null,
            "barcodeId": "",
            "isPlanGroup": false,
            "experiment": "/rundb/api/v1/experiment/12421/",
            "bedfile": "",
            "isReusable": true,
            "isDuplicateReads": false,
            "thumbnailbeadfindargs": "",
            "librarykitname": "IonPlusFragmentLibKit",
            "adapter": null,
            "basecallerargs": "",
            "parentPlan": null,
            "forward3primeadapter": "ATCACCGACTGCCCATAGAGAGGCTGAGAC",
            "planStatus": "planned",
            "samplePrepKitName": null,
            "metaData": {},
            "sampleSet_uid": null,
            "isFavorite": false,
            "sampleSet_planIndex": 0,
            "qcValues": [
                {
                    "threshold": 30,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/44330/",
                    "id": 119818,
                    "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/119818/"
                },
                {
                    "threshold": 30,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/44330/",
                    "id": 119819,
                    "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/119819/"
                },
                {
                    "threshold": 30,
                    "plannedExperiment": "/rundb/api/v1/plannedexperiment/44330/",
                    "id": 119820,
                    "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/119820/"
                }
            ],
            "analysisargs": "",
            "templatingKitName": "Ion PGM Template OT2 400 Kit",
            "runType": "TARS_16S",
            "username": null,
            "planShortID": "7GYXS",
            "sampleDisplayedName": "",
            "prethumbnailbasecallerargs": "",
            "controlSequencekitname": null,
            "flowsInOrder": "",
            "childPlans": [],
            "pairedEndLibraryAdapterName": null,
            "runMode": "single",
            "irworkflow": "",
            "planExecuted": false,
            "project": "",
            "usePostBeadfind": true,
            "runname": null,
            "planGUID": "3d004b04-faf0-41a2-a6d3-ccc793fb4c04",
            "sampleTubeLabel": null,
            "sampleSetGroupType": null,
            "sample": "",
            "planExecutedDate": null,
            "reverse_primer": null,
            "id": 44330,
            "barcodedSamples": {},
            "regionfile": "",
            "selectedPlugins": {},
            "beadfindargs": "",
            "sampleSet": null,
            "isSystemDefault": false,
            "autoName": null,
            "libraryKey": "TCAG",
            "flows": 850,
            "date": "2013-11-05T16:23:42.000914+00:00",
            "isSystem": true,
            "variantfrequency": "",
            "sampleSetDisplayedName": "",
            "tfKey": "",
            "sampleGrouping": "/rundb/api/v1/samplegrouptype_cv/2/",
            "chipBarcode": "",
            "usePreBeadfind": true,
            "resource_uri": "/rundb/api/v1/onetouchplantemplate/44330/",
            "reverse3primeadapter": ""
        }
    ]
}

Allowed HTTP methods¶

get
post
put
delete
patch

Table of contents

Onetouchplantemplate Resource

Previous topic

Obsoletereferencegenome Resource

Next topic

Onetouchplantemplatesummary Resource

This Page