Web API Endpoints¶

Autogenerated from flask

TODO: Separate by blueprints here manually

GET /admin2/mongoimagestoreview/ajax/lookup/¶

GET /admin2/ptiffimagestoreview/ajax/lookup/¶

GET /admin2/mongoimagestoreview/api/file/¶

GET /admin2/ptiffimagestoreview/api/file/¶

GET /admin2/shibbolethuserview/ajax/lookup/¶

GET /admin2/shibbolethuserview/api/file/¶

GET /admin2/unlistedgroupview/ajax/lookup/¶

GET /admin2/unlistedgroupview/api/file/¶

GET /admin2/passworduserview/ajax/lookup/¶

GET /admin2/facebookuserview/ajax/lookup/¶

GET /admin2/linkedinuserview/ajax/lookup/¶

GET /admin2/passworduserview/api/file/¶

GET /admin2/facebookuserview/api/file/¶

GET /admin2/linkedinuserview/api/file/¶

GET /admin2/publicgroupview/ajax/lookup/¶

GET /admin2/publicgroupview/api/file/¶

GET /admin2/googleuserview/ajax/lookup/¶

GET /admin2/collectionview/ajax/lookup/¶

GET /admin2/googleuserview/api/file/¶

GET /admin2/collectionview/api/file/¶

GET /admin2/groupview/ajax/lookup/¶

GET /admin2/groupview/api/file/¶

GET /admin2/userview/ajax/lookup/¶

GET /admin2/userview/api/file/¶

POST /api/v2/imagestores/deliver¶

POST /api/v2/imagestores/import¶

POST /admin2/mongoimagestoreview/action/¶: Mass-model action view.

POST /admin2/mongoimagestoreview/delete/¶: Delete model view. Only POST method is allowed.

POST /admin2/ptiffimagestoreview/action/¶: Mass-model action view.

POST /admin2/ptiffimagestoreview/delete/¶: Delete model view. Only POST method is allowed.

GET /admin2/mongoimagestoreview/edit/¶: Edit model view

POST /admin2/mongoimagestoreview/edit/¶: Edit model view

GET /admin2/ptiffimagestoreview/edit/¶: Edit model view

POST /admin2/ptiffimagestoreview/edit/¶: Edit model view

GET /admin2/mongoimagestoreview/new/¶: Create model view

POST /admin2/mongoimagestoreview/new/¶: Create model view

GET /admin2/ptiffimagestoreview/new/¶: Create model view

POST /admin2/ptiffimagestoreview/new/¶: Create model view

POST /admin2/shibbolethuserview/action/¶: Mass-model action view.

POST /admin2/shibbolethuserview/delete/¶: Delete model view. Only POST method is allowed.

GET /admin2/shibbolethuserview/edit/¶: Edit model view

POST /admin2/shibbolethuserview/edit/¶: Edit model view

GET /admin2/shibbolethuserview/new/¶: Create model view

POST /admin2/shibbolethuserview/new/¶: Create model view

POST /admin2/unlistedgroupview/action/¶: Mass-model action view.

POST /admin2/unlistedgroupview/delete/¶: Delete model view. Only POST method is allowed.

GET /admin2/unlistedgroupview/edit/¶: Edit model view

POST /admin2/unlistedgroupview/edit/¶: Edit model view

GET /admin2/unlistedgroupview/new/¶: Create model view

POST /admin2/unlistedgroupview/new/¶: Create model view

POST /admin2/passworduserview/action/¶: Mass-model action view.

POST /admin2/passworduserview/delete/¶: Delete model view. Only POST method is allowed.

POST /admin2/facebookuserview/action/¶: Mass-model action view.

POST /admin2/facebookuserview/delete/¶: Delete model view. Only POST method is allowed.

POST /admin2/linkedinuserview/action/¶: Mass-model action view.

POST /admin2/linkedinuserview/delete/¶: Delete model view. Only POST method is allowed.

GET /admin2/passworduserview/edit/¶: Edit model view

POST /admin2/passworduserview/edit/¶: Edit model view

GET /admin2/facebookuserview/edit/¶: Edit model view

POST /admin2/facebookuserview/edit/¶: Edit model view

GET /admin2/linkedinuserview/edit/¶: Edit model view

POST /admin2/linkedinuserview/edit/¶: Edit model view

GET /admin2/passworduserview/new/¶: Create model view

POST /admin2/passworduserview/new/¶: Create model view

GET /admin2/facebookuserview/new/¶: Create model view

POST /admin2/facebookuserview/new/¶: Create model view

GET /admin2/linkedinuserview/new/¶: Create model view

POST /admin2/linkedinuserview/new/¶: Create model view

POST /admin2/publicgroupview/action/¶: Mass-model action view.

POST /admin2/publicgroupview/delete/¶: Delete model view. Only POST method is allowed.

GET /admin2/publicgroupview/edit/¶: Edit model view

POST /admin2/publicgroupview/edit/¶: Edit model view

GET /admin2/publicgroupview/new/¶: Create model view

POST /admin2/publicgroupview/new/¶: Create model view

POST /admin2/googleuserview/action/¶: Mass-model action view.

POST /admin2/googleuserview/delete/¶: Delete model view. Only POST method is allowed.

POST /admin2/collectionview/action/¶: Mass-model action view.

POST /admin2/collectionview/delete/¶: Delete model view. Only POST method is allowed.

GET /admin2/googleuserview/edit/¶: Edit model view

POST /admin2/googleuserview/edit/¶: Edit model view

GET /admin2/collectionview/edit/¶: Edit model view

POST /admin2/collectionview/edit/¶: Edit model view

GET /admin2/googleuserview/new/¶: Create model view

POST /admin2/googleuserview/new/¶: Create model view

GET /admin2/collectionview/new/¶: Create model view

POST /admin2/collectionview/new/¶: Create model view

POST /admin2/groupview/action/¶: Mass-model action view.

POST /admin2/groupview/delete/¶: Delete model view. Only POST method is allowed.

GET /admin2/groupview/edit/¶: Edit model view

POST /admin2/groupview/edit/¶: Edit model view

GET /admin2/groupview/new/¶: Create model view

POST /admin2/groupview/new/¶: Create model view

POST /admin2/userview/action/¶: Mass-model action view.

POST /admin2/userview/delete/¶: Delete model view. Only POST method is allowed.

GET /admin2/userview/edit/¶: Edit model view

POST /admin2/userview/edit/¶: Edit model view

GET /admin2/userview/new/¶: Create model view

POST /admin2/userview/new/¶: Create model view

GET /login/password/register¶: View function which handles a registration request.

POST /login/password/register¶: View function which handles a registration request.

GET /login/password/register¶: View function which handles a registration request.

POST /login/password/register¶: View function which handles a registration request.

GET /login/password/confirm¶: View function which sends confirmation instructions.

POST /login/password/confirm¶: View function which sends confirmation instructions.

GET /login/password/confirm¶: View function which sends confirmation instructions.

POST /login/password/confirm¶: View function which sends confirmation instructions.

GET /login/password/change¶: View function which handles a change password request.

POST /login/password/change¶: View function which handles a change password request.

GET /login/password/change¶: View function which handles a change password request.

POST /login/password/change¶: View function which handles a change password request.

GET /login/password/reset¶: View function that handles a forgotten password request.

POST /login/password/reset¶: View function that handles a forgotten password request.

GET /login/password/reset¶: View function that handles a forgotten password request.

POST /login/password/reset¶: View function that handles a forgotten password request.

GET /api/v2/imagestores¶

POST /api/v2/imagestores¶

GET /api/v2/collections¶

POST /api/v2/collections¶

GET /api/v2/permalinks¶

POST /api/v2/permalinks¶

GET /api/v2/sessions¶

POST /api/v2/sessions¶

Create a session.

The request should be of type ‘application/json’, not ‘application/x-www-form-urlencoded’.

The request must be of the format:

{: “collection”: “0123456789abcdef01234567”, “label” : “New Session Name”

}

GET /api/v2/groups¶

POST /api/v2/groups¶

GET /api/v2/users¶

POST /api/v2/users¶

GET /webgl-viewer/getparentcomments¶

POST /webgl-viewer/getparentcomments¶

GET /webgl-viewer/set-image-bounds¶

POST /webgl-viewer/set-image-bounds¶

GET /webgl-viewer/session-add-view¶

POST /webgl-viewer/session-add-view¶

GET /webgl-viewer/getfavoriteviews¶

POST /webgl-viewer/getfavoriteviews¶

GET /webgl-viewer/savesessiontitle¶

POST /webgl-viewer/savesessiontitle¶

POST /webgl-viewer/save-view-order¶

GET /webgl-viewer/gettrackingdata¶

GET /webgl-viewer/deleteusernote¶

POST /webgl-viewer/deleteusernote¶

POST /webgl-viewer/saveimagedata¶

GET /webgl-viewer/saveviewnotes¶

POST /webgl-viewer/saveviewnotes¶

GET /webgl-viewer/getimagenames¶

GET /webgl-viewer/getusernotes¶

GET /webgl-viewer/saveusernote¶

POST /webgl-viewer/saveusernote¶

POST /webgl-viewer/hide-labels¶

GET /webgl-viewer/stack-save¶

POST /webgl-viewer/stack-save¶

GET /webgl-viewer/getcomment¶

POST /webgl-viewer/getcomment¶

POST /webgl-viewer/move-view¶

GET /webgl-viewer/bookmark¶

/bookmark?key=0295cf24-6d51-4ce8-a923-772ebc71abb5

GET /webgl-viewer/getview¶

GET /webgl-viewer/query¶

/query?words=[]

GET /admin2/mongoimagestoreview/¶: List view

GET /admin2/ptiffimagestoreview/¶: List view

GET /admin2/shibbolethuserview/¶: List view

GET /admin2/unlistedgroupview/¶: List view

GET /admin2/passworduserview/¶: List view

GET /admin2/facebookuserview/¶: List view

GET /admin2/linkedinuserview/¶: List view

GET /admin2/publicgroupview/¶: List view

GET /admin2/googleuserview/¶: List view

GET /admin2/collectionview/¶: List view

GET /admin2/groupview/¶: List view

GET /admin2/userview/¶: List view

GET /apiv1/mysessions¶: Single page application with uses this rest API to interactively do tasks

POST /apiv1/databases¶

GET /apiv1/admin¶: Single page application with uses this rest API to interactively do tasks

GET /session-save-stack¶

POST /session-save-stack¶

GET /webgl-viewer¶

GET /session-save¶

POST /session-save¶

GET /favicon.ico¶

GET /viewthumb¶: Gets a thumbnail from view directly, Chains the request to view objects helper method

GET /bookmarks¶

GET /sessions¶

/sessions
With no argument displays list of sessions accessible to current user
/sessions?sessid=10239094124 searches for the session id

GET /status¶

GET /logout¶: View function which handles a logout request.

GET /logout¶: View function which handles a logout request.

GET /search¶: Entry point into angularjs app for interactive search results

GET /modify¶: Locates a record based on ID and modifies a particular field to new value

GET /admin2/¶

GET /login¶: View function for login view

POST /login¶: View function for login view

GET /login¶: View function for login view

POST /login¶: View function for login view

GET /thumb¶

GET /query¶

/query?include=views&words=[]

accepts search terms

GET /home¶

GET /tile¶

GET /view¶: redirects to the glviewer endpoint

GET /¶

POST /api/v2/sessions/(Session: session)/(regex: restype)/(ObjectId: attachment_id)/process¶: Submits a celery request to process the given file (retry)

GET /api/v2/sessions/(Session: session)/views/(ObjectId: view_id)¶

PUT /api/v2/sessions/(Session: session)/views/(ObjectId: view_id)¶

DELETE /api/v2/sessions/(Session: session)/views/(ObjectId: view_id)¶

PATCH /api/v2/sessions/(Session: session)/views/(ObjectId: view_id)¶

GET /api/v2/sessions/(Session: session)/(regex: restype)/(ObjectId: attachment_id)¶

PUT /api/v2/sessions/(Session: session)/(regex: restype)/(ObjectId: attachment_id)¶

POST /api/v2/sessions/(Session: session)/(regex: restype)/(ObjectId: attachment_id)¶: Currently adding imagefiles only backend for flow.js

DELETE /api/v2/sessions/(Session: session)/(regex: restype)/(ObjectId: attachment_id)¶

POST /api/v2/imagestores/(ImageStore: image_store)/deliver¶

POST /api/v2/imagestores/(ImageStore: image_store)/import¶

GET /api/v2/collections/(Collection: collection)/access¶

PUT /api/v2/collections/(Collection: collection)/access¶

GET /api/v2/sessions/(Session: session)/access¶

PUT /api/v2/sessions/(Session: session)/access¶

GET /api/v2/sessions/(Session: session)/views¶

POST /api/v2/sessions/(Session: session)/views¶

GET /api/v2/sessions/(Session: session)/(regex: restype)¶

POST /api/v2/sessions/(Session: session)/(regex: restype)¶

GET /cutout/(ObjectId: image_store_id)/(ObjectId: image_id)/(filename)¶

Returns a requested image assembled from the tiles

to test fire following request from a view.

$.ajax({: type: “GET”, url: “/cutout/5074589302e31023d4292d97/4f9b36c84834a3056400001b/image.png”, data: {debug:0, bounds:JSON.stringify([0,500,0,500])}, });

or

http://localhost:8080/cutout/5074589302e31023d4292d97/4f9b36c84834a3056400001b/image.png?some=other&bounds=%5B8498.331884204574%2C8806.831884204574%2C9438.890126159336%2C9919.390126159336%5D

Accepts url paramters debug, and bounds which is json string of array of four bounds

GET /login/password/confirm/(token)¶: View function which handles a email confirmation request.

POST /login/password/confirm/(token)¶: View function which handles a email confirmation request.

GET /login/password/confirm/(token)¶: View function which handles a email confirmation request.

POST /login/password/confirm/(token)¶: View function which handles a email confirmation request.

GET /login/password/reset/(token)¶: View function that handles a reset password request.

POST /login/password/reset/(token)¶: View function that handles a reset password request.

GET /login/password/reset/(token)¶: View function that handles a reset password request.

POST /login/password/reset/(token)¶: View function that handles a reset password request.

GET /apiv1/(regex: dbid)/sessions/(regex: sessid)¶: Gets details of a session if sessid is specified, or gets a list of sessions otherwise Also provides thumbnails if thumb=true in the query string

POST /apiv1/(regex: dbid)/sessions/(regex: sessid)¶

DELETE /apiv1/(regex: dbid)/sessions/(regex: sessid)¶: cdGets details of a session if sessid is specified, or gets a list of sessions otherwise

GET /apiv1/(regex: restype)/(regex: resid)/(regex: listtype)¶

POST /apiv1/(regex: restype)/(regex: resid)/(regex: listtype)¶

GET /tile/(ObjectId: image_store_id)/(ObjectId: image_id)/(string: tile_name)¶

Return a tile image.

Note that the ‘image_store’ and ‘image_id’ URL parameters are accepted as an ObjectIds, to prevent unnecessary database queries if HTTP caching causes a 304 (Not Modified) response to be returned.

GET /api/v2/imagestores/(ImageStore: image_store)¶

PUT /api/v2/imagestores/(ImageStore: image_store)¶

DELETE /api/v2/imagestores/(ImageStore: image_store)¶

PATCH /api/v2/imagestores/(ImageStore: image_store)¶

GET /api/v2/collections/(Collection: collection)¶

PUT /api/v2/collections/(Collection: collection)¶

DELETE /api/v2/collections/(Collection: collection)¶

PATCH /api/v2/collections/(Collection: collection)¶

GET /api/v2/sessions/(Session: session)¶

PUT /api/v2/sessions/(Session: session)¶

DELETE /api/v2/sessions/(Session: session)¶

PATCH /api/v2/sessions/(Session: session)¶

GET /api/v2/groups/(Group: group)¶

PUT /api/v2/groups/(Group: group)¶

DELETE /api/v2/groups/(Group: group)¶

GET /api/v2/users/(User: user)¶

PUT /api/v2/users/(User: user)¶

DELETE /api/v2/users/(User: user)¶

GET /webgl-viewer/static/(path: filename)¶: Function used internally to send static files from the static folder to the browser.

New in version 0.5.

GET /collections/(Collection: collection)/edit¶

GET /sessions/(Session: session)/newstack¶

GET /admin2/static/(path: filename)¶: Function used internally to send static files from the static folder to the browser.

New in version 0.5.

GET /tileat/(ObjectId: image_store_id)/(ObjectId: image_id)¶: Returns a requested image assembled from the tiles

PUT /apiv1/databases/(regex: resid)¶

POST /apiv1/databases/(regex: resid)¶

DELETE /apiv1/databases/(regex: resid)¶

GET /apiv1/static/(path: filename)¶: Function used internally to send static files from the static folder to the browser.

New in version 0.5.

GET /apiv1/(regex: dbid)/sessions¶: Gets details of a session if sessid is specified, or gets a list of sessions otherwise Also provides thumbnails if thumb=true in the query string

POST /apiv1/(regex: dbid)/sessions¶

GET /thumb/(ImageStore: image_store)/(Image: image)¶: Return a thumbnail image

GET /apiv1/(regex: restype)/(regex: resid)¶: Get restype with resid [‘users’], if resid is not supplied, returns a list

GET /sessions/(Session: session)¶

GET /static/(path: filename)¶: Function used internally to send static files from the static folder to the browser.

New in version 0.5.

GET /apiv1/(regex: restype)¶: Get restype with resid [‘users’], if resid is not supplied, returns a list

GET /link/(code)¶