Page History
Table of Contents |
---|
Defined end point
URI Structure
Code Block |
---|
http://host:port/api/<api-name>/resource-name |
Currently there a only one API name available, which will be discussed further below:
- core - for minimal core functionalities on the data model guarantee by DSpace
It is expected to add more api names to group together specific functionalities (auth, "external plugin", ...)
The above endpoint typically refers to collection resources. Access to a specific item inside the collection is done
Code Block |
---|
http://host:port/api/<api-name>/resource-name/{id}
or
http://host:port/api/<api-name>/resource-name/{uuid} |
Methods
Item resources generally support HEAD, GET , PUT , PATCH and DELETE
GET
Returns a single entity.
HEAD
Returns whether the item resource is available
PUT
Replaces the state of the target resource with the supplied request body.
PATCH
Similar to PUT but partially updating the resources state.
DELETE
Deletes the resource exposed.
Collection resources generally support GET, POST
GET
Returns all entities in the collection we include the pagination links if necessary and additional page metadata.
Parameters
page - the page number to access (0 indexed, defaults to 0).
size - the page size requested (defaults to 20).
sort - a collection of sort directives in the format ($sortcriteria,)[+|-] ?.
Custom status codes
405 Method Not Allowed - for resources like bitstream, bundle, etc.
POST
Creates a new entity from the given request body.
Custom status codes
405 Method Not Allowed - if we define "read-only" collection as maybe i18n, configuration, etc.
/api/collection
Status | ||||||
---|---|---|---|---|---|---|
|
This endpoint is the entry point for all the actions on both Community and Collection.
/api/item
Status | ||||||
---|---|---|---|---|---|---|
|
...