sparc.biolucida.net public API\nv2020.1.0
\nimage_id: A unique integer value that correlates with a given image in a specific Biolucida collection. Found via /search or /collections/:id API functionality. Also located in the address of every image link within Biolucida Viewer or Biolucida Web Viewer.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8986837","collectionId":"fca8509c-635e-448e-8be2-dfe287d60609","publishedId":"SWLh5mQL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-10T20:08:04.000Z"},"item":[{"name":"annotations","item":[{"name":"/annotations/:id","id":"e0678e2c-79cc-44a3-ae77-ffe445947879","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":[{"id":"1e7d9909-87b4-4872-8a68-98b20ba139d9","description":{"content":"the image id to get annotations for
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"e0678e2c-79cc-44a3-ae77-ffe445947879"}],"id":"0b850647-3a85-4409-9ed5-e3d2271daaa2","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":"0b850647-3a85-4409-9ed5-e3d2271daaa2"},{"name":"authenticate","item":[{"name":"/authenticate","id":"ca0ebd42-6d06-4c2e-b24c-9306e87151ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"","description":"user to log in as
\n","type":"text"},{"key":"password","value":"","description":"password for user
\n","type":"text"},{"key":"token","value":"","description":"unused but still required, just any string
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/authenticate","description":"Authenticate user
\n","urlObject":{"protocol":"https","path":["api","v1","authenticate"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca0ebd42-6d06-4c2e-b24c-9306e87151ec"}],"id":"61302ef9-a6bb-45d7-98f7-dcfce1989af7","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":"61302ef9-a6bb-45d7-98f7-dcfce1989af7"},{"name":"collections","item":[{"name":"/collections/all","id":"e3a9f254-8841-40c8-b033-c4371c9aac96","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":"e3a9f254-8841-40c8-b033-c4371c9aac96"},{"name":"/collections/:id","id":"e771a180-ee60-40ec-9665-c5241fe649d5","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":[{"id":"9fadb7b3-3238-4e7e-a9cd-575df8f28cd8","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":"e771a180-ee60-40ec-9665-c5241fe649d5"},{"name":"/collections/sharelink/:id","id":"76a89b72-5bdb-4a40-af07-7aaf6e96a8aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"authentication token, see /authenticate
\n","key":"token","type":"text","value":""}],"url":"https://BL_SERVER_URL/api/v1/collections/sharelink/:id","urlObject":{"protocol":"https","path":["api","v1","collections","sharelink",":id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"The collection id that you want to generate a link for.
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"76a89b72-5bdb-4a40-af07-7aaf6e96a8aa"},{"name":"/collections/create","id":"1e2eab5a-0022-4e7b-afa2-bffbee2534d1","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":"1e2eab5a-0022-4e7b-afa2-bffbee2534d1"},{"name":"/collections/delete","id":"e831bef5-15ea-4b0a-8b7c-55ff078eec70","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":"e831bef5-15ea-4b0a-8b7c-55ff078eec70"},{"name":"/collections/description","id":"96ebbd48-f379-4147-9d86-394b33f8d422","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":"96ebbd48-f379-4147-9d86-394b33f8d422"},{"name":"/collections/setPermission","id":"69c7cfcf-76bd-492b-ad30-dbe8b05f91cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"authentication token, see /authenticate
\n","key":"token","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"description":"Dataset ID to set permissions on. Can be Blackfynn or Discover.
\n","key":"dataset_id","type":"text","value":""},{"description":"Set collection to public or private.
\n","key":"private_public","type":"text","value":""}]},"url":"https://BL_SERVER_URL/api/v1/collections/setPermission","description":"Set collection to public or private via the dataset ID.
\n","urlObject":{"protocol":"https","path":["api","v1","collections","setPermission"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"69c7cfcf-76bd-492b-ad30-dbe8b05f91cd"},{"name":"/collections/researcher","id":"bc52675c-8cc8-406c-b849-a29e8a6ef959","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":"bc52675c-8cc8-406c-b849-a29e8a6ef959"}],"id":"5e716426-4853-49a8-8198-93030f064483","_postman_id":"5e716426-4853-49a8-8198-93030f064483","description":""},{"name":"folders","item":[{"name":"/folders","id":"03af8439-b006-4be0-9fb6-364a9ec88c78","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":"03af8439-b006-4be0-9fb6-364a9ec88c78"}],"id":"c76bb1b9-9b01-4697-8cfb-cb5d117225b1","_postman_id":"c76bb1b9-9b01-4697-8cfb-cb5d117225b1","description":""},{"name":"image","item":[{"name":"/image/info/:id","id":"32f8f864-62a4-4562-bbf5-04afc99c30cc","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/info/:image_id","description":"get an image at an id
\n","urlObject":{"protocol":"https","path":["api","v1","image","info",":image_id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"type":"any","value":null,"key":"image_id"}]}},"response":[],"_postman_id":"32f8f864-62a4-4562-bbf5-04afc99c30cc"},{"name":"/image/blv_link/:id","id":"595d5175-84dc-42bb-833b-654da9eb99c8","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/blv_link/:id","description":"Get a Biolucida Viewer-compatible share link for a given image id.
\n","urlObject":{"protocol":"https","path":["api","v1","image","blv_link",":id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"the image id to get a blv-compatible share link for
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"595d5175-84dc-42bb-833b-654da9eb99c8"},{"name":"/image/metadata/:id","id":"e6181d82-f40f-4edf-aeb4-1b64d286d923","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/metadata/:image_id","description":"get an image at an id
\n","urlObject":{"protocol":"https","path":["api","v1","image","metadata",":image_id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"the image id to get metadata for
\n","type":"text/plain"},"type":"any","value":null,"key":"image_id"}]}},"response":[],"_postman_id":"e6181d82-f40f-4edf-aeb4-1b64d286d923"},{"name":"/image/xmpmetadata/:id","id":"222c6b98-0511-441d-a017-318f59ed4eba","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_NAME/api/v1/image/xmpmetadata/:id","description":"gets xmp metadata string for a specific image
\n","urlObject":{"protocol":"https","path":["api","v1","image","xmpmetadata",":id"],"host":["BL_SERVER_NAME"],"query":[],"variable":[{"description":{"content":"the image id to request metadata for
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"222c6b98-0511-441d-a017-318f59ed4eba"},{"name":"/image/add_tag","id":"5e1d6c85-ee87-4da3-8e35-354651094fec","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":"5e1d6c85-ee87-4da3-8e35-354651094fec"},{"name":"/image/colandbasename","id":"d2ee63f2-66c9-4778-b115-bfa3955235f8","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_URL/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_URL"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"d2ee63f2-66c9-4778-b115-bfa3955235f8"},{"name":"/image/remove_tag","id":"39970be3-8df1-440d-a3af-9207da867ade","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":"39970be3-8df1-440d-a3af-9207da867ade"}],"id":"77e83ffc-870b-41e4-81f5-592809e3faa4","_postman_id":"77e83ffc-870b-41e4-81f5-592809e3faa4","description":""},{"name":"imagemap","item":[{"name":"/imagemap/add","id":"dacedd88-6f6e-4208-b82a-05a59cf5ad8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"authentication token, see /authenticate
\n","key":"token","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"description":"Biolucida image id.
\n","key":"imageId","type":"text","value":""},{"description":"Blackfynn sourcepackage image id.
\n","key":"sourceId","type":"text","value":""},{"key":"blackfynn_datasetId","value":"","description":"Blackfynn dataset id.
\n","type":"text"},{"key":"discover_datasetId","value":"","description":"Discover dataset id.
\n","type":"text"}]},"url":"https://BL_SERVER_URL/api/v1/imagemap/add","description":"Adds an image mapping for Biolucida and Blackfynn.
\n","urlObject":{"protocol":"https","path":["api","v1","imagemap","add"],"host":["BL_SERVER_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"dacedd88-6f6e-4208-b82a-05a59cf5ad8b"},{"name":"/imagemap/search/:sourcepkg_id","id":"e779a09a-fa0f-42f9-a332-91376c9542c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://BL_SERVER_URL/api/v1/imagemap/search/:sourcepkg_id","description":"Search for Biolucida image id given source package id as parameter.
\n","urlObject":{"protocol":"https","path":["api","v1","imagemap","search",":sourcepkg_id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"description":{"content":"sourcepackage_id for a given image
\n","type":"text/plain"},"type":"string","value":"","key":"sourcepkg_id"}]}},"response":[],"_postman_id":"e779a09a-fa0f-42f9-a332-91376c9542c4"},{"name":"/imagemap/search_dataset/:dataset_source/:dataset_id","id":"ec29167a-d0ef-4186-8b0f-b0f6560d0c4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://BL_SERVER_URL/api/v1/imagemap/search_dataset/:dataset_source/:dataset_id","description":"returns all images in a dataset (either blackfynn or discover) with their associated Biolucida Image IDs and share links
\n","urlObject":{"protocol":"https","path":["api","v1","imagemap","search_dataset",":dataset_source",":dataset_id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"id":"e335bc42-92be-4c79-9c68-e22aece7a3c0","description":{"content":"either \"blackfynn\" or \"discover\" depending on which source contains the specified dataset
\n","type":"text/plain"},"type":"string","value":"","key":"dataset_source"},{"id":"1b32d68f-8570-4577-af92-48e3593db70f","description":{"content":"the dataset id to search images for
\n","type":"text/plain"},"type":"string","value":"","key":"dataset_id"}]}},"response":[],"_postman_id":"ec29167a-d0ef-4186-8b0f-b0f6560d0c4d"},{"name":"/imagemap/sharelink/:sourcepkg_id/:dataset_id","id":"c6d312d5-9ac9-487b-9855-30053e11282f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://BL_SERVER_URL/api/v1/imagemap/sharelink/:sourcepkg_id/:dataset_id","description":"Gets sharelinks for a given image based on its sourcepackage ID and dataset ID. Both are needed, as the sourcepackage ID merely denotes an image's file, and the dataset ID contains which specific instance of the image file we are interested in. In our context, sourcepackage ID is equivalent to tracked file ID, and dataset ID is equivalent to collection ID.
\n","urlObject":{"protocol":"https","path":["api","v1","imagemap","sharelink",":sourcepkg_id",":dataset_id"],"host":["BL_SERVER_URL"],"query":[],"variable":[{"id":"359502b2-79fe-47ab-a11e-f850d4c9f669","description":{"content":"sourcepackage_id for a given image
\n","type":"text/plain"},"type":"string","value":"","key":"sourcepkg_id"},{"id":"b5f524e4-3e68-46e0-b28e-c6d8906e6413","description":{"content":"dataset id (can either be from Blackfynn or Discover)
\n","type":"text/plain"},"type":"string","value":"","key":"dataset_id"}]}},"response":[],"_postman_id":"c6d312d5-9ac9-487b-9855-30053e11282f"}],"id":"1667174b-fccf-4f7e-87e3-b56ad289a640","_postman_id":"1667174b-fccf-4f7e-87e3-b56ad289a640","description":""},{"name":"region","item":[{"name":"/region/:id/:height-:width-:focal_plane-:x-:y-:z","id":"7d4c29b3-e985-4619-83ed-ecfcad66bf41","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":[{"id":"78a5a70e-3b90-4494-99e6-86cce74a6835","description":{"content":"the image id to get a region from
\n","type":"text/plain"},"type":"string","value":"","key":"id"},{"id":"b4d8f188-7996-48a2-a2c3-12af01bf9aa9","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":"7d4c29b3-e985-4619-83ed-ecfcad66bf41"}],"id":"19d8aa7c-7d95-4169-8177-8ffeb8b86f42","description":"functionality to get image regions up to 4000x4000px
\n","_postman_id":"19d8aa7c-7d95-4169-8177-8ffeb8b86f42"},{"name":"search","item":[{"name":"/search/:searchTerm","id":"6ea48de5-6b0e-4b84-971b-57dd3e7098bc","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":[{"id":"15c5498b-7d0f-44a8-a5c4-70a01cc0325e","description":{"content":"The search term. will search filename, description, notes, and tags.
\n","type":"text/plain"},"type":"string","value":"","key":"searchTerm"},{"id":"200a87f5-c58c-478b-b563-2c27c265bd22","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"},{"id":"b7e38c21-0eb5-4471-bbfe-1563c591102e","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":"6ea48de5-6b0e-4b84-971b-57dd3e7098bc"}],"id":"c889e2d8-e01b-4c53-b0a7-3ad78db220e1","description":"functionality for searching images by a keyword or phrase
\n","_postman_id":"c889e2d8-e01b-4c53-b0a7-3ad78db220e1"},{"name":"server","item":[{"name":"/server","id":"8cb7a06f-8c3d-441c-bc08-ded26b88ae5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"Get server metadata and service status
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8cb7a06f-8c3d-441c-bc08-ded26b88ae5f"},{"name":"/server/ports","id":"ad2394cf-a55e-4df5-a0b7-2b09096bf42e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"Get server port numbers
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"ad2394cf-a55e-4df5-a0b7-2b09096bf42e"},{"name":"/server/quickcode","id":"683206af-6fd9-4b98-93e0-70fec4663ff6","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":"683206af-6fd9-4b98-93e0-70fec4663ff6"}],"id":"4934ad3d-a510-46ff-8275-c1e9b62d5927","description":"requests for various metadata about this server
\n","_postman_id":"4934ad3d-a510-46ff-8275-c1e9b62d5927"},{"name":"slides","item":[{"name":"/slides/:min_offset/:max_returned/:folder_path","id":"746246e5-4351-49ba-9070-9cd90c0cd088","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":[{"id":"da45b036-0af3-4725-ae7f-e9bcd22feb96","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"},{"id":"071496d8-1d47-4dd6-82b8-271ce185bdc0","description":{"content":"sets how many images to return
\n","type":"text/plain"},"type":"string","value":"","key":"max_returned"},{"id":"7be5a77b-3bbd-440c-9b77-553e64988f7b","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":"746246e5-4351-49ba-9070-9cd90c0cd088"}],"id":"120178c5-b813-4bbc-a8c2-5f01a61c1085","description":"requests that gather all images within a collection or tracked dir
\n","_postman_id":"120178c5-b813-4bbc-a8c2-5f01a61c1085"},{"name":"tag","item":[{"name":"/tag/all","id":"901d81e8-51e6-41e7-bf2a-e584ba75b580","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":"901d81e8-51e6-41e7-bf2a-e584ba75b580"},{"name":"/tag/group/all","id":"8b391945-0892-4d62-975e-d9cc82133259","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":"8b391945-0892-4d62-975e-d9cc82133259"},{"name":"/tag/topn/:image_id/:count","id":"87baea83-2b8d-4b9c-a4af-79a087bcaf46","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":[{"id":"3066c3e4-8fa4-4de8-9154-ba2925e56d2d","description":{"content":"the image id to fetch tags for
\n","type":"text/plain"},"type":"string","value":"","key":"image_id"},{"id":"a938cbbd-5be0-4411-9d0a-8be78ab9d64f","description":{"content":"OPTIONAL - the number of tags to fetch. defaults to 5.
\n","type":"text/plain"},"type":"string","value":"","key":"count"}]}},"response":[],"_postman_id":"87baea83-2b8d-4b9c-a4af-79a087bcaf46"},{"name":"/tag/create","id":"9968cdd9-33e1-41a0-adba-5f10c36b7ec9","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":"9968cdd9-33e1-41a0-adba-5f10c36b7ec9"},{"name":"/tag/delete","id":"35c80c47-3a05-4d5a-ab16-e5f88a41b50a","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":"35c80c47-3a05-4d5a-ab16-e5f88a41b50a"},{"name":"/tag/group/add_tag","id":"016da924-a92e-4a3a-ab54-78ef455010ef","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":"016da924-a92e-4a3a-ab54-78ef455010ef"},{"name":"/tag/group/create","id":"5a9589fb-ffde-4051-90cd-2ea8a62b4cac","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":"5a9589fb-ffde-4051-90cd-2ea8a62b4cac"},{"name":"/tag/group/delete","id":"bc29d1e7-9ab1-4d5b-90ff-8ec3354a9139","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":"bc29d1e7-9ab1-4d5b-90ff-8ec3354a9139"},{"name":"/tag/group/remove_tag","id":"0f534422-aa85-4c8b-8b02-6d658ee7810b","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":"0f534422-aa85-4c8b-8b02-6d658ee7810b"}],"id":"f9c22482-7f65-4e73-840d-9ee2d960b06f","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":"f9c22482-7f65-4e73-840d-9ee2d960b06f"},{"name":"thumbnail","item":[{"name":"/thumbnail/:imageId","id":"03625096-4ddc-4f10-bfac-e71d2ffdff1e","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":"03625096-4ddc-4f10-bfac-e71d2ffdff1e"},{"name":"/thumbnail/setSingle","id":"f25ff4a9-8119-4287-a077-3369734f75b3","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":"f25ff4a9-8119-4287-a077-3369734f75b3"},{"name":"/thumbnail/setRoot","id":"5149a941-e437-4407-8381-bb9895ea4ab9","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":"5149a941-e437-4407-8381-bb9895ea4ab9"},{"name":"/thumbnail/resetSingle","id":"c9843f5b-29fa-4c04-bf9d-3c903e1ce6fd","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":"c9843f5b-29fa-4c04-bf9d-3c903e1ce6fd"},{"name":"/thumbnail/resetRoot","id":"1f6ab9b6-02cb-4759-b20e-83e5b5410e91","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":"1f6ab9b6-02cb-4759-b20e-83e5b5410e91"}],"id":"8f7ce269-f40c-4037-8205-988f6a835278","_postman_id":"8f7ce269-f40c-4037-8205-988f6a835278","description":""},{"name":"tile","item":[{"name":"/tile/:id","id":"ad67ff88-b74f-437c-8f34-f15034bbd657","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":[{"id":"74dae89f-d770-4e8b-bda6-3c3a54356dd3","description":{"content":"The image id to fetch a preview for
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"ad67ff88-b74f-437c-8f34-f15034bbd657"},{"name":"/tile/:id/:f-:x-:y","id":"7ff38e2b-505e-4684-b381-7ca26451dffa","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":[{"id":"64f77783-bc55-4c84-be4b-2b430373c994","description":{"content":"the image id to fetch this tile for
\n","type":"text/plain"},"type":"string","value":"","key":"id"},{"id":"e8accf30-6813-49f4-806b-42a930eb8111","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":"7ff38e2b-505e-4684-b381-7ca26451dffa"},{"name":"/tile/:id/:f-:x-:y-:z","id":"64097ff4-307a-4dd3-a5e4-6328ea718d73","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":"64097ff4-307a-4dd3-a5e4-6328ea718d73"}],"id":"ac3cb662-cf79-4f28-9a25-e3057f9a692a","description":"requests that access specific image tiles
\n","_postman_id":"ac3cb662-cf79-4f28-9a25-e3057f9a692a"},{"name":"upload","item":[{"name":"/upload/init","id":"f116eedf-a2a8-4438-baa5-b33c76241e41","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":"f116eedf-a2a8-4438-baa5-b33c76241e41"},{"name":"/upload/continue","id":"4539dcb4-880c-4830-afaa-4479fb0724fc","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":"4539dcb4-880c-4830-afaa-4479fb0724fc"},{"name":"/upload/finish","id":"6030489d-989e-4107-b75c-745fc075111e","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":"6030489d-989e-4107-b75c-745fc075111e"},{"name":"/upload/cancel","id":"0af9b10f-15ae-436c-8b6c-a8ad2aee1261","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":"0af9b10f-15ae-436c-8b6c-a8ad2aee1261"}],"id":"2ff1da45-0e96-46e8-8115-77a4e2204c88","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":"a5e24d92-d027-4d06-aa7b-953f32148e11"},{"name":"/user/groups","id":"45300013-c9a8-4383-9b7a-219fccfa55fe","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":"45300013-c9a8-4383-9b7a-219fccfa55fe"},{"name":"/user/:id","id":"deafa57a-e4c2-4d3f-b06f-9d36033f5830","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":"deafa57a-e4c2-4d3f-b06f-9d36033f5830"},{"name":"/user/:username","id":"f1001f94-dff2-4716-8928-aa421842f311","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":"f1001f94-dff2-4716-8928-aa421842f311"},{"name":"/user/create","id":"f5d66bf8-4101-43ac-b660-a05ca0395ec3","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":"f5d66bf8-4101-43ac-b660-a05ca0395ec3"},{"name":"/user/deactivate","id":"6e22ff34-176c-4105-ae33-71ab6c82bd67","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":"6e22ff34-176c-4105-ae33-71ab6c82bd67"},{"name":"/user/delete","id":"5fa27c36-c533-499d-877f-3b02b1eebe67","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":"5fa27c36-c533-499d-877f-3b02b1eebe67"},{"name":"/user/update","id":"16d30d58-c22d-43e0-a61e-fb4a5d77b0e5","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":"16d30d58-c22d-43e0-a61e-fb4a5d77b0e5"}],"id":"e885a8e8-3427-44a7-b162-f780d31c721b","_postman_id":"e885a8e8-3427-44a7-b162-f780d31c721b","description":""}],"event":[{"listen":"prerequest","script":{"id":"8e80c57b-01fe-4aee-9263-609d356697c4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"357f823a-28c4-466b-b817-49b0429016d8","type":"text/javascript","exec":[""]}}]}