Availableplannedexperimentsummary Resource

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

Schema URL: http://mytorrentserver/rundb/api/v1/availableplannedexperimentsummary/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
storage_options	Unicode string data. Ex: “Hello World”	A	false	false	false	false	string
preAnalysis	Boolean data. Ex: True		false	false	true	false	boolean
planShortID	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
planStatus	Unicode string data. Ex: “Hello World”		false	false	true	false	string
runMode	Unicode string data. Ex: “Hello World”		false	false	true	false	string
templatingKitBarcode	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
planExecutedDate	A date & time as a string. Ex: “2010-11-10T03:07:43”	n/a	true	false	false	false	datetime
samplePrepKitName	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
reverse_primer	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
seqKitBarcode	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
id	Integer data. Ex: 2673		false	false	true	true	integer
metaData	Unicode string data. Ex: “Hello World”	{}	false	false	true	false	string
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
isPlanGroup	Boolean data. Ex: True	false	false	false	true	false	boolean
sampleSet_planTotal	Integer data. Ex: 2673	0	false	false	false	false	integer
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
planPGM	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
isSystemDefault	Boolean data. Ex: True	false	false	false	true	false	boolean
autoName	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
isReusable	Boolean data. Ex: True	false	false	false	true	false	boolean
controlSequencekitname	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
date	A date & time as a string. Ex: “2010-11-10T03:07:43”	n/a	true	false	false	false	datetime
isSystem	Boolean data. Ex: True	false	false	false	true	false	boolean
libkit	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
categories	Unicode string data. Ex: “Hello World”		true	false	false	false	string
planName	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
templatingSize	Unicode string data. Ex: “Hello World”		true	false	false	false	string
pairedEndLibraryAdapterName	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
adapter	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
irworkflow	Unicode string data. Ex: “Hello World”		false	false	true	false	string
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
username	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
usePostBeadfind	Boolean data. Ex: True		false	false	true	false	boolean
storageHost	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
expName	Unicode string data. Ex: “Hello World”		false	false	true	false	string
libraryReadLength	Integer data. Ex: 2673	0	false	false	false	false	integer
runname	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
usePreBeadfind	Boolean data. Ex: True		false	false	true	false	boolean
planGUID	Unicode string data. Ex: “Hello World”	n/a	true	false	false	false	string
cycles	Integer data. Ex: 2673	n/a	true	false	false	false	integer
resource_uri	Unicode string data. Ex: “Hello World”	n/a	false	true	false	false	string

Example request

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

Python example

import requests

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

availableplannedexperimentsummarys = ts_api_response["objects"]

for availableplannedexperimentsummary in availableplannedexperimentsummarys:
    print availableplannedexperimentsummary

Torrent Server response

{
    "meta": {
        "previous": null,
        "total_count": 95,
        "offset": 0,
        "limit": 1,
        "next": "/rundb/api/v1/availableplannedexperimentsummary/?offset=1&limit=1&format=json"
    },
    "objects": [
        {
            "isReverseRun": false,
            "planDisplayedName": "-R78595-2X_POU_L040_W3_3",
            "storage_options": "A",
            "preAnalysis": true,
            "planShortID": "FIWLX",
            "planStatus": "planned",
            "runMode": "single",
            "templatingKitBarcode": null,
            "sampleTubeLabel": "",
            "planExecutedDate": null,
            "samplePrepKitName": "Ion AmpliSeq Exome Kit",
            "reverse_primer": null,
            "seqKitBarcode": null,
            "id": 111207,
            "metaData": {},
            "sampleSet_uid": null,
            "isFavorite": true,
            "sampleSet_planIndex": 0,
            "isPlanGroup": false,
            "sampleSet_planTotal": 0,
            "templatingKitName": "Ion PI Hi-Q OT2 200 Kit",
            "runType": "AMPS_EXOME",
            "planPGM": null,
            "isSystemDefault": false,
            "autoName": null,
            "isReusable": false,
            "controlSequencekitname": "",
            "date": "2015-01-29T18:04:59.000418+00:00",
            "isSystem": false,
            "libkit": null,
            "categories": "",
            "planName": "-R78595-2X_POU_L040_W3_3",
            "templatingSize": "",
            "pairedEndLibraryAdapterName": "",
            "adapter": null,
            "irworkflow": "",
            "chipBarcode": null,
            "planExecuted": false,
            "username": "ionuser",
            "usePostBeadfind": false,
            "storageHost": null,
            "expName": "",
            "libraryReadLength": 0,
            "runname": null,
            "usePreBeadfind": true,
            "planGUID": "e6b0a446-7b90-4a9a-aa3b-d59336da12d3",
            "cycles": null,
            "resource_uri": "/rundb/api/v1/availableplannedexperimentsummary/111207/"
        }
    ]
}

Allowed HTTP methods

• get
• post
• put
• delete
• patch