...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Return a list of all objects found by searching criteria. | - | TBD modifiers{{query= | | Item info with basic metadata for the search results. Additionally return only | | 200, 204, 400, 500 |
| | | Return a list of all objects that have been created, modified or withdrawn within specified time range. | - | | - | Contains item info including id, name, handle, metadata, bitstreams according to | | 200, 204, 400, 500 |
Item manipulation
| Info | ||
|---|---|---|
| ||
To be rewritten and moved to repository manipulation |
...
C
...
Verb
...
URL
...
Description
...
Mandatory parameters
...
Optional parameters
...
Response Data
...
Formats
...
Response codes
...
•
...
POST
...
/items/{id}/action
...
Change parameters of item id
...
id
...
createBundle
createSingleBitstream
removeLicenses
removeDspaceLicense
licenseGranted
...
Response code
...
json
xml
...
200, 400, 401, 403, 500
...
...
PUT
...
/items/{id}
...
Change parameters of an item id
...
-
...
isArchived
isWithdrawn
owningCollection
submitter
owningCollection
...
...
...
...
...
PUT
...
/items/{id}/bundles/
...
Add an existing bundle bid to item id
...
id
bid
...
...
...
...
...
...
DELETE
...
/items/{id}/bundles/
...
Remove bundle bid from item id
...
id
bid
...
...
...
...
...
...
...
...
Set archival status of an item
...
id
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
PUT
...
/items/{id}/metadata
...
Add a single metadata field
...
...
...
...
...
...
DELETE
...
/items/{id}metadata
...
Remove a single metadata field
...
schema
element
qualifier
lang
...
...
...
...
...
...
DELETE
...
/items/{id}/metadata
...
...
...
...
...
...
...
•
...
POST
...
/communities
...
Add community to the system
...
name
...
logo
parent
other metadata
...
Id of newly created community
...
json
xml
...
200, 400, 401, 403, 500
...
•
...
DELETE
...
/communities/{id}{}
...
Delete community from the system
...
id
...
-
...
Response code
...
json
xml
...
200, 400, 401, 403, 500
...
•
...
PUT
...
/collections/{id}{}
...
Change description of id collection
...
id
...
...
Response code
...
json
xml
...
200, 400, 401, 403, 500
...
•
...
POST
...
/collections
...
Add collection to the system
...
name
communityId
...
...
Id of newly created collection
...
json
xml
...
200, 400, 401, 403, 500
...
•
...
DELETE
...
/collections/{id}{}
...
Delete collection from the system
...
-
...
-
...
Response code
...
json
xml
...
User oriented functions
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Return a list containing id, name and email of persons. | - | | | List with information on particular user. Additionaly only identifiers are sent if idOnly is true. | | 200, 204, 400, 500 |
Statistical info
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Return general statistics. | - | - | - | Cummulative list of statistics data for the system currently available. | | 200, 400, 500 |
...