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.

-

-

- TBD

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 restriction



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

{{[id

#sort_id]}} 
{{[name

#sort_name]}} 
{{[countitems

#sort_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
submitter 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

/collections

| /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

#sort_id]}} 
name
countitems {{[name

#sort_name]}} 
{{[countitems

#sort_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} /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.

json
xml

| Return information about id collection | - | idOnly=false | - | Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem | json
xml | 200, 204, 400, 500 |

GET

| • | GET | /collections/{id}/itemsancestors

Returns Return a list of all items from the collection idancestor communities a collection with id belongs to.

-

idOnly=false
in_archiveimmediateOnly=false true

{{[id

#sort_id]}} 
{{[name

#sort_name]}} 
{{[countitems

#sort_countitems]}}
| Contains item count, identifier, name and handle of collections, or 204 if

lastmodified
submitter Contains full information info including name, submitter, collections related or 204 if there are none of them. In the case Additionaly, when idOnly=true is used, return
only identifiers of results. | json
xml | 200, 204, 400, 500

property

Return entities satisfying requested property relation

|
| | 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 |



h5. Mandatory parameters

|| Parameter || Description || Values || Example ||
|

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

rfield

_start

position of the first entity to return

0 (first)

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 |
|

 •

PUT

/communities/{id}

Change description of id community

name

-

TBD

json 
xml

200, 204, 400, 500

 •

POST

/communities

Add community to the system

name

logo 
parent 
other metadata

TBD

json 
xml

200, 204, 400, 500