Emory University item API

item resource

Documentation Provider Profile APIs.io OpenAPI GitHub

Emory University item API is one of 25 APIs that Emory University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include item. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 47 operations across 34 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 3.2.14.

Requests are made against a single base URL, https://computablebrain.emory.edu/api/v1.

47 operations 34 paths 3 schemas 6 DELETE31 GET6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.3

API Version

3.2.14

Base URL

https://computablebrain.emory.edu/api/v1

Authentication

API Key

License

Apache-2.0

Resource Areas

Authentication & Security 1

Emory University item API declares 1 security scheme for authenticating requests. An API key is passed in the header as Girder-Token (Girder-Token).

Paths & Operations 47

Across 34 paths, the API surfaces 47 operations — 6 DELETE, 31 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

item 47

item resource

GET

/item

List or search for items.

item_find_item 7 params → 200400403

POST

/item

Create a new item.

item_createItem_post_item 4 params body → 200400403

GET

/item/query

List items that match a query.

item_getItemsByQuery_query 5 params → 200400

GET

/item/test/tiles

Get test large image metadata.

item_getTestTilesInfo_test_tiles → 200400

GET

/item/test/tiles/zxy/{z}/{x}/{y}

Get a test large image tile.

item_getTestTile_test_tiles_zxy_z_x_y 3 params → 200400

DELETE

/item/{id}

Delete an item by ID.

item_deleteItem_delete_id 1 param → 200400403

GET

/item/{id}

Get an item by ID.

item_getItem_id 1 param → 200400403

PUT

/item/{id}

Edit an item or move it to another folder.

item_updateItem_put_id 4 params body → 200400403

GET

/item/{id}/adjacent_images

Get the previous and next image in the same folder as the given item.

item_getPreviousAndNextImages_id_adjacent_images 2 params → 200400404

DELETE

/item/{id}/aperio

Remove Aperio specific metadata from an item

item_removeAperio_delete_id_aperio 1 param → 200400

GET

/item/{id}/aperio

Find Aperio annotation items associated with a slide image.

item_findAperio_id_aperio 6 params → 200400

POST

/item/{id}/aperio

Import an item as an Aperio annotation

item_importDocument_post_id_aperio 3 params → 200400

PUT

/item/{id}/aperio

Set the tag associated with the annotation file

item_modifyAperio_put_id_aperio 2 params → 200400

POST

/item/{id}/copy

Copy an item.

item_copyItem_post_id_copy 5 params → 200400403

GET

/item/{id}/download

Download the contents of an item.

item_download_id_download 5 params → 200400403

GET

/item/{id}/files

Get the files within an item.

item_getFiles_id_files 5 params → 200400403

DELETE

/item/{id}/metadata

Delete metadata fields on an item.

item_deleteMetadata_delete_id_metadata 1 param body → 200400403

PUT

/item/{id}/metadata

Set metadata fields on an item.

item_setMetadata_put_id_metadata 2 params body → 200400403

GET

/item/{id}/next_image

Get the next image in the same folder as the given item.

item_getNextImage_id_next_image 2 params → 200400404

GET

/item/{id}/position

Report the offset of an item in a list or search.

item_findPosition_id_position 6 params → 200400403

GET

/item/{id}/previous_image

Get the previous image in the same folder as the given item.

item_getPreviousImage_id_previous_image 2 params → 200400404

GET

/item/{id}/rootpath

Get the path to the root of the item's hierarchy.

item_rootpath_id_rootpath 1 param → 200400403

DELETE

/item/{itemId}/internal_metadata/{key}

Delete a single internal metadata key on this item.

item_deleteMetadataKey_delete_itemId_internal_metadata_key 2 params → 200400403

GET

/item/{itemId}/internal_metadata/{key}

Get the value for a single internal metadata key on this item.

item_getMetadataKey_itemId_internal_metadata_key 2 params → 200400403

PUT

/item/{itemId}/internal_metadata/{key}

Overwrite the value for a single internal metadata key on this item.

item_updateMetadataKey_put_itemId_internal_metadata_key 2 params body → 200400403

DELETE

/item/{itemId}/tiles

Remove a large image from this item.

item_deleteTiles_delete_itemId_tiles 1 param → 200400

GET

/item/{itemId}/tiles

Get large image metadata.

item_getTilesInfo_itemId_tiles 1 param → 200400403

POST

/item/{itemId}/tiles

Create a large image for this item.

item_createTiles_post_itemId_tiles 13 params → 200400

GET

/item/{itemId}/tiles/bands

Get band information for a large image item.

item_getBandInformation_itemId_tiles_bands 2 params → 200400403

POST

/item/{itemId}/tiles/convert

Create a new large image item based on an existing item

item_convertImage_post_itemId_tiles_convert 15 params → 200400

GET

/item/{itemId}/tiles/dzi.dzi

Get DeepZoom compatible metadata.

item_getDZIInfo_itemId_tiles_dzi.dzi 3 params → 200400403

GET

/item/{itemId}/tiles/dzi_files/{level}/{xandy}

Get a DeepZoom image tile.

item_getDZITile_itemId_tiles_dzi_files_level_xandy 3 params → 200400403

GET

/item/{itemId}/tiles/fzxy/{frame}/{z}/{x}/{y}

Get a large image tile with a frame number.

item_getTileWithFrame_itemId_tiles_fzxy_frame_z_x_y 6 params → 200400403

GET

/item/{itemId}/tiles/histogram

Get a histogram for any region of a large image item.

item_getHistogram_itemId_tiles_histogram 11 params → 200400403

GET

/item/{itemId}/tiles/images

Get a list of additional images associated with a large image.

item_getAssociatedImagesList_itemId_tiles_images 1 param → 200400403

GET

/item/{itemId}/tiles/images/{image}

Get an image associated with a large image.

item_getAssociatedImage_itemId_tiles_images_image 7 params → 200400403

GET

/item/{itemId}/tiles/images/{image}/metadata

Get metadata for an image associated with a large image.

item_getAssociatedImageMetadata_itemId_tiles_images_image_metadata 2 params → 200400403

GET

/item/{itemId}/tiles/internal_metadata

Get large image internal metadata.

item_getInternalMetadata_itemId_tiles_internal_metadata 1 param → 200400403

GET

/item/{itemId}/tiles/pixel

Get a single pixel of a large image item.

item_getTilesPixel_itemId_tiles_pixel 6 params → 200400403

GET

/item/{itemId}/tiles/region

Get any region of a large image item, optionally scaling it.

item_getTilesRegion_itemId_tiles_region 24 params → 200400403

GET

/item/{itemId}/tiles/thumbnail

Get a thumbnail of a large image item.

item_getTilesThumbnail_itemId_tiles_thumbnail 8 params → 200400403

DELETE

/item/{itemId}/tiles/thumbnails

Delete thumbnail and data files associated with a largeimage item.

item_deleteTilesThumbnails_delete_itemId_tiles_thumbnails 4 params → 200400403

GET

/item/{itemId}/tiles/thumbnails

List all thumbnail and data files associated with a largeimage item.

item_listTilesThumbnails_itemId_tiles_thumbnails 1 param → 200400403

POST

/item/{itemId}/tiles/thumbnails

Associate or replace a thumbnail or data file with a largeimage items.

item_addTilesThumbnails_post_itemId_tiles_thumbnails 4 params body → 200400403

GET

/item/{itemId}/tiles/tile_frames

Composite thumbnails of multiple frames into a single image.

item_tileFrames_itemId_tiles_tile_frames 27 params → 200400403

GET

/item/{itemId}/tiles/tile_frames/quad_info

Get parameters for using tileframes as background sprite images.

item_tileFramesQuadInfo_itemId_tiles_tile_frames_quad_info 14 params → 200400403

GET

/item/{itemId}/tiles/zxy/{z}/{x}/{y}

Get a large image tile.

item_getTile_itemId_tiles_zxy_z_x_y 5 params → 200400403

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

File

object

string

Item

object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Emory University publishes across the network.

Emory Canvas LMS REST API

AE Profile APIs.io

Emory Identity (Shibboleth / SAML)

AE Profile APIs.io

Emory Libraries Digital Repository Software

AE Profile APIs.io

Emory University annotation API

AE Profile APIs.io

Emory University api_key API

AE Profile APIs.io

Emory University assetstore API

AE Profile APIs.io

Emory University collection API

AE Profile APIs.io

Emory University dicomweb_assetstore API

AE Profile APIs.io

Emory University file API

AE Profile APIs.io

Emory University files API

AE Profile APIs.io

Emory University folder API

AE Profile APIs.io

Emory University group API

AE Profile APIs.io

#item

← Back to E APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Emory University item API

Metadata

Authentication & Security 1

Paths & Operations 47

Schemas 3

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Emory University item API

Metadata

Authentication & Security 1

Paths & Operations 47

Schemas 3

Specification

Source

More from Emory University 12

API Details

Provider

Explore more