Plantemplatesummary Resource ========================================================================== Resource URL: ``http://mytorrentserver/rundb/api/v1/plantemplatesummary/`` Schema URL: ``http://mytorrentserver/rundb/api/v1/plantemplatesummary/schema/`` .. include:: ../manual_api_ref_docs/plantemplatesummary.rst 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **isSystemDefault** Boolean data. Ex: True false 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **chefLastUpdate** A date & time as a string. Ex: "2010-11-10T03:07:43" n/a true false false false datetime ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **chefStatus** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **chefLogPath** Unicode string data. Ex: "Hello World" n/a true false false 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **chefProgress** Floating point numeric data. Ex: 26.73 0.0 false false true false float ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **chefMessage** 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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- ---------------------------------------------------- ------- -------- -------- ----- ------ -------- **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/plantemplatesummary/?format=json&limit=1`` Python example ^^^^^^^^^^^^^^ .. code-block:: python import requests ts_api_request = requests.get("http://mytorrentserver/rundb/api/v1/plantemplatesummary/", params={"format": "json", "limit": 1}) ts_api_response = ts_api_request.json() plantemplatesummarys = ts_api_response["objects"] for plantemplatesummary in plantemplatesummarys: print plantemplatesummary Torrent Server response ^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: javascript { "meta": { "previous": null, "total_count": 66, "offset": 0, "limit": 1, "next": "/rundb/api/v1/plantemplatesummary/?offset=1&limit=1&format=json" }, "objects": [ { "isReverseRun": false, "planDisplayedName": "chef_nonGUI_Exome Panel_AmpliSeqExome.20131001", "storage_options": "A", "preAnalysis": true, "isSystemDefault": false, "planShortID": "2OXYZ", "planStatus": "planned", "chefLastUpdate": null, "templatingKitBarcode": null, "sampleTubeLabel": "", "planExecutedDate": null, "chefStatus": "", "samplePrepKitName": "Ion AmpliSeq Exome Kit", "reverse_primer": null, "seqKitBarcode": null, "id": 100224, "metaData": {}, "sampleSet_uid": null, "isFavorite": true, "sampleSet_planIndex": 0, "chefLogPath": null, "isPlanGroup": false, "sampleSet_planTotal": 0, "templatingKitName": "Ion PI Template OT2 200 Kit v3", "runType": "AMPS_EXOME", "planPGM": null, "chefProgress": 0.0, "autoName": null, "isReusable": true, "controlSequencekitname": "", "date": "2014-05-20T13:55:02.000398+00:00", "isSystem": false, "libkit": null, "categories": "", "planName": "chef_nonGUI_Exome_Panel_AmpliSeqExome.20131001", "chefMessage": "", "pairedEndLibraryAdapterName": "", "runMode": "single", "adapter": null, "irworkflow": "", "chipBarcode": null, "planExecuted": false, "username": "ionuser", "usePostBeadfind": false, "storageHost": null, "expName": "", "runname": null, "usePreBeadfind": true, "planGUID": "a81c02b6-e8f7-411f-aeeb-302fa16baa51", "cycles": null, "resource_uri": "/rundb/api/v1/plantemplatesummary/100224/" } ] } Allowed HTTP methods -------------------- - get - post - put - delete - patch