...

Table of Contents

...

Table of Contents

OpenSpecimen v1.0 exposes REST APIs that can be consumed to developed custom interfaces and and for integration with other databases. The REST APIs will be consumed by the caTissue OpenSpecimen v2.0 User Interface (built in backbone.js) as well as available for usage for integration with other systems, building plugins or building custom User Interfaces.

Common Characteristics of REST Resources

The following characteristics apply to all caTissue OpenSpecimen API resources:

• You access a resource by sending an HTTP request to the caTissue OpenSpecimen server. The server replies with a response that either contains the data you requested or a status indicator, and in some cases both.
• All resources are located at http[s]://<host-name>:<port>/catissuecore/rest.
• You request a particular resource by appending a particular path to this base URL
• All resources may return any of the below mentioned status codes:

...

On this page, when a portion of a URL, path, or parameter value is shown in italics, it indicates that you should replace the italicized value with a particular value appropriate to your request.

Authentication

caTissue OpenSpecimen REST API's are signed requests, accessible to all the users who has access to caTissue OpenSpecimen application. To access the REST API's user need to pass their caTissue OpenSpecimen credentials by setting them in request Authorization header. The username/password should be encoded in base 64 encoding scheme.

Modules

...