Sample Resource
==========================================================================

Resource URL: ``http://mytorrentserver/rundb/api/v1/sample/``


Schema URL: ``http://mytorrentserver/rundb/api/v1/sample/schema/``


.. include:: ../manual_api_ref_docs/sample.rst

Fields table
------------

================= ================================================================================================== ======= ======== ======== ===== ====== ======== 
field             help text                                                                                          default nullable readonly blank unique type     
================= ================================================================================================== ======= ======== ======== ===== ====== ======== 
**status**        Unicode string data. Ex: "Hello World"                                                                     false    false    true  false  string   
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**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  
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**description**   Unicode string data. Ex: "Hello World"                                                             n/a     true     false    false false  string   
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**displayedName** Unicode string data. Ex: "Hello World"                                                             n/a     true     false    false false  string   
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**experiments**   Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a     true     false    true  false  related  
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**externalId**    Unicode string data. Ex: "Hello World"                                                                     true     false    false false  string   
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**date**          A date & time as a string. Ex: "2010-11-10T03:07:43"                                               true    true     false    false false  datetime 
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**resource_uri**  Unicode string data. Ex: "Hello World"                                                             n/a     false    true     false false  string   
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**id**            Integer data. Ex: 2673                                                                                     false    false    true  true   integer  
----------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------- 
**name**          Unicode string data. Ex: "Hello World"                                                             n/a     true     false    false false  string   
================= ================================================================================================== ======= ======== ======== ===== ====== ======== 

Example request
---------------

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


Python example
^^^^^^^^^^^^^^

.. code-block:: python

	
	import requests
	
	ts_api_request = requests.get("http://mytorrentserver/rundb/api/v1/sample/", params={"format": "json", "limit": 1})
	ts_api_response = ts_api_request.json()
	
	samples = ts_api_response["objects"]
	
	for sample in samples:
	    print sample
	
Torrent Server response
^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: javascript

	{
	    "meta": {
	        "previous": null, 
	        "total_count": 7765, 
	        "offset": 0, 
	        "limit": 1, 
	        "next": "/rundb/api/v1/sample/?offset=1&limit=1&format=json"
	    }, 
	    "objects": [
	        {
	            "status": "run", 
	            "sampleSets": [], 
	            "description": "", 
	            "displayedName": "E122627-lq405-L8095", 
	            "experiments": [
	                "/rundb/api/v1/experiment/11750/"
	            ], 
	            "externalId": "", 
	            "date": "2013-07-23T17:11:31.000986+00:00", 
	            "resource_uri": "/rundb/api/v1/sample/3265/", 
	            "id": 3265, 
	            "name": "E122627-lq405-L8095"
	        }
	    ]
	}

Allowed HTTP methods
--------------------

- get
- post
- put
- delete
- patch