referencegenome.rst

Reference Genome Resource

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

Resource Fields

field	help text	default	nullable	readonly	blank	unique	type
status	Unicode string data. Ex: "Hello World"		false	false	true	false	string
------------------reference_path	----------------------------------------------------Unicode string data. Ex: "Hello World"		--------false	--------false	-----true	------false	--------string
------------------	----------------------------------------------------	--------------------------------	--------	--------	-----	------	--------
name	Unicode string data. Ex: "Hello World"	n/a	false	false	false	false	string
------------------	----------------------------------------------------	--------------------------------	--------	--------	-----	------	--------
short_name	Unicode string data. Ex: "Hello World"	n/a	false	false	false	false	string
------------------index_version	----------------------------------------------------Unicode string data. Ex: "Hello World"		--------false	--------false	-----true	------false	--------string
------------------notes	----------------------------------------------------Unicode string data. Ex: "Hello World"		--------false	--------false	-----true	------false	--------string
------------------	----------------------------------------------------	--------------------------------	--------	--------	-----	------	--------
enabled	Boolean data. Ex: True	true	false	false	true	false	boolean
------------------species	----------------------------------------------------Unicode string data. Ex: "Hello World"		--------false	--------false	-----true	------false	--------string
------------------	----------------------------------------------------	--------------------------------	--------	--------	-----	------	--------
identity_hash	Unicode string data. Ex: "Hello World"	None	true	false	false	false	string
------------------source	----------------------------------------------------Unicode string data. Ex: "Hello World"		--------false	--------false	-----true	------false	--------string
------------------version	----------------------------------------------------Unicode string data. Ex: "Hello World"		--------false	--------false	-----true	------false	--------string
------------------celery_task_id	----------------------------------------------------Unicode string data. Ex: "Hello World"		--------false	--------false	-----true	------false	--------string
------------------	----------------------------------------------------	--------------------------------	--------	--------	-----	------	--------
date	A date & time as a string. Ex: "2010-11-10T03:07:43"	2017-04-26T00:50:31.000661+00:00	false	false	false	false	datetime
------------------verbose_error	----------------------------------------------------Unicode string data. Ex: "Hello World"		--------false	--------false	-----true	------false	--------string
------------------id	----------------------------------------------------Integer data. Ex: 2673		--------false	--------false	-----true	------true	--------integer
------------------	----------------------------------------------------	--------------------------------	--------	--------	-----	------	--------
resource_uri	Unicode string data. Ex: "Hello World"	n/a	false	true	false	false	string

Example Response

{
    "meta": {
        "previous": null, 
        "total_count": 3, 
        "offset": 0, 
        "limit": 1, 
        "next": "/rundb/api/v1/referencegenome/?offset=1&limit=1&format=json"
    }, 
    "objects": [
        {
            "status": "complete", 
            "reference_path": "/results/referenceLibrary/tmap-f3/e_coli_dh10b", 
            "name": "E. coli DH10B", 
            "short_name": "e_coli_dh10b", 
            "index_version": "tmap-f3", 
            "notes": "", 
            "enabled": true, 
            "species": "", 
            "identity_hash": null, 
            "source": "", 
            "version": "1", 
            "celery_task_id": "", 
            "date": "2017-03-14T03:40:08.000071+00:00", 
            "verbose_error": "", 
            "id": 1, 
            "resource_uri": "/rundb/api/v1/referencegenome/1/"
        }
    ]
}

Allowed HTTP methods

• get
• post
• put
• delete
• patch