{"__v":3,"_id":"54d372a9d0b2871900cda711","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":"5476beec817e8d080031f986","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":"2015-02-05T13:39:53.554Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"name":"","code":"{ /* Updated Aliquot */ }","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"54d50cd348de4d0d00457efe","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"organization"},{"_id":"54d50cd348de4d0d00457efd","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"container_id"},{"_id":"54d50cd348de4d0d00457efc","ref":"","in":"path","required":true,"desc":"Numeric (0-indexed) or alphanumeric (e.g. \"A1\")","default":"","type":"string","name":"well_idx"}],"url":"/:organization/samples/:container_id/:well_idx"},"isReference":true,"order":6,"body":"The body of the request should be a JSON structure containing one or more of the following fields:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"aliquot\\\": {\\n    \\\"name\\\": string,\\n    \\\"resource_id\\\": id,\\n    \\\"set_properties\\\": {\\n      \\\"<key1>\\\": string | null,\\n      \\\"<key2>\\\": string | null,\\n      /* ... */\\n    }\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Editing Sample Metadata","slug":"edit-sample-metadata","type":"endpoint","title":"/samples/:container_id/:well_idx"}

put/samples/:container_id/:well_idx

Editing Sample Metadata

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

organization:
required
string
container_id:
required
string
well_idx:
required
string
Numeric (0-indexed) or alphanumeric (e.g. "A1")

Result Format


Documentation

The body of the request should be a JSON structure containing one or more of the following fields: [block:code] { "codes": [ { "code": "{\n \"aliquot\": {\n \"name\": string,\n \"resource_id\": id,\n \"set_properties\": {\n \"<key1>\": string | null,\n \"<key2>\": string | null,\n /* ... */\n }\n }\n}", "language": "json" } ] } [/block]

User Information

Try It Out

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