Plannedexperimentdb Resource ========================================================================== Resource URL: ``http://mytorrentserver/rundb/api/v1/plannedexperimentdb/`` Schema URL: ``http://mytorrentserver/rundb/api/v1/plannedexperimentdb/schema/`` .. include:: ../manual_api_ref_docs/plannedexperimentdb.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 false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **isPlanGroup** Boolean data. Ex: True false false false true false boolean ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **sampleSet_planTotal** 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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **planName** Unicode string data. Ex: "Hello World" n/a true false false false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **parentPlan** Unicode string data. Ex: "Hello World" None false false true false string ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **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 ------------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- **resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string =============================== ================================================================================================== ======= ======== ======== ===== ====== ======== Example request --------------- Request URL: ``http://mytorrentserver/rundb/api/v1/plannedexperimentdb/?format=json&limit=1`` Python example ^^^^^^^^^^^^^^ .. code-block:: python import requests ts_api_request = requests.get("http://mytorrentserver/rundb/api/v1/plannedexperimentdb/", params={"format": "json", "limit": 1}) ts_api_response = ts_api_request.json() plannedexperimentdbs = ts_api_response["objects"] for plannedexperimentdb in plannedexperimentdbs: print plannedexperimentdb Torrent Server response ^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: javascript { "meta": { "previous": null, "total_count": 4193, "offset": 0, "limit": 1, "next": "/rundb/api/v1/plannedexperimentdb/?offset=1&limit=1&format=json" }, "objects": [ { "isReverseRun": false, "planDisplayedName": "-R185427-in_house-ml", "storage_options": "A", "preAnalysis": true, "planShortID": "XV5JM", "username": "ml", "planStatus": "planned", "runMode": "", "templatingKitBarcode": null, "sampleTubeLabel": null, "planExecutedDate": null, "samplePrepKitName": null, "reverse_primer": null, "applicationGroup": null, "seqKitBarcode": null, "id": 44458, "metaData": { "torrenthub.cbd_hub_id": "185427" }, "sampleSet_uid": null, "isFavorite": false, "sampleSet_planIndex": 0, "qcValues": [], "isPlanGroup": false, "sampleSet_planTotal": 0, "experiment": "/rundb/api/v1/experiment/12549/", "templatingKitName": null, "runType": "WGNM", "sampleSet": null, "planPGM": null, "isSystemDefault": false, "autoName": null, "isReusable": false, "controlSequencekitname": null, "date": "2014-01-30T20:25:40.000383+00:00", "isSystem": false, "libkit": null, "projects": [ "avalanche" ], "planName": "-R185427-in_house-ml", "parentPlan": null, "childPlans": [], "pairedEndLibraryAdapterName": null, "sampleGrouping": null, "adapter": null, "irworkflow": "", "chipBarcode": null, "planExecuted": false, "project": "avalanche", "usePostBeadfind": true, "storageHost": null, "expName": "", "runname": null, "usePreBeadfind": true, "planGUID": "4df71954-4746-47e6-ad8b-bd834d005e44", "cycles": 250, "resource_uri": "/rundb/api/v1/plannedexperimentdb/44458/" } ] } Allowed HTTP methods -------------------- - get - post - put - delete - patch