Service Description Repository

Owned by Patrick Schmitz (Unlicensed)
Last updated: Dec 16, 2014 by Tom Jones
2 min read

The Services Team Home

Introduction

This page contains technical documentation for the CollectionSpace service contracts. The Services Team is primarily responsible for the definition and implementation of these service contracts. Many of the service contracts are based upon work described by a set of functional requirements.

Primary Entity Services

Descriptive Metadata

Search, Selection Context, Reporting

Activities

Vocabularies, Authorities, Standards

Organization

Utility Services

Data and Metadata Management

Workflow and Rules

Security

Administration and Monitoring

Miscellaneous

Create a Task Services category?

Several of the services above, including Movement Service, Authentication Service, and Authorization Service, are categorized as Task Services, not Entity Services, on the /wiki/spaces/collectionspace/pages/666276170 page. Some other services under the Activities subhead, above, might potentially also be Task Services. Should we create a new category for Task Services below and move those services under it? Aron
I like the idea of a task service a lot, Aron.  (Angela)

Creating New Services

First, identify whether there may already be an identical or highly similar service, either listed above or in the /wiki/spaces/collectionspace/pages/666276170 list.

Next, start by looking over the template linked below, and then copy the content for the New Service Home, and its linked (child) pages, to create a new subtree of pages for the new service you are describing.
New Service Home

Designing the REST APIs for New Services

When working on the Contract Description pages for your new services, please keep the following in mind:

Many of CollectionSpace's services are based on the REST architecture. Their public Application Programming Interfaces (APIs) use HTTP as a transport protocol. Using a RESTful model, they expose system data - for reading and, where permitted, for manipulation - as resources accessible via HTTP URLs.

Here are some guidelines to follow when designing and coding the REST-based APIs (service contracts) for your new services, and when drafting or documenting these APIs on your Contract Description pages:

Common Services REST API documentation
Common patterns for building your resource model and functionality to be supported in REST APIs, for entity services, relation services, and task services.

Common System Specific Elements
Data elements that may (or must) be present in HTTP requests to, and responses from, your new service.

Services Layer Cake