{"__v":0,"_id":"57192b2e6346850e00834019","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-21T19:34:06.405Z","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.json'\nresponse = requests.get(url,headers=headers)","language":"python"}]},"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n    \"id\": \"pr18v9cbycytdk\",\n    \"name\": \"PlateReading\",\n    \"created_at\": \"2016-04-07T19:36:03.224-07:00\",\n    \"description\": \"Absorbance, luminescence or fluorescence measurement of optically-clear, flat-bottom plates. Reads all filled wells.\",\n    \"package_name\": \"com.transcriptic.autoprotocol-core2\",\n    \"package_id\": \"pk18v7y97ngh2r\",\n    \"release_id\": \"re18v9c6mmt25g\",\n    \"inputs\": {\n      \"plates\": {\n        \"type\": \"container+\",\n        \"description\": \"Plate to be analyzed; must be flat-bottomed and optically-clear.\",\n        \"label\": \"Sample plates\"\n      },\n      \"read_uncovered\": {\n        \"type\": \"bool\",\n        \"label\": \"Uncover before reading?\",\n        \"description\": \"If you want to read the plate without the lid, check this option. The plate will get relidded with a `low_evaporation` lid.\",\n        \"default\": true\n      },\n      \"measurement_type\": {\n        \"type\": \"group-choice\",\n        \"label\": \"Measurement Type\",\n        \"options\": [\n          {\n            \"value\": \"absorbance\",\n            \"name\": \"Absorbance\",\n            \"inputs\": {\n              \"absorbance\": {\n                \"type\": \"length\",\n                \"label\": \"Absorbance wavelength\",\n                \"default\": \"600:nanometer\"\n              },\n              \"flashes\": {\n                \"type\": \"integer\",\n                \"label\": \"Flashes\",\n                \"description\": \"Between 1 and 40 flashes can be averaged for a reading.\",\n                \"default\": 25\n              }\n            }\n          },\n          {\n            \"value\": \"fluorescence\",\n            \"name\": \"Fluorescence\",\n            \"inputs\": {\n              \"fluorescence\": {\n                \"type\": \"group\",\n                \"label\": \"Fluorescence wavelengths\",\n                \"default\": {\n                  \"fluo_ex_wl\": \"340:nanometer\",\n                  \"fluo_em_wl\": \"403:nanometer\"\n                },\n                \"inputs\": {\n                  \"fluo_ex_wl\": {\n                    \"type\": \"length\",\n                    \"label\": \"Excitation\",\n                    \"default\": \"340:nanometer\"\n                  },\n                  \"fluo_em_wl\": {\n                    \"type\": \"length\",\n                    \"label\": \"Emmission\",\n                    \"default\": \"403:nanometer\"\n                  }\n                }\n              },\n              \"gain\": {\n                \"type\": \"decimal\",\n                \"label\": \"Manual Gain (0.0-1.0), if left blank optimal gain is used\",\n                \"required\": false\n              },\n              \"flashes\": {\n                \"type\": \"integer\",\n                \"label\": \"Flashes\",\n                \"description\": \"Between 1 and 40 flashes can be averaged for a reading.\",\n                \"default\": 25\n              }\n            }\n          },\n          {\n            \"value\": \"luminescence\",\n            \"name\": \"Luminescence\",\n            \"inputs\": {}\n          }\n        ],\n        \"default\": \"absorbance\"\n      }\n    },\n    \"dependencies\": [],\n    \"preview\": {\n      \"refs\": {\n        \"plate2\": {\n          \"new\": \"96-flat\",\n          \"store\": {\n            \"where\": \"cold_4\"\n          },\n          \"container_type\": {\n            \"id\": \"96-flat\",\n            \"name\": \"96-well flat-bottom plate\",\n            \"well_count\": 96,\n            \"well_volume_ul\": \"360.0\",\n            \"shortname\": \"96-flat\",\n            \"col_count\": 12,\n            \"is_tube\": false\n          }\n        },\n        \"plate\": {\n          \"new\": \"96-flat\",\n          \"store\": {\n            \"where\": \"cold_4\"\n          },\n          \"container_type\": {\n            \"id\": \"96-flat\",\n            \"name\": \"96-well flat-bottom plate\",\n            \"well_count\": 96,\n            \"well_volume_ul\": \"360.0\",\n            \"shortname\": \"96-flat\",\n            \"col_count\": 12,\n            \"is_tube\": false\n          }\n        }\n      },\n      \"instructions\": [\n        {\n          \"dataref\": \"fluorescence_plate-2016-04-08\",\n          \"excitation\": \"340.0:nanometer\",\n          \"object\": \"plate\",\n          \"emission\": \"403.0:nanometer\",\n          \"wells\": [\n            \"A1\",\n            \"A2\",\n            \"A3\",\n            \"A4\",\n            \"A5\",\n            \"A6\",\n            \"A7\",\n            \"A8\"\n          ],\n          \"num_flashes\": 25,\n          \"op\": \"fluorescence\"\n        },\n        {\n          \"dataref\": \"fluorescence_plate2-2016-04-08\",\n          \"excitation\": \"340.0:nanometer\",\n          \"object\": \"plate2\",\n          \"emission\": \"403.0:nanometer\",\n          \"wells\": [\n            \"A1\",\n            \"A2\",\n            \"A3\",\n            \"A4\",\n            \"A5\",\n            \"A6\",\n            \"A7\",\n            \"A8\"\n          ],\n          \"num_flashes\": 25,\n          \"op\": \"fluorescence\"\n        },\n        {\n          \"lid\": \"low_evaporation\",\n          \"object\": \"plate\",\n          \"op\": \"cover\"\n        },\n        {\n          \"lid\": \"low_evaporation\",\n          \"object\": \"plate2\",\n          \"op\": \"cover\"\n        }\n      ]\n    },\n    \"license\": \"MIT\",\n    \"command_string\": \"python -m platereading.platereading\",\n    \"published\": true,\n    \"categories\": [\n      \"Quick Instructions\"\n    ],\n    \"video_id\": null,\n    \"image_url\": \"https://static.transcriptic.com/protocol-img/protocol-img_plate-reading%402x.png\",\n    \"validation_url\": \"http://learn.transcriptic.com/plate-reading/\",\n    \"display_name\": \"Plate reading\",\n    \"version\": \"2.0.2\",\n    \"package\": {\n      \"id\": \"pk18v7y97ngh2r\",\n      \"name\": \"com.transcriptic.autoprotocol-core2\",\n      \"description\": \"Transcriptic's public protocol library\",\n      \"created_at\": \"2016-04-07T09:33:04.737-07:00\",\n      \"public\": true,\n      \"release_count\": 43,\n      \"latest_version\": \"re18v7y97nwq85\"\n    }\n  },\n  {...}\n]","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"57192b2e6346850e0083401a","ref":"","in":"path","required":false,"desc":"the name of your organization, found in the url when logged into Transcriptic","default":"","type":"string","name":"organization"}],"url":"/:organization/protocols.json"},"isReference":true,"order":7,"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","excerpt":"This endpoint retrieves a list of all packaged protocols available in an organization","slug":"get-all-protocols","type":"endpoint","title":"/protocols"}

get/protocols

This endpoint retrieves a list of all packaged protocols available in an organization

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

organization:
string
the name of your organization, found in the url when logged into Transcriptic

Examples


Result Format


Documentation

Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/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 }}