Acquisition Service REST APIs
- Jessi Weithman
Table of Contents
About CollectionSpace REST-based API
The Acquisition Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual Acquisition instances, plus list operations on multiple Acquisition instances.
These follow the Common Services REST API.
Acquisition CRUD+L services
Create an Acquisition
Creates a new Acquisition record. Assigns a unique, service-specified CollectionSpace ID (CSID) to that Acquisition record. Follows standard Create model. See the documentation of the Acquisition schema, below. Example:
|
Read an Acquisition
Reads an existing Acquisition record, specified by its CollectionSpace ID (CSID). Follows standard Read model. See the documentation of the Acquisition schema, below. Example:
|
Update an Acquisition
Updates an existing Acquisition record, specified by its CollectionSpace ID (CSID). Follows standard Update model. See the documentation of the Acquisition schema, below. Example:
|
Delete an Acquisition
Deletes an existing Acquisition record, specified by its CollectionSpace ID (CSID). Follows standard Delete model. Example:
|
List Acquisition instances
Lists existing Acquisition records, with summary information for each. Follows standard List model. See the documentation of the Acquisition list schema, below. Example:
|
List supports query parameters for customizing list results, such as pagination controls, query filters, and sorting options. For example:
|
List also supports query parameters for searching for matching records, including keyword search. For example:
|
Acquisition REST payload schemas
Acquisition instance schema
This section needs to be brought up to date per current schema documentation practices.
The schemas below are severely abbreviated, and are thus illustrative. For a full list of the fields that may potentially be present in payloads when creating, updating, or reading individual Acquisition records, please see the Acquisition record schema.
Create and Update should use the following schema:
|
Read will return the following schema:
|
Acquisition 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:
|