Page History

...

C	Verb	URL	Description	Mandatory parameters	Optional parameters	Sorting fields	Response Data	Formats	Response codes
	`GET`	`/communities`	Returns a list of all communities on the system or return just top level communities.	-	`topLevelOnly=true` `idOnly=false`	`id` name `countitems`	By default contains item count, identifier, handle and name and other referencing data, or 204 if none. Additionaly, based on parameter `idOnly=true` the method returns only identifiers.	`json` `xml`	200, 400, 500
•	`GET`	`/communities/{id`}	Return information about `id` community.	-	-	-	Contains information about community, including id, handle, name, collections, ancestors, subcommunities, administrators, metadata	`json` `xml`	200, 204, 400, 500
•	`GET`	`/communities/{id}/relations`	Return entities according to relation and parameters specified	`property`	`rtype` `rfield`	-	Contains entities selected and sorted in conformance to request parameters	`json` `xml`	200, 204, 400, 500
•	`GET`	`/communities/{id}/ancestors`	Return a list of all ancestor communities of the `id` community.	-	`idOnly=false` `immediateOnly=true`	`id` `name` `countitems`	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.	`json` `xml`	200, 204, 400, 500
•	`GET`	`/communities/{id}/children`	Returns a list of immediate sub-communities (children) of the `id` community.	-	`idOnly=false`	`id` `name` `countitems`	Contains item count, identifiers, handle and name or 204 if none. Additionaly, based on parameter `idOnly=true` the method returns only identifiers.	`json` `xml`	200, 204, 400, 500
•	`GET`	`/communities/{id}/collections`	Return a list of collections in the `id` community.	-	`idOnly=false`	id `name` `countitems`	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.	`json` `xml`	200, 204, 400, 500
•	`GET`	`/communities/{id}/recent`	Return a list of recent submissions to a community.	-	`idOnly=false`	`id` `name` `lastmodified` `submitterId` `submitterName`	Contains complete items from recent submissions in community. Additionaly, contains only identifiers when `idOnly=true` is used.	`json` `xml`	200, 204, 400, 500
•	`GET`	`/communities/{id}/logo`	Return a community logo	-	-	-	Contains community logo (bitstream)	`binary`	200, 400
•	`GET`	`/collections`	Return a list of all collections in the system.	-	`idOnly=false` `isAuthorized=false`	`id` `name` `countitems`	Contains item count, identifiers, name and handle of collections, or 204 if there are none of them. In the case idOnly=true is used, returns only identifiers of collections.	`json` `xml`	200, 204, 400, 500
•	`GET`	`/collections/{id`}	Return information about `id` collection	-	`idOnly=false`	`id` `name` `countitems`	Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem	`json` `xml`	200, 204, 400, 500
•	`GET`	`/collections/{id}/ancestors`	Return a list of all ancestor communities a collection with `id` belongs to.	-	`idOnly=false` `immediateOnly=true`	`id` `name` `countitems`	Contains item count, identifier, name and handle of collections, or 204 if there are none of them. Additionaly, when idOnly=true is used, return only identifiers. Contains item count, identifier, name and handle of collections, or 204 if there are none of them. Additionaly, when idOnly=true is used, return only identifiers.	`json` `xml`	200, 204, 400, 500
•	`GET`	`/collections/{id}/items`	Returns a list of all items from the collection `id`.	-	`idOnly=false` `inArchive=false`	`id` `name` `lastmodified` `submitterId` `submitterName`	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.	`json` `xml`	200, 204, 400, 500
•	`GET`	`/collections/{id}/logo`	Return a collection logo	-	-	-	Contains collection logo (bitstream)	`binary`	200, 400

Mandatory parameters

Parameter

Description

Values

Example

Anchor

	property
	property

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
	rtype

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
	rfield

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

Anchor

	toplevelonly
	toplevelonly

topLevelOnly

returns only top level communities

Anchor

	idonly
	idonly

idOnly

if true return only the identifiers for the record

Anchor

	immediateonly
	immediateonly

immediateOnly

return only direct parent community

Anchor

	isauthorized
	isauthorized

isAuthorized

return only collections user has permission to work on

Anchor

	inarchive
	inarchive

inArchive

return archived items for respective collection

Sorting fields:

Parameter

Description

Ordering supported

Anchor

	sort_id
	sort_id

id

sort results by entity id

asc | ascending
desc | descending |

Anchor

	sort_name
	sort_name

name

sort results by entity name