| Div | ||
|---|---|---|
| ||
| Intake Service Home |
Brief Description
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Assumptions
For a complete list of assumptions, visit the Service Description and Assumptions page.
References
Object Entry Requirements
Intake Stories
Intake Service Description and Assumptions
Intake Service Entity Diagrams
Intake Schema
REST-based API
...
Creates a new Intake record. Assigns a unique, service-specified CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321 to that Intake record. Follows standard Create model. See the documentation of the Intake schema, below. Example:
...
Reads an existing Intake record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Read model. See the documentation of the Intake schema, below. Example:
...
Updates an existing Intake record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Update model. See the documentation of the Intake schema, below. Example:
...
Deletes an existing Intake record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:
...
Lists existing Intake records, with summary information for each. Follows standard List model. See the documentation of the Intake list schema, below. Example:
| Code Block |
|---|
GET /cspace-services/intakes 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/intakes?pgSz=10 HTTP/1.1 |
| Note |
List also supports query parameters for searching for matching records, including keyword search. For example:
| Code Block |
|---|
GET /cspace-services/intakes?kw=foo&pgSz=10 HTTP/1.1
|
Intake REST payload schemas
...