Current Biolucida API release
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8986837","collectionId":"75921017-f83d-49dc-b2cc-f5abd783c3fc","publishedId":"SVtPXAVm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-10-03T19:55:14.000Z"},"item":[{"name":"annotations","item":[{"name":"/annotations/:id","id":"93a5c2da-271e-4570-b1f6-2ada1d5ebdac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"OPTIONAL - by default this request will authenticate as a guest user. If you wish to view annotations for images accessible to specific user accounts, attach their auth token
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/annotations/:id","urlObject":{"protocol":"https","path":["api","v1","annotations",":id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"the image id to get annotations for
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"93a5c2da-271e-4570-b1f6-2ada1d5ebdac"}],"id":"9a69b4f0-9ea6-4ca5-ace8-87c6183b5a17","description":"get annotations for particular image IDs
\n","event":[{"listen":"prerequest","script":{"id":"7f488f10-b7ee-4174-83f0-5d691c27096a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a9f8bf22-ceb9-4836-b199-1ebd651ac53e","type":"text/javascript","exec":[""]}}],"_postman_id":"9a69b4f0-9ea6-4ca5-ace8-87c6183b5a17"},{"name":"authenticate","item":[{"name":"/authenticate","id":"581962f0-0b36-4aa6-b9fe-8eb2febd0f91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"user to log in as
\n","key":"username","type":"text","value":""},{"description":"password for user
\n","key":"password","type":"text","value":""},{"description":"unused but still required, just any string
\n","key":"token","type":"text","value":""}]},"url":"https://BL_SERVER_URL/api/v1/authenticate","description":"Authenticate user. NOTE: by default, authentication tokens are automatically invalidated after one hour of inactivity. Please re-authenticate if your token stops working.
\n","urlObject":{"protocol":"https","path":["api","v1","authenticate"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"581962f0-0b36-4aa6-b9fe-8eb2febd0f91"}],"id":"4d5653c1-5699-43d8-a929-cc3d201e1306","description":"Authentication functionality
\n","event":[{"listen":"prerequest","script":{"id":"7ad3eb93-8112-451d-9128-d46e3ee61ea2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7ee94780-6e87-4c92-be9b-b91edfa5326e","type":"text/javascript","exec":[""]}}],"_postman_id":"4d5653c1-5699-43d8-a929-cc3d201e1306"},{"name":"collections","item":[{"name":"/collections/all","id":"34c84538-5b74-4234-96e7-f3cb0e1ded5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/collections/all","description":"Returns all collections from Biolucida.
\n","urlObject":{"protocol":"https","path":["api","v1","collections","all"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"34c84538-5b74-4234-96e7-f3cb0e1ded5b"},{"name":"/collections/:id","id":"e819352d-cb5c-49a4-9004-b94fc050bf3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/collections/:id","description":"Retrieves list of images within a specific collection id.
\n","urlObject":{"protocol":"https","path":["api","v1","collections",":id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"The id of the collection of images you want to view.
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"e819352d-cb5c-49a4-9004-b94fc050bf3c"},{"name":"/collections/addimage","id":"839b5fe4-6c38-4f44-9d9d-1862a599687e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"collection_id","value":"","description":"The ID for the collection to add an image to.
\n","type":"text"},{"key":"image_id","value":"","description":"The ID for the image to add to the collection.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/collection/addimage","urlObject":{"protocol":"https","path":["api","v1","collection","addimage"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"839b5fe4-6c38-4f44-9d9d-1862a599687e"},{"name":"/collections/create","id":"35db408b-160d-4fb6-951e-0118aa96c312","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"","description":"A Biolucida collection name you wish to create.
\n","type":"text"},{"key":"parent_id","value":"","description":"Parent id to created collection. If root collection, pass 0.
\n","type":"text"},{"key":"owner","value":"","description":"OPTIONAL - Owner of collection. If not passed, default value is 1.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/collections/create","description":"Creates a collection in Biolucida.
\n","urlObject":{"protocol":"https","path":["api","v1","collections","create"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"35db408b-160d-4fb6-951e-0118aa96c312"},{"name":"/collections/delete","id":"5d83e4e2-dfeb-46ab-9e61-0e8f887b0a89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"collection_id","value":"","description":"The collection id you want to delete.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/collections/delete","description":"To delete a collection(s) based on collection id. Will recursively remove all child collections as well.
\n","urlObject":{"protocol":"https","path":["api","v1","collections","delete"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d83e4e2-dfeb-46ab-9e61-0e8f887b0a89"},{"name":"/collections/description","id":"a20b56e1-7ac7-4fd5-ae4c-1a38277795ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"collection_id","value":"","description":"The collection id you want to update.
\n","type":"text"},{"key":"description","value":"","description":"The description you wish to modify.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/collections/description","description":"To update a description of a collection by id.
\n","urlObject":{"protocol":"https","path":["api","v1","collections","description"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"a20b56e1-7ac7-4fd5-ae4c-1a38277795ba"},{"name":"/collections/researcher","id":"c0a34998-9ca5-400e-8584-3335d3be5325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"collection_id","value":"","description":"The collection id you want to update.
\n","type":"text"},{"key":"researcher_id","value":"","description":"The new researcher id that will be updated.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/collections/researcher","description":"To update the researcher id of a specific collection by id.
\n","urlObject":{"protocol":"https","path":["api","v1","collections","researcher"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0a34998-9ca5-400e-8584-3335d3be5325"}],"id":"71340a35-10a7-4438-8d4c-1b2223a09a56","_postman_id":"71340a35-10a7-4438-8d4c-1b2223a09a56","description":""},{"name":"folders","item":[{"name":"/folders","id":"ce8aae0a-e185-4337-9a1d-8f9f407729c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"OPTIONAL - provide the token returned from /authenticate if you wish to get the folders for that user
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/folders","description":"gets all folders available to a user (guest or authenticated)
\n","urlObject":{"protocol":"https","path":["api","v1","folders"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce8aae0a-e185-4337-9a1d-8f9f407729c5"}],"id":"5c8a1689-9248-4a98-abf4-c49bb3edf40c","_postman_id":"5c8a1689-9248-4a98-abf4-c49bb3edf40c","description":""},{"name":"image","item":[{"name":"/image/:id","id":"dab1d045-7b73-4f9e-b0f1-9f864dd24b21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token ","value":"","description":"OPTIONAL - authentication token, see /authenticate. if left blank, authenticates as guest user
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/image/:image_id","description":"get an image at an id
\n","urlObject":{"protocol":"https","path":["api","v1","image",":image_id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"id of the image to access
\n","type":"text/plain"},"type":"string","value":"","key":"image_id"}]}},"response":[],"_postman_id":"dab1d045-7b73-4f9e-b0f1-9f864dd24b21"},{"name":"/image/add_tag","id":"55091c3d-ad9c-4cf4-9c9e-a4654fa45035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image_id","value":"","description":"id of the image to add a tag to
\n","type":"text"},{"key":"tag_name","value":"","description":"name of the tag to add an image to
\n","type":"text"},{"key":"confidence","value":"","description":"OPTIONAL - a value between 0 and 1 that reflects how confident you are that this tag belongs to this image. Typically generated by Neuromanager. Defaults to 1.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/image/add_tag","description":"add a tag to an image
\n","urlObject":{"protocol":"https","path":["api","v1","image","add_tag"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"55091c3d-ad9c-4cf4-9c9e-a4654fa45035"},{"name":"/image/colandbasename","id":"07abb205-c484-4254-a21f-a478b1bfe7ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"col_id","value":"","description":"id for collection containing image
\n","type":"text"},{"key":"basename","value":"","description":"basename for image
\n","type":"text"}]},"url":"https://BL_SERVER_NAME/api/v1/image/colandbasename","description":"gets image id for given collection id and file basename
\n","urlObject":{"protocol":"https","path":["api","v1","image","colandbasename"],"host":["BL_SERVER_NAME"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"07abb205-c484-4254-a21f-a478b1bfe7ce"},{"name":"/image/remove_tag","id":"224afa95-b4da-4fca-b815-bac1ec8cbfe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"authentication token, see /authenticate
\n","key":"token","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"description":"id of image to remove tag from
\n","key":"image_id","type":"text","value":""},{"description":"name of tag to remove
\n","key":"tag_name","type":"text","value":""}]},"url":"https://BL_SERVER_URL/api/v1/image/remove_tag","description":"remove tag from image
\n","urlObject":{"protocol":"https","path":["api","v1","image","remove_tag"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"224afa95-b4da-4fca-b815-bac1ec8cbfe4"}],"id":"82dbcd75-a9ab-426f-9e47-11a1daf4bb90","_postman_id":"82dbcd75-a9ab-426f-9e47-11a1daf4bb90","description":""},{"name":"region","item":[{"name":"/region/:id/:height-:width-:focal_plane-:x-:y-:z","id":"362dcd02-18bb-4302-b2c8-4bde7c25d02a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"OPTIONAL - by default, this request authenticates as the guest user. provide a token returned from /authenticate to make this request as a specific user.
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/region/:id/:height-:width-:focal_plane-:x-:y-:z","description":"Returns the requested image stream given a height, width, resolution/zoom level, x pixel location, y pixel location, and z focal plane (if the user has access to the image, guest or authenticated). NOTE: height and width are limited to at most 4000 pixels in size; larger requests will be truncated.
\n","urlObject":{"protocol":"https","path":["api","v1","region",":id",":height-:width-:focal_plane-:x-:y-:z"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"the image id to get a region from
\n","type":"text/plain"},"type":"string","value":"","key":"id"},{"description":{"content":"height: the height of the request (in px, max of 4000 px allowed)\nwidth: the width of the request (in px, max of 4000 px allowed)\nfocal_plane: resolution/zoom level for the image (must exist in the image's zoom map)\nx: x pixel location in image\ny: y pixel location in image\nz: z focal plane for the image (must be less than focal plane's value)
\n","type":"text/plain"},"type":"string","value":"","key":"height-:width-:focal_plane-:x-:y-:z"}]}},"response":[],"_postman_id":"362dcd02-18bb-4302-b2c8-4bde7c25d02a"}],"id":"b0faeeef-8e5f-48b1-b0aa-f0770180cf2a","description":"functionality to get image regions up to 4000x4000px
\n","_postman_id":"b0faeeef-8e5f-48b1-b0aa-f0770180cf2a"},{"name":"search","item":[{"name":"/search/:searchTerm","id":"98414b4d-dd1f-47c6-8e60-58b441e0f428","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"OPTIONAL - by default, this request is made as a guest bl user. If you wish your search results to include images that a specific user has access to, include their /authentication token here
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/search/:searchTerm/:offset/:limit","description":"Returns up to 25 images that match the search term
\n","urlObject":{"protocol":"https","path":["api","v1","search",":searchTerm",":offset",":limit"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"The search term. will search filename, description, notes, and tags.
\n","type":"text/plain"},"type":"string","value":"","key":"searchTerm"},{"description":{"content":"OPTIONAL - Specify index of all possible results to return. For example, specifying '8' will skip the first 7 results that match the search term (default is 0)
\n","type":"text/plain"},"type":"string","value":"","key":"offset"},{"description":{"content":"OPTIONAL - specify the maximum number of results to be returned between 0 and 25 (default is 25)
\n","type":"text/plain"},"type":"string","value":"","key":"limit"}]}},"response":[],"_postman_id":"98414b4d-dd1f-47c6-8e60-58b441e0f428"}],"id":"99d99dc2-75f1-4f7c-879c-37dd16c9f2b7","description":"functionality for searching images by a keyword or phrase
\n","_postman_id":"99d99dc2-75f1-4f7c-879c-37dd16c9f2b7"},{"name":"server","item":[{"name":"/server","id":"2c4bdb96-b405-4990-841a-6090d53ec070","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"Get server metadata and service status
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"2c4bdb96-b405-4990-841a-6090d53ec070"},{"name":"/server/ports","id":"11a6741e-018e-4c73-8d7f-f5ff74dac5c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"Get server port numbers
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"11a6741e-018e-4c73-8d7f-f5ff74dac5c8"},{"name":"/server/quickcode","id":"fa7e2f0d-ddec-4316-9975-74efce1ff5c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"quickcode","value":"","description":"A quickcode for a Biolucida connection on this server
\n","type":"text"}]},"url":"","description":"returns a host URL for a specific user's quickcode
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"fa7e2f0d-ddec-4316-9975-74efce1ff5c7"}],"id":"df03d6f9-cd16-41eb-b49e-05a8e8b7814b","description":"requests for various metadata about this server
\n","_postman_id":"df03d6f9-cd16-41eb-b49e-05a8e8b7814b"},{"name":"slides","item":[{"name":"/slides/:min_offset/:max_returned/:folder_path","id":"59d36317-dc8e-4d15-b2e5-15956defea5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"OPTIONAL - this command executes as the guest BL user by default. use the token returned from /authenticate to execute this command as a specific user
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/slides/:min_offset/:max_returned/:folder_path","description":"returns all images available within a folder within a return range available to a user (guest or authenticated)
\n","urlObject":{"protocol":"https","path":["api","v1","slides",":min_offset",":max_returned",":folder_path"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"sets the offset starting position for the return object. 0 would start at the first image and 30 would start at the 30th image returned.
\n","type":"text/plain"},"type":"string","value":"","key":"min_offset"},{"description":{"content":"sets how many images to return
\n","type":"text/plain"},"type":"string","value":"","key":"max_returned"},{"description":{"content":"the full folder path to where images reside. to get these paths, see the /folders endpoint
\n","type":"text/plain"},"type":"string","value":"","key":"folder_path"}]}},"response":[],"_postman_id":"59d36317-dc8e-4d15-b2e5-15956defea5b"}],"id":"06bc63db-1743-4907-b375-7aebb9b6ca68","description":"requests that gather all images within a collection or tracked dir
\n","_postman_id":"06bc63db-1743-4907-b375-7aebb9b6ca68"},{"name":"tag","item":[{"name":"/tag/all","id":"d377194b-59f7-4cfe-adda-3dad2e7e2352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/tag/all","description":"get all tags
\n","urlObject":{"protocol":"https","path":["api","v1","tag","all"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"d377194b-59f7-4cfe-adda-3dad2e7e2352"},{"name":"/tag/group/all","id":"bb64ed48-2c89-4ca1-94cf-9982776921e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/tag/group/all","description":"get all tag groups
\n","urlObject":{"protocol":"https","path":["api","v1","tag","group","all"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb64ed48-2c89-4ca1-94cf-9982776921e9"},{"name":"/tag/topn/:image_id/:count","id":"4dab32ae-71d6-43ee-9301-c31111a17d14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/tag/topn/:image_id/:count","description":"get the top N tags for the given image id
\n","urlObject":{"protocol":"https","path":["api","tag","topn",":image_id",":count"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"the image id to fetch tags for
\n","type":"text/plain"},"type":"string","value":"","key":"image_id"},{"description":{"content":"OPTIONAL - the number of tags to fetch. defaults to 5.
\n","type":"text/plain"},"type":"string","value":"","key":"count"}]}},"response":[],"_postman_id":"4dab32ae-71d6-43ee-9301-c31111a17d14"},{"name":"/tag/create","id":"b3edd200-dc23-40e1-9750-3e9bec767f46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"tag_name","value":"","type":"text","description":"name of the tag to create
\n"}]},"url":"https://BL_SERVER_URL/api/v1/tag/create","description":"create a tag
\n","urlObject":{"protocol":"https","path":["api","v1","tag","create"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3edd200-dc23-40e1-9750-3e9bec767f46"},{"name":"/tag/delete","id":"1d131a2a-629c-4111-ae4c-ca307bf1a52b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"tag_name","value":"","description":"name of the tag to delete
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/tag/delete","description":"Delete a tag.
\n","urlObject":{"protocol":"https","path":["api","v1","tag","delete"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d131a2a-629c-4111-ae4c-ca307bf1a52b"},{"name":"/tag/group/add_tag","id":"599b2c63-9b3e-4387-b6e7-9427bfecf892","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"group_name","value":"","type":"text","description":"name of the group to add a tag to
\n"},{"key":"id","value":"","type":"text","description":"OPTIONAL - either this or tag_name must be set - this is the id of the tag to add
\n"},{"key":"tag_name","value":"","description":"OPTIONAL - either this or id must be set - this is the name of the tag to add
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/tag/group/add_tag","description":"add a tag to a tag group
\n","urlObject":{"protocol":"https","path":["api","v1","tag","group","add_tag"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"599b2c63-9b3e-4387-b6e7-9427bfecf892"},{"name":"/tag/group/create","id":"1b56a57a-9b42-43bb-be78-a00762832f80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"group_name","value":"","type":"text","description":"the name of the tag group to create
\n"}]},"url":"https://BL_SERVER_URL/api/v1/tag/group/create","description":"create tag group
\n","urlObject":{"protocol":"https","path":["api","v1","tag","group","create"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b56a57a-9b42-43bb-be78-a00762832f80"},{"name":"/tag/group/delete","id":"859278d7-a493-4857-bdb8-8409846644d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"group_name","value":"","type":"text","description":"the name of the tag group to delete
\n"}]},"url":"https://BL_SERVER_URL/api/v1/tag/group/delete","description":"delete a tag group
\n","urlObject":{"protocol":"https","path":["api","v1","tag","group","delete"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"859278d7-a493-4857-bdb8-8409846644d3"},{"name":"/tag/group/remove_tag","id":"b2a27511-bb9e-4468-9ecd-96e63700014c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"group_name","value":"","description":"name of the group to remove a tag from
\n","type":"text"},{"key":"id","value":"","description":"OPTIONAL - either this or tag_name must be set - the id of the tag to remove from the group
\n","type":"text"},{"key":"tag_name","value":"","description":"OPTIONAL - either this or tag_id must be set - the name of the tag to remove from the group
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/tag/group/remove_tag","description":"remove tag from a group
\n","urlObject":{"protocol":"https","path":["api","v1","tag","group","remove_tag"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2a27511-bb9e-4468-9ecd-96e63700014c"}],"id":"518dbc2c-a791-4994-a963-fdb6fa9944c3","description":"Biolucida tag functionality
\n","event":[{"listen":"prerequest","script":{"id":"ede6bec0-1d84-4bfe-9835-608b25eabaf9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"23e74214-185d-43ce-a916-1980cb6ecbc9","type":"text/javascript","exec":[""]}}],"_postman_id":"518dbc2c-a791-4994-a963-fdb6fa9944c3"},{"name":"thumbnail","item":[{"name":"/thumbnail/:imageId","id":"70591bbc-a460-418c-9bf0-fb669440b3ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/thumbnail/:imageId","description":"Displays thumbnail for specific image id.
\n","urlObject":{"protocol":"https","path":["api","v1","thumbnail",":imageId"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"id":"09734742-ed40-4bff-985f-865b6a85b7de","type":"string","value":"","key":"imageId"}]}},"response":[],"_postman_id":"70591bbc-a460-418c-9bf0-fb669440b3ab"},{"name":"/thumbnail/setSingle","id":"c8dd6d0d-9a45-4422-9fa6-c1a842d96a2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image_id","value":"","description":"Biolucida image id.
\n","type":"text"},{"key":"new_thumbnail","value":"","description":"Encoded thumbnail image.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/thumbnail/setSingle","description":"Sets an image's thumbnail.
\n","urlObject":{"protocol":"https","path":["api","v1","thumbnail","setSingle"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8dd6d0d-9a45-4422-9fa6-c1a842d96a2e"},{"name":"/thumbnail/setRoot","id":"f55caf54-babf-4461-8211-51ff44755f36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image_id","value":"","description":"Biolucida image id.
\n","type":"text"},{"key":"new_thumbnail","value":"","description":"Encoded thumbnail image.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/thumbnail/setRoot","description":"Sets all thumbnails that are associated with a specific image id.
\n","urlObject":{"protocol":"https","path":["api","v1","thumbnail","setRoot"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"f55caf54-babf-4461-8211-51ff44755f36"},{"name":"/thumbnail/resetSingle","id":"ea12da00-6e50-47bb-989a-5ae7612ad6ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image_id","value":"","description":"Biolucida image id.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/thumbnail/resetSingle","description":"Resets an image's thumbnail. This removes the thumbnail from the thumbnail folder, the user will have to run filetracker in order to complete the reset process.
\n","urlObject":{"protocol":"https","path":["api","v1","thumbnail","resetSingle"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea12da00-6e50-47bb-989a-5ae7612ad6ac"},{"name":"/thumbnail/resetRoot","id":"4c35c719-db26-4481-8efc-39692b9e06cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image_id","value":"","description":"Biolucida image id.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/thumbnail/resetRoot","description":"Resets all thumbnails associated with a specific image id. The user will also need to run filetracker in order to complete the reset process.
\n","urlObject":{"protocol":"https","path":["api","v1","thumbnail","resetRoot"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c35c719-db26-4481-8efc-39692b9e06cd"}],"id":"dfaa036a-f0e4-4c03-afe2-452904cadbc4","_postman_id":"dfaa036a-f0e4-4c03-afe2-452904cadbc4","description":""},{"name":"tile","item":[{"name":"/tile/:id","id":"aa5fe9a0-2d76-48dc-8788-f66fac0ed1dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"OPTIONAL - by default, this request is made as a guest BL user. you can supply an /authenicate token here to access as a particular user.
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/tile/:id","description":"get a full preview image
\n","urlObject":{"protocol":"https","path":["api","v1","tile",":id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"The image id to fetch a preview for
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"aa5fe9a0-2d76-48dc-8788-f66fac0ed1dd"},{"name":"/tile/:id/:f-:x-:y","id":"e24a8c23-9574-4a78-8059-9c586b97c0a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"OPTIONAL - by default, this request is made as a guest BL user. you can supply an /authenicate token here to access as a particular user.
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/tile/:id/:f-:x-:y","description":"returns a tile at the supplied zoom level and x/y position
\n","urlObject":{"protocol":"https","path":["api","v1","tile",":id",":f-:x-:y"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"the image id to fetch this tile for
\n","type":"text/plain"},"type":"string","value":"","key":"id"},{"description":{"content":"f: the zoom level\nx: x index of tile\ny: y index of tile
\n","type":"text/plain"},"type":"string","value":"","key":"f-:x-:y"}]}},"response":[],"_postman_id":"e24a8c23-9574-4a78-8059-9c586b97c0a4"},{"name":"/tile/:id/:f-:x-:y-:z","id":"01b1393d-6759-4eb0-a53f-b4fbb5cc5d61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"OPTIONAL - by default, this request is made as a guest BL user. you can supply an /authenicate token here to access as a particular user.
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/tile/:id/:f-:x-:y-:z","description":"returns an image tile at a particular zoom level and x/y/z position
\n","urlObject":{"protocol":"https","path":["api","v1","tile",":id",":f-:x-:y-:z"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"the image id to fetch this tile for
\n","type":"text/plain"},"type":"string","value":"","key":"id"},{"description":{"content":"f: the zoom level\nx: x index of tile\ny: y index of tile\nz: z index of tile
\n","type":"text/plain"},"type":"string","value":"","key":"f-:x-:y-:z"}]}},"response":[],"_postman_id":"01b1393d-6759-4eb0-a53f-b4fbb5cc5d61"}],"id":"fc5d8011-df26-4a97-8374-7712aad4c8d4","description":"requests that access specific image tiles
\n","_postman_id":"fc5d8011-df26-4a97-8374-7712aad4c8d4"},{"name":"upload","item":[{"name":"/upload/init","id":"5ac056de-979b-4800-884c-5004707f9181","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"authentication token, see /authenticate. Used to determine which tracked directory to default to if no tracked directory is provided in the form-data
\n","key":"token","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"description":"size in bytes of file
\n","key":"filesize","type":"text","value":""},{"description":"size in bytes of each chunk processed during the upload
\n","key":"chunk_size","type":"text","value":""},{"description":"filename
\n","key":"filename","type":"text","value":""},{"description":"OPTIONAL - specify a tracked directory if you don't wish to use the default for this user
\n","key":"tracked_dir","type":"text","value":""}]},"url":"https://BL_SERVER_URL/api/v1/upload/init","description":"intializes upload transaction. generates a unique key to be used for the remainder of the transaction (instead of the normal auth model - this way we can authenticate with a single key)
\n","urlObject":{"protocol":"https","path":["api","v1","upload","init"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ac056de-979b-4800-884c-5004707f9181"},{"name":"/upload/continue","id":"3008ffa6-72c0-4197-a3ad-3325d6ff5926","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"upload_key","value":"","description":"the upload key produced during an /upload/init, used to authenticate this upload step
\n","type":"text"},{"key":"upload_data","value":"","description":"base64-encoded data. will be either equal in size when decoded to the chunk size agreed upon during /upload/init, or smaller if this is the final chunk
\n","type":"text"},{"key":"chunk_id","value":"","description":"0-based file chunk id. designates which chunk in the sequence this transmission represents. used to reassemble file chunks into a single file during the finalization step.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/upload/continue","description":"send the next chunk of an upload transmission (base64-encoded)
\n","urlObject":{"protocol":"https","path":["api","v1","upload","continue"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"3008ffa6-72c0-4197-a3ad-3325d6ff5926"},{"name":"/upload/finish","id":"5227d5d9-97eb-4a2a-bccc-3d000b419865","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"upload_key","value":"","description":"the upload key produced during an /upload/init, used to authenticate this upload step
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/upload/finish","description":"finalize upload
\n","urlObject":{"protocol":"https","path":["api","v1","upload","finish"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"5227d5d9-97eb-4a2a-bccc-3d000b419865"},{"name":"/upload/cancel","id":"02eb7f5d-0025-4c1d-a13b-53e459191031","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"upload_key","value":"","description":"the upload key produced during an /upload/init that represents the upload process to delete
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/upload/cancel","description":"cancel an active upload and remove all files
\n","urlObject":{"protocol":"https","path":["api","v1","upload","cancel"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"02eb7f5d-0025-4c1d-a13b-53e459191031"}],"id":"f9147802-90e2-43b1-b520-ce5aee67853d","description":"upload requests.
\nTypical workflow:
\nauthentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/user/all","description":"To receive all users from Biolucida.
\n","urlObject":{"protocol":"https","path":["api","v1","user","all"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"dec3cc44-79f5-4607-a5f2-7741e6fcbedb"},{"name":"/user/groups","id":"74e23512-69c2-48fe-aee2-e465d131ba4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/user/groups","description":"To receive all available group names and IDs.
\n","urlObject":{"protocol":"https","path":["api","v1","user","groups"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"74e23512-69c2-48fe-aee2-e465d131ba4b"},{"name":"/user/:id","id":"d76d0edb-7ecb-4c7d-807d-f1f124ee62ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/user/:id","description":"To receive basic user information. Search by user id.
\n","urlObject":{"protocol":"https","path":["api","v1","user",":id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"id":"cf8c7412-f2cc-42ec-b9d8-1ab19cbefc05","type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"d76d0edb-7ecb-4c7d-807d-f1f124ee62ea"},{"name":"/user/:username","id":"51c13651-5315-481f-89ae-48d089bc4777","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"url":"https://BL_SERVER_URL/api/v1/user/:username","description":"To receive basic user information. Search by username.
\n","urlObject":{"protocol":"https","path":["api","v1","user",":username"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"id":"d35e80d6-bde6-440b-903c-3598f6a06938","type":"string","value":"","key":"username"}]}},"response":[],"_postman_id":"51c13651-5315-481f-89ae-48d089bc4777"},{"name":"/user/create","id":"4e50f102-d915-4d90-95af-1deebaedd0bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"","description":"A Biolucida username you wish to create.
\n","type":"text"},{"key":"password","value":"","description":"The corresponding password for above new user.
\n","type":"text"},{"key":"email","value":"","description":"E-mail address asigned to the user account.
\n","type":"text"},{"key":"fname","value":"","description":"First name of the new user.
\n","type":"text"},{"key":"lname","value":"","description":"Last name of the new user.
\n","type":"text"},{"key":"upload","value":"","description":"OPTIONAL - 0 or 1 (No/Yes for upload functionality)
\n","type":"text"},{"key":"edit","value":"","description":"OPTIONAL - 0 or 1 (No/Yes for ablility to edit account details)
\n","type":"text"},{"key":"group_id","value":"","description":"OPTIONAL - Group ID of a group to add this user to
\n","type":"text"},{"key":"tdbase","value":"","description":"OPTIONAL - Base name of user's default tracked directory.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/user/create","description":"By default the API will make all requests as a guest user. This user has limited access to content. To gain access to user specific content you must authenticate and log into the server via this request.
\n","urlObject":{"protocol":"https","path":["api","v1","user","create"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e50f102-d915-4d90-95af-1deebaedd0bd"},{"name":"/user/deactivate","id":"184de8ba-e6df-4e5c-8265-eea5178d44a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"id","value":"","description":"The Biolucida user ID
\n","type":"text"},{"key":"username","value":"","description":"The Biolucida username
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/user/deactivate","description":"To deactivate a Biolucida user. Note: deactivated users remain in the system, but are unable to login.
\n","urlObject":{"protocol":"https","path":["api","v1","user","deactivate"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"184de8ba-e6df-4e5c-8265-eea5178d44a8"},{"name":"/user/delete","id":"2814593f-3d1f-4003-a87c-1aad6f95c969","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"id","value":"","description":"The Biolucida user ID
\n","type":"text"},{"key":"username","value":"","description":"The Biolucida username
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/user/delete","description":"To fully delete a user from Biolucida. Note: any resources owned by the user are transferred to admin ownership during this request.
\n","urlObject":{"protocol":"https","path":["api","v1","user","delete"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"2814593f-3d1f-4003-a87c-1aad6f95c969"},{"name":"/user/update","id":"520b3f61-c2a0-460d-a01b-40ae97b30edb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"","description":"authentication token, see /authenticate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"","description":"The Biolucida username
\n","type":"text"},{"key":"password","value":"","description":"OPTIONAL - Updated password for above user account.
\n","type":"text"},{"key":"email","value":"","description":"OPTIONAL - Updated E-mail address for above user account.
\n","type":"text"},{"key":"fname","value":"","description":"OPTIONAL - Updated first name for above user account.
\n","type":"text"},{"key":"lname","value":"","description":"OPTIONAL - Updated last name for above user account.
\n","type":"text"},{"key":"upload","value":"","description":"OPTIONAL - 0 or 1 (No/Yes for upload functionality)
\n","type":"text"},{"key":"edit","value":"","description":"OPTIONAL - 0 or 1 (No/Yes for ablility to edit account details)
\n","type":"text"},{"key":"tdbase","value":"","description":"OPTIONAL - Base name of user's default tracked directory.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/user/update","description":"By default the API will make all requests as a guest user. This user has limited access to content. To gain access to user specific content you must authenticate and log into the server via this request.
\n","urlObject":{"protocol":"https","path":["api","v1","user","update"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"520b3f61-c2a0-460d-a01b-40ae97b30edb"}],"id":"3f1a7a5d-e8ae-4a7f-83ef-cf9280de3d21","_postman_id":"3f1a7a5d-e8ae-4a7f-83ef-cf9280de3d21","description":""}]}