Skip to content

Latest commit

 

History

History
223 lines (212 loc) · 33.8 KB

availableonetouchplannedexperiment.rst

File metadata and controls

223 lines (212 loc) · 33.8 KB
Raw

Available Onetouch Planned Experiment Resource

Resource URL http://mytorrentserver/rundb/api/v1/availableonetouchplannedexperiment/
Schema URL http://mytorrentserver/rundb/api/v1/availableonetouchplannedexperiment/schema/

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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
autoAnalyze Boolean data. Ex: True n/a false false false false boolean
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
templatingKitBarcode Unicode string data. Ex: "Hello World" n/a true false false false string
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
preAnalysis 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 true false related
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
platform Unicode string data. Ex: "Hello World" n/a true 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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
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

------------------------------------notes

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----true

------false

--------string

------------------------------------sequencekitname

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----true

------false

--------string

------------------------------------base_recalibration_mode

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
cycles Integer data. Ex: 2673 n/a true false false false integer
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
isReverseRun Boolean data. Ex: True false false false true false boolean
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
storage_options Unicode string data. Ex: "Hello World" A false false false false string

------------------------------------chipType

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------false

-----false

------false

--------string

------------------------------------library

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----true

------false

--------string

------------------------------------reverselibrarykey

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------true

-----false

------false

--------string
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
planName 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

------------------------------------barcodeId

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----true

------false

--------string
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
isPlanGroup Boolean data. Ex: True false false false true false boolean
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
realign Boolean data. Ex: True n/a false false false false boolean
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
sampleGroupingName Unicode string data. Ex: "Hello World" n/a true true 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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
applicationCategoryDisplayedName Unicode string data. Ex: "Hello World" n/a true true true false string
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
isReusable Boolean data. Ex: True false false false true false boolean
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
isDuplicateReads Boolean data. Ex: True n/a false false false 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

------------------------------------librarykitname

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----true

------false

--------string

------------------------------------sseBedFile

--------------------------------------------------------------------------------------------------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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
earlyDatFileDeletion Boolean data. Ex: True false false true false false boolean
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
parentPlan Unicode string data. Ex: "Hello World" None false false true false string

------------------------------------origin

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----false

------false

--------string

------------------------------------forward3primeadapter

--------------------------------------------------------------------------------------------------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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
applicationGroupDisplayedName Unicode string data. Ex: "Hello World" n/a true true true false string
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
metaData Unicode string data. Ex: "Hello World" {} false false true false string
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
isFavorite 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

------------------------------------planStatus

--------------------------------------------------------------------------------------------------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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
username 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

------------------------------------sampleDisplayedName

--------------------------------------------------------------------------------------------------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

------------------------------------tfKey

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------false

-----true

------false

--------string

------------------------------------templatingSize

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----false

------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

------------------------------------runMode

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------false

-----true

------false

--------string

------------------------------------irworkflow

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------false

-----true

------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 true false false true false boolean
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
chefInfo A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'} {} false false false false dict
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
planGUID 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

------------------------------------samplePrepProtocol

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------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
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
reverse_primer 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

------------------------------------regionfile

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------false

-----true

------false

--------string

------------------------------------selectedPlugins

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----true

------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

------------------------------------libraryKey

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------false

-----true

------false

--------string
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
flows Integer data. Ex: 2673 0 false false false false integer
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
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

------------------------------------variantfrequency

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------true

-----false

------false

--------string
------------------------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
sampleSetDisplayedName Unicode string data. Ex: "Hello World" n/a true true true false string

------------------------------------flowsInOrder

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------false

-----true

------false

--------string

------------------------------------libraryPrepType

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------true

-----true

------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

------------------------------------chipBarcode

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------false

-----false

------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

------------------------------------libraryPrepTypeDisplayedName

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------true

--------true

-----true

------false

--------string

------------------------------------reverse3primeadapter

--------------------------------------------------------------------------------------------------Unicode string data. Ex: "Hello World"

--------false

--------true

-----false

------false

--------string

Example Response

{
    "meta": {
        "previous": null, 
        "total_count": 0, 
        "offset": 0, 
        "limit": 1, 
        "next": null
    }, 
    "objects": []
}

Allowed HTTP methods

  • get
  • post
  • put
  • delete
  • patch