{"__v":0,"_id":"57194d52ac1e2e0e001834af","category":{"__v":2,"_id":"55d697f9ae529e0d00d34f03","pages":["55d698c5d2a8eb1900109ec5","56e204d4059d4a0e0034fa90"],"project":"5476bf0f817e8d080031f988","version":"5476bf10817e8d080031f98b","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-21T03:16:09.287Z","from_sync":false,"order":9,"slug":"api-reference","title":"API REST end points"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"5476bf0f817e8d080031f988","user":"568ed50cbeb2700d00471802","version":{"__v":17,"_id":"5476bf10817e8d080031f98b","project":"5476bf0f817e8d080031f988","createdAt":"2014-11-27T06:05:04.263Z","releaseDate":"2014-11-27T06:05:04.263Z","categories":["5476bf10817e8d080031f98c","5477c46cf3736008009e9eb5","5477c474f3736008009e9eb6","5477c47ef3736008009e9eb7","5477c48ff3736008009e9eb8","5477c4948deb230800808bf0","54e68328154f8e0d0007b55c","54e90194c8e0c00d007ac061","54eed2275bf74a0d00ef4076","54f7a7be0a3cbb0d00d666fb","559b0ebf7ae7f80d0096d871","55d697f9ae529e0d00d34f03","562d4dcc8c6e5a0d00d6ed1d","562e591c4376430d006f17e0","568f0e73bdb9260d00149d8c","5719542aac1e2e0e001834c6","57a14a8ed778850e0047e230"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-21T21:59:46.915Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"import requests\nimport json\n\nheaders = {\"X-User-Email\": 'example:::at:::example.com',\n           \"X-User-Token\": '',  # Regular-mode API key\n           \"Content-Type\": \"application/json\",\n           \"Accept\": \"application/json\"}\n\nurl = 'https://secure.transcriptic.com/:organization/protocols/:protocol_id.json'\nresponse = requests.get(url,headers=headers)","language":"python"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": \"pr18uh6hsagak8\",\n  \"name\": \"Ligation\",\n  \"created_at\": \"2016-03-31T19:57:04.678-07:00\",\n  \"description\": \"Join fragments together using a DNA ligase.\",\n  \"package_name\": \"com.transcriptic.transcriptic\",\n  \"package_id\": \"pk18ucjh9cfb7j\",\n  \"release_id\": \"re18uh6gh4au3s\",\n  \"inputs\": {\n    \"reaction_setup\": {\n      \"type\": \"group\",\n      \"label\": \"Reaction setup\",\n      \"inputs\": {\n        \"total_reaction_volume\": {\n          \"type\": \"volume\",\n          \"label\": \"Total reaction volume (10-100uL)\",\n          \"description\": \"Total volume of each reaction including DNA fragments, ligase, ligase buffer and water. Between 10uL and 100uL.\",\n          \"default\": \"20:microliter\"\n        },\n        \"ligase_type\": {\n          \"type\": \"choice\",\n          \"label\": \"Ligase\",\n          \"default\": \"thermo\",\n          \"options\": [\n            {\n              \"value\": \"neb\",\n              \"name\": \"NEB T4 ligase\"\n            },\n            {\n              \"value\": \"thermo\",\n              \"name\": \"Thermo T4 ligase\"\n            }\n          ]\n        },\n        \"ligase_vol\": {\n          \"type\": \"volume\",\n          \"label\": \"Ligase Volume per Reaction\",\n          \"description\": \"Volume of T4 Ligase to include in each reaction. Buffer and water volumes are calculated automatically. Volume has to be between 1 microliter and 1/10th of the total ligation volume.\",\n          \"default\": \"1:microliter\"\n        },\n        \"gel\": {\n          \"type\": \"bool\",\n          \"label\": \"Include your reactions on the control gel?\",\n          \"description\": \"Run 5uL of all assemblies on the control gel. The control reactions using a Lambda DNA/HindIII Marker (ligated and unligated) are always run on a gel.\",\n          \"default\": true\n        }\n      }\n    },\n    \"reactions\": {\n      \"type\": \"group+\",\n      \"label\": \"Reactions\",\n      \"inputs\": {\n        \"fragments\": {\n          \"type\": \"group+\",\n          \"label\": \"Fragments\",\n          \"description\": \"Use 20-100 ng (optimally 50ng) of vector in the reaction and add inserts at a 1:1 to 5:1 molar ratio. Adjust the ratio for each insert to successfully ligate all fragments.\",\n          \"inputs\": {\n            \"fragment\": {\n              \"type\": \"aliquot\",\n              \"label\": \"Fragment aliquot\",\n              \"description\": \"DNA fragment to include in this reaction.\"\n            },\n            \"volume\": {\n              \"type\": \"volume\",\n              \"label\": \"Volume\",\n              \"description\": \"Volume of this fragment to include in this reaction.\"\n            }\n          }\n        }\n      }\n    },\n    \"lig\": {\n      \"type\": \"thermocycle\",\n      \"label\": \"ligation conditions\",\n      \"description\": \"30 minutes at 22C is recommended for sticky ends. For blunt ends use 2 hours at 22C. Alternatively you can add more ligase, or run the reaction for 16 hours at 16C.\",\n      \"default\": [\n        {\n          \"cycles\": 1,\n          \"steps\": [\n            {\n              \"temperature\": \"22:celsius\",\n              \"duration\": \"30:minute\"\n            }\n          ]\n        }\n      ]\n    },\n    \"deact\": {\n      \"type\": \"thermocycle\",\n      \"label\": \"deactivation conditions\",\n      \"default\": [\n        {\n          \"cycles\": 1,\n          \"steps\": [\n            {\n              \"temperature\": \"65:celsius\",\n              \"duration\": \"10:minute\"\n            }\n          ]\n        }\n      ]\n    }\n  },\n  \"dependencies\": [],\n  \"preview\": {\n    \"refs\": {\n      \"ligated-samples1_2016-04-01\": {\n        \"new\": \"96-pcr\",\n        \"store\": {\n          \"where\": \"cold_20\"\n        },\n        \"container_type\": {\n          \"id\": \"96-pcr\",\n          \"name\": \"96-well PCR plate\",\n          \"well_count\": 96,\n          \"well_volume_ul\": \"160.0\",\n          \"shortname\": \"96-pcr\",\n          \"col_count\": 12,\n          \"is_tube\": false\n        }\n      },\n      \"resources\": {\n        \"new\": \"384-pcr\",\n        \"store\": {\n          \"where\": \"cold_20\"\n        },\n        \"container_type\": {\n          \"id\": \"384-pcr\",\n          \"name\": \"384-well PCR plate\",\n          \"well_count\": 384,\n          \"well_volume_ul\": \"40.0\",\n          \"shortname\": \"384-pcr\",\n          \"col_count\": 24,\n          \"is_tube\": false\n        }\n      },\n      \"reagent_plate\": {\n        \"new\": \"96-pcr\",\n        \"discard\": true,\n        \"container_type\": {\n          \"id\": \"96-pcr\",\n          \"name\": \"96-well PCR plate\",\n          \"well_count\": 96,\n          \"well_volume_ul\": \"160.0\",\n          \"shortname\": \"96-pcr\",\n          \"col_count\": 12,\n          \"is_tube\": false\n        }\n      }\n    },\n    \"outs\": {\n      \"reagent_plate\": {\n        \"0\": {\n          \"name\": \"water_ligation\"\n        },\n        \"1\": {\n          \"name\": \"ligation_MM\"\n        }\n      }\n    },\n    \"instructions\": [\n      {\n        \"to\": [\n          {\n            \"volume\": \"46.6:microliter\",\n            \"well\": \"reagent_plate/0\"\n          }\n        ],\n        \"op\": \"provision\",\n        \"resource_id\": \"rs17gmh5wafm5p\"\n      },\n      {\n        \"to\": [\n          {\n            \"volume\": \"7.7:microliter\",\n            \"well\": \"reagent_plate/1\"\n          }\n        ],\n        \"op\": \"provision\",\n        \"resource_id\": \"rs16pc8u4dd3n9\"\n      },\n      {\n        \"to\": [\n          {\n            \"volume\": \"7.7:microliter\",\n            \"well\": \"reagent_plate/1\"\n          }\n        ],\n        \"op\": \"provision\",\n        \"resource_id\": \"rs16pc8u4dmsbg\"\n      },\n      {\n        \"groups\": [\n          {\n            \"transfer\": [\n              {\n                \"volume\": \"4.0:microliter\",\n                \"to\": \"ligated-samples1_2016-04-01/0\",\n                \"from\": \"reagent_plate/1\"\n              },\n              {\n                \"volume\": \"4.0:microliter\",\n                \"to\": \"ligated-samples1_2016-04-01/1\",\n                \"from\": \"reagent_plate/1\"\n              }\n            ]\n          },\n          {\n            \"transfer\": [\n              {\n                \"volume\": \"2.0:microliter\",\n                \"to\": \"ligated-samples1_2016-04-01/0\",\n                \"from\": \"resources/0\"\n              }\n            ]\n          },\n          {\n            \"transfer\": [\n              {\n                \"volume\": \"3.0:microliter\",\n                \"to\": \"ligated-samples1_2016-04-01/0\",\n                \"from\": \"resources/1\"\n              }\n            ]\n          },\n          {\n            \"transfer\": [\n              {\n                \"volume\": \"2.5:microliter\",\n                \"to\": \"ligated-samples1_2016-04-01/0\",\n                \"from\": \"resources/25\"\n              }\n            ]\n          },\n          {\n            \"transfer\": [\n              {\n                \"volume\": \"8.5:microliter\",\n                \"to\": \"ligated-samples1_2016-04-01/0\",\n                \"from\": \"reagent_plate/0\"\n              }\n            ]\n          },\n          {\n            \"transfer\": [\n              {\n                \"volume\": \"5.0:microliter\",\n                \"to\": \"ligated-samples1_2016-04-01/1\",\n                \"from\": \"reagent_plate/0\"\n              }\n            ]\n          },\n          {\n            \"transfer\": [\n              {\n                \"volume\": \"5.0:microliter\",\n                \"to\": \"ligated-samples1_2016-04-01/2\",\n                \"from\": \"reagent_plate/0\"\n              }\n            ]\n          }\n        ],\n        \"op\": \"pipette\"\n      },\n      {\n        \"to\": [\n          {\n            \"volume\": \"1.0:microliter\",\n            \"well\": \"ligated-samples1_2016-04-01/1\"\n          },\n          {\n            \"volume\": \"1.0:microliter\",\n            \"well\": \"ligated-samples1_2016-04-01/2\"\n          }\n        ],\n        \"op\": \"provision\",\n        \"resource_id\": \"rs18sfjf96tkwe\"\n      },\n      {\n        \"object\": \"ligated-samples1_2016-04-01\",\n        \"type\": \"ultra-clear\",\n        \"op\": \"seal\"\n      },\n      {\n        \"volume\": \"20.0:microliter\",\n        \"dataref\": null,\n        \"object\": \"ligated-samples1_2016-04-01\",\n        \"groups\": [\n          {\n            \"cycles\": 1,\n            \"steps\": [\n              {\n                \"duration\": \"30.0:minute\",\n                \"temperature\": \"22.0:celsius\"\n              }\n            ]\n          },\n          {\n            \"cycles\": 1,\n            \"steps\": [\n              {\n                \"duration\": \"10.0:minute\",\n                \"temperature\": \"65.0:celsius\"\n              }\n            ]\n          }\n        ],\n        \"op\": \"thermocycle\"\n      },\n      {\n        \"object\": \"ligated-samples1_2016-04-01\",\n        \"op\": \"unseal\"\n      },\n      {\n        \"dataref\": \"ligation_check_2016-04-01_gel-image\",\n        \"matrix\": \"agarose(10,0.8%)\",\n        \"ladder\": \"ladder2\",\n        \"volume\": \"5.0:microliter\",\n        \"objects\": [\n          \"ligated-samples1_2016-04-01/1\",\n          \"ligated-samples1_2016-04-01/2\",\n          \"ligated-samples1_2016-04-01/0\"\n        ],\n        \"duration\": \"13:minute\",\n        \"op\": \"gel_separate\"\n      },\n      {\n        \"object\": \"resources\",\n        \"type\": \"ultra-clear\",\n        \"op\": \"seal\"\n      },\n      {\n        \"object\": \"ligated-samples1_2016-04-01\",\n        \"type\": \"ultra-clear\",\n        \"op\": \"seal\"\n      }\n    ]\n  },\n  \"license\": \"MIT\",\n  \"command_string\": \"python ligation/ligation.py\",\n  \"published\": true,\n  \"categories\": [\n    \"Quick Instructions\"\n  ],\n  \"video_id\": null,\n  \"image_url\": \"https://static.transcriptic.com/protocol-img/protocol-img_ligation%402x.png\",\n  \"validation_url\": null,\n  \"display_name\": null,\n  \"version\": \"2.0.0\",\n  \"package\": {\n    \"id\": \"pk18ucjh9cfb7j\",\n    \"name\": \"com.transcriptic.transcriptic\",\n    \"description\": \"transcriptic tools\",\n    \"created_at\": \"2016-03-30T10:35:55.476-07:00\",\n    \"public\": false,\n    \"release_count\": 2,\n    \"latest_version\": \"re18ucmgyvhy79\",\n    \"owner\": {\n      \"id\": \"u162938gpp93m\",\n      \"email\": \"ben@example.com\",\n      \"profile_photo_attachment_url\": \"uploads/bb9dccaf-9880-49db-82fe-53ce611d23b7/user-image.jpeg\",\n      \"name\": \"Ben\"\n    }\n  }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"57194d52ac1e2e0e001834b1","ref":"","in":"path","required":false,"desc":"","default":"","type":"string","name":"organization"},{"_id":"57194d52ac1e2e0e001834b0","ref":"","in":"path","required":false,"desc":"","default":"","type":"string","name":"protocol_id"}],"url":"/:organization/protocols/:protocol_id.json"},"isReference":true,"order":8,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Experimental feature\"\n}\n[/block]","excerpt":"Returns a single protocol corresponding to the provided protocol id in the params","slug":"get-a-single-protocol","type":"endpoint","title":"/protocols/:protocol_id"}

get/protocols/:protocol_id

Returns a single protocol corresponding to the provided protocol id in the params

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

organization:
string
protocol_id:
string

Examples


Result Format


Documentation

[block:callout] { "type": "danger", "title": "Experimental feature" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}