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 model for CollectionSpace REST services.
Acquisition CRUD+L services
...
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:
| Code Block |
|---|
POST /cspace-services/acquisitions HTTP/1.1
|
...
Reads an existing Acquisition record, specified by its CollectionSpace ID (CSID). Follows standard Read model. See the documentation of the Acquisition schema, below. Example:
| Code Block |
|---|
GET /cspace-services/acquisitions/{id} HTTP/1.1
|
...
Updates an existing Acquisition record, specified by its CollectionSpace ID (CSID). Follows standard Update model. See the documentation of the Acquisition schema, below. Example:
| Code Block |
|---|
PUT /cspace-services/acquisitions/{id} HTTP/1.1
|
...
Deletes an existing Acquisition record, specified by its CollectionSpace ID (CSID). Follows standard Delete model. Example:
| Code Block |
|---|
DELETE /cspace-services/acquisitions/{id} HTTP/1.1
|
...
Lists existing Acquisition records, with summary information for each. Follows standard List model. See the documentation of the Acquisition list schema, below. Example:
| Code Block |
|---|
GET /cspace-services/acquisitions HTTP/1.1
|
List supports query parameters for customizing list results, such as pagination controls, query filters, and sorting options. For example:
| Code Block |
|---|
GET /cspace-services/acquisitions?pgSz=10 HTTP/1.1
|
List also supports query parameters for searching for matching records, including keyword search. For example:
| Code Block |
|---|
GET /cspace-services/acquisitions?kw=foo&pgSz=10 HTTP/1.1
|
...
| Info |
|---|
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 for release 0.5. |
Create and Update should use the following schema:
...