...
Parameter | Description | Values | Example |
|---|
property | Return entities satisfying requested property relation | Structural properties
ds:isPartOfSite
ds:isPartOfCommunity
ds:isPartOfCollection
ds:isPartOfItem
ds:isPartOfBundle
ds:hasCommunity
ds:hasCollection
ds:hasItem
ds:hasBundle
ds:hasBitstream
ds:hasBitstreamFormat
Communities and collections
ds:logo
Bistream format
ds:support
ds:fileExtension
ds:mimeType
Bitstream
ds:messageDigest
ds:messageDigestAlgorithm
ds:messageDigestOriginator
ds:size
Eperson
ds:language
| property=ds:hasCommunity - return subcommunities of a community
property=ds:isPartOfCommunity - return communities current community is part of (children)
property=ds:hasCollection - return collections belonging to community
property=ds:hasItem - return Items belonging to community |
rtype | restriction on type - only entity with specifed type(s) would be returned | ds:Bitstream
ds:Bundle
ds:Collection
ds:Community
ds:EPerson
ds:Group
ds:Item
ds:DSpaceObject
ds:Policy
ds:Site
ds:BitstreamFormat| | rtype=ds:Collection - return entities of Collection type |
rfield | restriction on fields - return only selected fields; by default all fields are returned | id
name
countitems
metadata
subcommunities
ancestors
owner
other (depending on object type, will be documented later) | rfield=id,name - return only entity id and name in response |
...
Parameter | Description | Ordering supported |
|---|
id | sort results by entity id | asc | ascending
desc | descending | |
name | sort results by entity name | asc | ascending
desc | descending
|
| Anchor |
|---|
| sort_countitems |
|---|
| sort_countitems |
|---|
|
countitems | sort results by number of items contained | asc | ascending ascending
desc | descending
|
| Anchor |
|---|
| sort_lastmodified |
|---|
| sort_lastmodified |
|---|
|
lastmodified | sort results by date of last item modification | asc | ascending
desc | descending
|
| Anchor |
|---|
| sort_submittername |
|---|
| sort_submittername |
|---|
|
submitterName | sort results by submitter name | asc | ascending ascending
desc | descending
|
| Anchor |
|---|
| sort_submitterid |
|---|
| sort_submitterid |
|---|
|
submitterId | sort results by submitter id | asc | ascending ascending
desc | descending
|
Controlling results
Parameter | Description | Default | Example |
|---|
_start | position of the first entity to return | 0 (first) | _start=5 to list 6th item and onwards |
_page | page of data to display | 0 (first) | _page=2, to display second page with query results |
_perpage | number of results to show on each page | 0 (all) | _perpage=10 to display 10 results per page |
_limit | maximum number of entities to return | 0 (all) | _limit=50 |
_sort | | the sort order to return entities in
should be comma separated list of field names
suffix determines ordering
suffixes: _asc, _ascending, _desc, _descending
ascending default | sort=name name
_sort=name,email_desc,lastname_desc
|
Response codes
Code | Description |
|---|
200 | OK |
201 | Created |
204 | No content |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method not allowed |
500 | Internal server error |
503 | Service unavailable |
Repository manipulation
|| C ||
Verb || URL || Description || Mandatory parameters || Optional parameters || Response Data || Formats || Response codes |
...