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 | id - entity (item) identifier, internal to the system
handle - handle of the item
isArchived - archival status of the item
isWithdrawn - withdrawal status of the item
lastModified - timestamp of last modification
metadata - item metadata
name - item name
submitter - submiter entity
type - entity type (object type in the system, item in this case)
bitstreams - bitstreams related to the item
bundles - bundles related to the item
collections - collections related item appear in
owningCollection - get the owning collection of the item
communities - communities related item appear in
| json
xml | 200, 204, 400, 500 |
| GET | /items/{id}/permissions | Return status of user permissions on this item. | id | - | - | 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 | idOnly=false | id
name
countitems
| countitems - number of items under community
handle - handle of the community (unique persistent resource identifier)
id - entity identifier, internal to the system
name - entity name
type - entity type (object type in the system)
collections - collections contained in the community, ordered by id
ancestors - ancestors of the community, ordered by id
children - subcommunities, ordered by id
admins - group administrators, ordered by id
metadata - community metadata
administrators - default group of administrators
| json
xml | 200, 400, 500 |
| GET | /items/{id}/collections | Return collections this item is part of. | id | idOnly=false | id
name
countitems
| countitems - number of items under collection
items - items present in the collection
id - entity (collection) identifier, internal to the system
handle - handle of the collection
licence - collection licence
name - collection name
type - entity type (object type in the system, item in this case)
communities - communities related collection appear in
submiters - default group of submitters, if there is one
administrators - default group of administrators, if there is one
templateitem - template item for collection, if there is one
| json
xml | 200, 400, 500 |
| GET | /bitstream/{id} | Return bitstream object - usually the library item file. | id | - | - | id - id of bitstream
name - name of the bitstream
bundles - bundles the related bitstream appears in
checksum - checksum of bitstream
checksumAlgorithm - checksum algorithm used
description - bitstream description
formatDescription - format description of bitstream
handle - bitstream handle
mimeType - mime type of bitstream
sequenceId - sequence id
size - bitstream size in bytes
source - bitstream source, local
storeNumber - store number
type - object type
userFormatDescription - description of user format
| json
xml | 200, 400, 401, 403, 404, 500 |
| GET | /bitstream/{id}/receive | Return bitstream | id | - | - | Return bitstream | binary | 200, 400, 401, 403, 404, 500 |