...
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 recent submissions to a community. | - | | 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 list of all ancestor communities a collection with | - | | Contains item count, identifier, name and handle of collections, or 204 if | | 200, 204, 400, 500 | |
• | | | Returns a list of all items from the collection | - | | Contains full information info including name, submitter, collections related or 204 if there are none of them. In the case idOnly=true is used, return only identifiers of results. | | 200, 204, 400, 500 | |
• | | | Return a collection logo | - | - | - | Contains collection logo (bitstream) | | 200, 400 |
Mandatory parameters
...
Parameter |
|---|
...
Description |
|---|
...
Values |
|---|
...
Example | ||||||
|---|---|---|---|---|---|---|
property |
...
Return entities satisfying requested property relation |
...
Structural properties |
...
|
| 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 |
|
...
| 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.
...