Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For a complete list of assumptions, visit the Service Description and Assumptions page.

References

Object Entry RequirementsCataloging Requirements
CollectionObject Story Summary
CollectionObject Entry Stories
CollectionObject Service Description and Assumptions
CollectionObject Service Entity Diagrams
CollectionObject Schema REST-based APIs - A Template for Services

REST-based API

The CollectionObject Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual CollectionObject instances, plus list operations on multiple CollectionObject instances. These follow the Common model for CollectionSpace REST services.

...

CollectionObject CRUD+L services

Create

...

a CollectionObject

Creates a new CollectionObject record. Assigns a unique, service-specified CollectionSpace ID (CSID) to that CollectionObject record. Follows standard Create model. See the documentation of the CollectionObject schema, below. Example:

Code Block
POST /cspace-services/collectionobjects HTTP/1.1
Read

...

a CollectionObject

Reads an existing CollectionObject record, specified by its CollectionSpace ID (CSID). Follows standard Read model. See the documentation of the CollectionObject schema, below. Example:

Code Block
GET /cspace-services/collectionobjects/{id} HTTP/1.1
Update

...

a CollectionObject

Updates an existing CollectionObject record, specified by its CollectionSpace ID (CSID). Follows standard Update model. See the documentation of the CollectionObject schema, below. Example:

Code Block
PUT /cspace-services/collectionobjects/{id} HTTP/1.1
Delete

...

a CollectionObject

Deletes an existing CollectionObject record, specified by its CollectionSpace ID (CSID). Follows standard Delete model. Example:

...