For a full description, visit the Service Description and Assumptions page.
For a complete list of assumptions, visit the Service Description and Assumptions page.
CollectionObject Story Summary
CollectionObject Entry Stories
CollectionObject Service Description and Assumptions
CollectionObject Service Entity Diagrams
REST-based APIs - A Template for Services
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:
Read a CollectionObject
Update a CollectionObject
Delete a CollectionObject
List CollectionObject instances
Lists existing CollectionObject records, with summary information for each. Follows standard List model. See the documentation of the CollectionObject list schema, below. Example:
CollectionObject REST payload schemas
CollectionObject instance schema
Create and Update should use the following schema:
Read will return the following schema:
CollectionObject list schema
List (and variants) will return the following schema. This schema includes the uri and csid fields to help facilitate access to individual records: