...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Returns a list of all communities on the system or return just top level communities. | - | By default contains item count, identifier, handle and name and other referencing data, or 204 if none. Additionaly, based on parameter | | 200, 400, 500 | ||
• | | | Return information about | - | - | - | Contains information about community, including id, handle, name, collections, ancestors, subcommunities, administrators, metadata | | 200, 204, 400, 500 |
• | | | Return entities according to relation and parameters specified | | | - | Contains entities selected and sorted in conformance to request parameters | | 200, 204, 400, 500 |
• | | | Return a list of all ancestor communities of the | - | | Contains item count, identifiers, handle and name or 204 if id is already top-level. Additionaly, based on parameter idOnly=true the method returns only identifiers. | | 200, 204, 400, 500 | |
• | | | Returns a list of immediate sub-communities (children) of the | - | | Contains item count, identifiers, handle and name or 204 if none. Additionaly, based on parameter | | 200, 204, 400, 500 | |
• | | | Return a list of collections in the | - | | - | Contains item count, identifiers, name, archival status, last modification and handle of collections, or 204 if there are none of them. Additionaly with idOnly=true only identifiers are returned. | | 200, 204, 400, 500 |
• | |
| Return a list of all ancestor communities a collection with | - | | | Contains complete items from recent submissions in community. | | 200, 204, 400, 500 |
• | | | Return a community logo | - | - | - | Contains community logo (bitstream) | | 200, 400 |
| | | Return a list of all collections in the system. | - | | Contains item count, identifiers, name and handle of collections, or 204 if | | 200, 204, 400, 500 | |
• | | | Return information about | - | | - | Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem | | 200, 204, 400, 500 |
• | | | Return a collection logo | - | - | - | Contains collection logo (bitstream) | | 200, 400 |
Mandatory parameters
|| Parameter || Description || Values || Example ||
|
| Anchor | ||||
|---|---|---|---|---|
|
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 | |
| Anchor | ||||
|---|---|---|---|---|
|
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 | |
| Anchor | ||||
|---|---|---|---|---|
|
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 - contain only entity id and name in response | Note: incomplete/orientative properties, for more info check Vocabularies.
Optional parameters
|| Parameter || Description ||
|
| Anchor | ||||
|---|---|---|---|---|
|
topLevelOnly | returns only top level communities | |
| Anchor | ||||
|---|---|---|---|---|
|
idOnly | if true return only the identifiers for the record | |
| Anchor | ||||
|---|---|---|---|---|
|
immediateOnly | return only direct parent community | Sorting fields:
|| Parameter || Description || Ordering supported ||
|
| Anchor | ||||
|---|---|---|---|---|
|
id | sort results by entity id | asc | ascending
desc | descending |
|
| Anchor | ||||
|---|---|---|---|---|
|
name | sort results by entity name | asc | ascending
desc | descending
|
|
| Anchor | ||||
|---|---|---|---|---|
|
desc | descending
|
|
| Anchor | ||||
|---|---|---|---|---|
|
lastmodified | sort results by date of last item modification | asc | ascending
desc | descending
|
|
| Anchor | ||||
|---|---|---|---|---|
|
submitterName | sort results by submitter name | asc | ascending
desc | descending
|
|
| Anchor | ||||
|---|---|---|---|---|
|
submitterId | sort results by submitter id | asc | 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
_sort=name,email_desc,lastname_desc |
Repository manipulation
|| C || Verb || URL || Description || Mandatory parameters || Optional parameters || Response Data || Formats || Response codes Wiki Markup
• | | /communities/{id} | Change description of | name | - | TBD | | 200, 204, 400, 500 |
• | | | Add community to the system | name | | TBD | | 200, 204, 400, 500 |
...