Added by Patrick Schmitz, last edited by Sanjay Dalal on Oct 29, 2009  (view change)

Labels:

soa soa Delete
service service Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

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.

Note: As of 2009-05-20, this list of services is subject to change, as project functional requirements - and definition of services to meet those requirements - is currently still ongoing.

Primary Entity Services

Java Client Library

The Java Client Library is an alternative to the REST-based API documented here. It provides an easy way to interact with the services from your Java code.

To build the Java Client Library to these services, download the HelloWorld project from here, and build the HelloWorldJaxb and HelloWorldClient projects, each in their own subdirectories, as described in CollectionSpace Services - Release v0.1.

View example code using the Java Client Library: CollectionObjectServiceTest.java

For more information on how to use the Java Client Library to interact with the CollectionObjectService and other CollectionSpace services in Release 0.1, please see Consuming Services via the Client.

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 below, including Movement Service, Authentication Service, and Authorization Service, are categorized as Task Services, not Entity Services, on the Candidate Services and Related Notes page. Some other services under the Activities subhead, below, 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 Candidate Services and Related Notes 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 System Specific Elements
Data elements that may (or must) be present in HTTP requests to, and responses from, your new service.

REST-based APIs - A Template for Services
Suggested patterns for building your resource model, for entity services, relation services, and task services.

Services Layer Cake

Full Size
A Gliffy Diagram named: Services Layer cake