...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
---|---|---|---|---|---|---|---|---|---|
|
|
| Return detailed information about an item. |
| - |
| Contains an information about an item including resource name, metadata, owning collection, collections stored in, communities stored in, bundle ids, last modified date, archival/withdrawn status and submitter of an item. |
| 200, 204, 400, 500 |
|
|
| Return status of user permissions on this item. |
| - |
| Boolean variable, stating can user edit the listed item . |
| 200, 400, 500 |
|
|
| Return communities this item is part of. | - | - |
| Communities listed. |
| 200, 400, 500 |
|
|
| Return collections this item is part of. | - | - |
| Collections listed. |
| 200, 400, 500 |
|
|
| Returns bitstream object - usually the library item file. |
| - | - | Includes all information about referenced bitstream, including file name, licence, corresponding ittem etc. It is possible only to get information for particular bitstreams. When the request is made without parameters/references, the blank list is presented (there is no list of all bitstreams in the system available). |
| 200, 400, 401, 403, 404, 500 |
|
|
| Returns checksum of bitstream. |
| - | - | Checksum of bitstream. |
| 200, 400, 401, 403, 404, 500 |
User oriented functions
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
---|---|---|---|---|---|---|---|---|---|
|
|
| Return a | ||||||
Name and description | Value and notes | ||||||||
Base URI: | /users?query= | ||||||||
Description: | Returns list containing id, name and email of persons (optionally matching a query) | ||||||||
HTTP method: | | ||||||||
Optional parameters: | |||||||||
Sorting fields supported: | | ||||||||
Response formats: | | ||||||||
Status codes | 200: OK | ||||||||
. | - |
|
| Response details | 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 | ||
Name and description | Value and notes | ||||||||
Base URI: | | ||||||||
Description: | Returns general statistics | ||||||||
HTTP method: | | ||||||||
Response formats: | | ||||||||
Status codes | 200: OK | ||||||||
Response details | Returns cummulative list of statistics data for the system currently available. |
| 200, 400, 500 |
Items ingestion
Administrative tasks
...