Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

General rules

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

...

Custom status codes
405 Method Not Allowed - if we define "read-only" collection as maybe i18n, configuration, etc.

Defined end points

/api/collection 
Status
subtletrue
colourYellow
titlework in progress

This endpoint is the entry point for all the actions on both Community and Collection.

 

/api/item 
Status
subtletrue
colourYellow
titlework in progress

...