...
Name and description | Value and notes |
---|---|
Base URI: | /collections/ |
Description: | Returns a list of all items from the collection |
HTTP method: | |
Optional parameters: | idOnly=false: if true, return only identifiers of result records |
Sorting fields supported: | |
Response formats: | |
Status codes | 200: OK |
Response details | Contains full information info including name, submitter, collections related |
Name and description | Value and notes |
---|---|
Base URI: | /search?query= |
Description: | Returns a list of all objects found by searching criteria |
HTTP method: | |
Optional parameters: | |
Sorting fields supported: | |
Sorting/ordering modifiers: | |
Response formats: | |
Status codes | 200: OK |
Response details | Item info with basic metadata for the search results. Additionally return only |
Name and description | Value and notes |
---|---|
Base URI: | /harvest?startdate= |
Description: | Returns a list of all objects that have been created, modified or withdrawn within specified time range |
HTTP method: | |
Optional parameters: | |
Sorting/ordering modifiers: | |
Response formats: | |
Status codes | 200: OK |
Response details | Contains item info including id, name, handle, metadata, bitstreams according to |
Item status and retrieval
Name and description | Value and notes |
---|---|
Base URI: | |
Description: | Returns detailed information about an item |
HTTP method: | |
Required parameters: | { |
Sorting fields supported: | |
Response formats: | |
Status codes | 200: OK |
Response details | 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 |
Name and description | Value and notes |
---|---|
Base URI: | |
Description: | Returns status of user permissions on this item |
HTTP method: | |
Required parameters: | { |
Response formats: | |
Status codes | 200: OK |
Response details | Boolean variable, stating can user edit the listed item |
Name and description | Value and notes |
---|---|
Base URI: | /items/ |
Description: | Returns communities this item is part of |
HTTP method: | |
Required parameters: | |
Sorting fields supported: | |
Response formats: | |
Status codes | 200: OK |
Response details | Communities listed |
Name and description | Value and notes |
---|---|
Base URI: | /items/ |
Description: | Returns collections this item is part of |
HTTP method: | |
Required parameters: | |
Sorting fields supported: | |
Response formats: | |
Status codes | 200: OK |
Response details | Collections listed |
Name and description | Value and notes |
---|---|
Base URI: | |
Description: | Returns bitstream object - usually the library item file |
HTTP method: | |
Required parameters: | { |
Response formats: | |
Status codes | 200: OK |
Response details | 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). |
Name and description | Value and notes |
---|---|
Base URI: | |
Description: | Returns checksum of bitstream |
HTTP method: | |
Required parameters: | { |
Response formats: | |
Status codes | 200: OK |
Response details | Receive full bitstream |