Emory University annotation API

annotation resource

Documentation Provider Profile APIs.io OpenAPI GitHub

Emory University annotation 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 annotation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 30 operations across 20 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.

30 operations 20 paths 3 schemas 5 DELETE14 GET1 PATCH5 POST5 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 annotation API declares 1 security scheme for authenticating requests. An API key is passed in the header as Girder-Token (Girder-Token).

Paths & Operations 30

Across 20 paths, the API surfaces 30 operations — 5 DELETE, 14 GET, 1 PATCH, 5 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

annotation 30

annotation resource

GET

/annotation

Search for annotations.

annotation_find_annotation 8 params → 200400403

POST

/annotation

Create an annotation.

annotation_createAnnotation_post_annotation 1 param body → 200400403

GET

/annotation/counts

Get annotation counts for a list of items. If using actual a database other than DocumentDB, this also indicates if items are referenced as annotations.

annotation_getItemListAnnotationCounts_counts 1 param → 200400

DELETE

/annotation/folder/{id}

Delete all user-owned annotations from the items in a folder

annotation_deleteFolderAnnotations_delete_folder_id 2 params → 200400

GET

/annotation/folder/{id}

Get the user-owned annotations from the items in a folder

annotation_returnFolderAnnotations_folder_id 6 params → 200400

PUT

/annotation/folder/{id}/access

Set the access for all the user-owned annotations from the items in a folder

annotation_setFolderAnnotationAccess_put_folder_id_access 4 params → 200400

GET

/annotation/folder/{id}/create

Check if the user can create annotations in a folder

annotation_canCreateFolderAnnotations_folder_id_create 1 param → 200400

GET

/annotation/folder/{id}/present

Check if the user owns any annotations for the items in a folder

annotation_existFolderAnnotations_folder_id_present 2 params → 200400

GET

/annotation/images

Search for annotated images.

annotation_findAnnotatedImages_images 6 params → 200400

DELETE

/annotation/item/{id}

Delete all annotations for an item.

annotation_deleteItemAnnotations_delete_item_id 1 param → 200400403

GET

/annotation/item/{id}

Get all annotations for an item.

annotation_getItemAnnotations_item_id 1 param → 200400403

POST

/annotation/item/{id}

Create multiple annotations on an item.

annotation_createItemAnnotations_post_item_id 1 param body → 200400403

POST

/annotation/item/{id}/plot/data

Get plottable data related to an item and its annotations.

annotation_getItemPlottableData_post_item_id_plot_data 6 params body → 200400403

POST

/annotation/item/{id}/plot/list

Get a list of plottable data related to an item and its annotations.

annotation_getItemPlottableElements_post_item_id_plot_list 4 params body → 200400403

DELETE

/annotation/old

Delete old annotations.

annotation_deleteOldAnnotations_delete_old 2 params → 200400

GET

/annotation/old

Report on old annotations.

annotation_getOldAnnotations_old 2 params → 200400

GET

/annotation/schema

Get the official Annotation schema

annotation_getAnnotationSchema_schema → 200400

DELETE

/annotation/{id}

Delete an annotation.

annotation_deleteAnnotation_delete_id 1 param → 200400403

GET

/annotation/{id}

Get an annotation by id.

annotation_getAnnotation_id 16 params → 200400403

PATCH

/annotation/{id}

Patch an annotation or its elements.

annotation_patchAnnotation_patch_id 1 param body → 200204400403

PUT

/annotation/{id}

Update an annotation or move it to a different item.

annotation_updateAnnotation_put_id 2 params body → 200400403

GET

/annotation/{id}/access

Get the access control list for an annotation.

annotation_getAnnotationAccess_id_access 1 param → 200400403

PUT

/annotation/{id}/access

Update the access control list for an annotation.

annotation_updateAnnotationAccess_put_id_access 3 params → 200400403

POST

/annotation/{id}/copy

Copy an annotation from one item to an other.

annotation_copyAnnotation_post_id_copy 2 params → 200400403

GET

/annotation/{id}/history

Get a list of an annotation's history.

annotation_getAnnotationHistoryList_id_history 5 params → 200403

PUT

/annotation/{id}/history/revert

Revert an annotation to a specific version.

annotation_revertAnnotationHistory_put_id_history_revert 2 params → 200400403

GET

/annotation/{id}/history/{version}

Get a specific version of an annotation's history.

annotation_getAnnotationHistory_id_history_version 2 params → 200400403

DELETE

/annotation/{id}/metadata

Delete metadata (annotation.attributes) fields on an annotation.

annotation_deleteMetadata_delete_id_metadata 1 param body → 200400403

PUT

/annotation/{id}/metadata

Set metadata (annotation.attributes) fields on an annotation.

annotation_setMetadata_put_id_metadata 2 params body → 200400403

GET

/annotation/{id}/{format}

Get an annotation by id in a specific format.

annotation_getAnnotationWithFormat_id_format 2 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.

Annotation

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 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

Emory University histomicsui API

AE Profile APIs.io

#annotation

← Back to E APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Emory University annotation API

Metadata

Authentication & Security 1

Paths & Operations 30

Schemas 3

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Emory University annotation API

Metadata

Authentication & Security 1

Paths & Operations 30

Schemas 3

Specification

Source

More from Emory University 12

API Details

Provider

Explore more