| Div | ||
|---|---|---|
| ||
| Acquisition Service Home |
Brief Description
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Assumptions
For a complete list of assumptions, visit the Service Description and Assumptions page.
References
Object Entry Requirements
Acquisition Stories
Acquisition Service Description and Assumptions
Acquisition Service Entity Diagrams
Acquisition Schema
REST-based API
...
Creates a new Acquisition record. Assigns a unique, service-specified CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321 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) /wiki/spaces/collectionspace/pages/666274321. 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) /wiki/spaces/collectionspace/pages/666274321. 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) /wiki/spaces/collectionspace/pages/666274321. 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 |
| Note |
| The Acquisition service does not currently support pagination; restore wording from version 5 of this document when that support is added. |
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
|
Acquisition REST payload schemas
Acquisition instance schema
| Note |
|---|
This section needs to be brought up to date per current schema documentation practices. |
| 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. |
...