Page History

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
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="174ed747-d8eb-4115-aa53-68270af30902"><ac:plain-text-body><![CDATA[ immediateOnly=true
[id|#sort_id]
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="33dd5bbc-a4d9-49a9-a1df-6ae9ccefd5d6"><ac:plain-text-body><![CDATA[ [name|#sort_name]
]]></ac:plain-text-body></ac:structured-macro>
<ac:=true

id\
name
countitems structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3e3b59fe-bdc8-461f-b6a0-a2640bcb832e"><ac:plain-text-body><![CDATA[ [countitems|#sort_countitems]

Contains item count, identifier, name and handle of collections, or 204 if
]]></ac:plain-text-body></ac:structured-macro>
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}/logo

Return a collection logo

-

-

-

Contains collection logo (bitstream)

binary

200, 400