This is the list of methods/endpoints implemented in earlier development stage.
Name and description |
Value and notes |
---|---|
Base URI: |
|
Description: |
Returns a list of all communities on the system or return just top level communities. |
HTTP method: |
|
Optional parameters: |
|
Sorting fields supported: |
|
Response formats: |
|
Status codes |
200: OK |
Response details |
By default contains item count, identifier, handle and name and other |
Name and description |
Value and notes |
---|---|
Base URI: |
/communities/{id}/parents?idOnly=false&immediateOnly=true |
Description: |
Returns a list of all parent communities of the |
HTTP method: |
|
Optional parameters: |
idOnly=false: if true return only the identifiers for the record, by default |
Sorting fields supported: |
|
Response formats: |
|
Status codes |
200: OK |
Response details |
Contains item count, identifiers, handle and name or 204 if id is already |
Name and description |
Value and notes |
---|---|
Base URI: |
/communities/ |
Description: |
Returns a list of immediate sub-communities (children) of the |
HTTP method: |
|
Optional parameters: |
idOnly=false: if true return only the identifiers for the record, by default |
Sorting fields supported: |
|
Response formats: |
|
Status codes |
200: OK |
Response details |
Contains item count, identifiers, handle and name or 204 if none. |
Name and description |
Value and notes |
---|---|
Base URI: |
/communities/ |
Description: |
Returns a list of collections in the |
HTTP method: |
|
Optional parameters: |
idOnly=false: if true return only the identifiers for the record, by default |
Sorting fields supported: |
|
Response formats: |
|
Status codes |
200: OK |
Response details |
Contains item count, identifiers, name, archival status, last modification and |
Name and description |
Value and notes |
---|---|
Base URI: |
/communities/ |
Description: |
Returns a list of recent submissions to a community |
HTTP method: |
|
Optional parameters: |
idOnly=false: if true return only the identifiers for the record, by default |
Sorting fields supported: |
|
Response formats: |
|
Status codes |
200: OK |
Response details |
Contains complete items from recent submissions in community. |
Name and description |
Value and notes |
---|---|
Base URI: |
/collections?idOnly=false |
Description: |
Returns a list of all collections in the system |
HTTP method: |
|
Optional parameters: |
idOnly=false: if true return only the identifiers for the record, by |
Sorting fields supported: |
|
Response formats: |
|
Status codes |
200: OK |
Response details |
Contains item count, identifiers, name and handle of collections, or 204 if |
Name and description |
Value and notes |
---|---|
Base URI: |
/collections/ |
Description: |
Returns a list of all communities a collection with |
HTTP method: |
|
Optional parameters: |
idOnly=false: if true return only the identifiers for the record, by |
Sorting fields supported: |
|
Response formats: |
|
Status codes |
200: OK |
Response details |
Contains item count, identifier, name and handle of collections, or 204 if |
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 |
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 |
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. |
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 |