Versions Compared

Key

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

...

C

Verb

URL

Description

Mandatory parameters

Optional parameters

Sorting fields

Response Data

Formats

Response codes

 

GET

/items/{id}

Return detailed information about an item.

id

-

id
name
lastmodified
submitter

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.

json
xml

200, 204, 400, 500

 

GET

/items/{id}/permissions

Return status of user permissions on this item.

id

-

id
name
lastmodified
submitter

Boolean variable, stating can user edit the listed item .

json
xml

200, 400, 500

 

GET

/items/{id}/communities

Return communities this item is part of.

-

-

id
name
countitems

Communities listed.

json
xml

200, 400, 500

 

GET

/items/{id}/collections

Return collections this item is part of.

-

-

id
name
countitems

Collections listed.

json
xml

200, 400, 500

 

GET

/bitstream/{id}

Returns bitstream object - usually the library item file.

id

-

-

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).

json
xml

200, 400, 401, 403, 404, 500

 

GET

/bitstream/{id}/receive

Returns checksum of bitstream.

id-

-

-

Checksum of bitstream.

json
xml

200, 400, 401, 403, 404, 500


User oriented functions

C

Verb

URL

Description

Mandatory parameters

Optional parameters

Sorting fields

Response Data

Formats

Response codes

 

GET

/users

Return a

Name and description

Value and notes

Base URI:

/users?query=query&idOnly=false

Description:

Returns list containing id, name and email of persons (optionally matching a query)

HTTP method:

GET

Optional parameters:

Sorting fields supported:

id, name, lastname, fullname, language: sorting properties of user(submitter) supported

Response formats:

json, xml

Status codes

200: OK
204: no content
400: bad request
500: internal server error

.

-

query
idOnly=false

id
name
lastname
fullname
language

Response details

List with information on particular user. Additionaly only identifiers are sent if idOnly is true.

json
xml

200, 204, 400, 500


Statistical info


C

Verb

URL

Description

Mandatory parameters

Optional parameters

Sorting fields

Response Data

Formats

Response codes

 

GET

/stats

Return general statistics.

-

-

-

Cummulative

Name and description

Value and notes

Base URI:

/stats

Description:

Returns general statistics

HTTP method:

GET

Response formats:

json, xml

Status codes

200: OK
400: bad request (if there is no stats package available)
500: internal server error

Response details

Returns cummulative list of statistics data for the system currently available.

json
xml

200, 400, 500


Items ingestion



Administrative tasks

...