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

#sort_id]}} 
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8101d4ee-9c8b-4be4-a41c-3c74c9db261b"><ac:plain-text-body><![CDATA[{{[name

#sort_name]}} 
{{[countitems]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="35ca6911-81aa-4542-b2de-1f2d32925a8a"><ac:plain-text-body><![CDATA[{{[countitems

#sort_countitems]}}
]]></ac:plain-text-body></ac:structured-macro>
| 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/#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
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

#sort_id]}} 
{{[name

| - | 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
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0b68acbe-206d-4642-a427-015c81548cdf"><ac:plain-text-body><![CDATA[isAuthorized=false | {{[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="fa7e15fc-dae8-4ec3-b7f1-b1464ecde29b"><ac:plain-text-body><![CDATA[{{[name

#sort_name]}} 
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b7e431d9-3fc0-4d74-9655-063cb2bb7a0e"><ac:plain-text-body><![CDATA[#sort_name]}} 
{{[countitems

#sort_countitems]}}
]]></ac:plain-text-body></ac:structured-macro>
| 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. 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 | - | Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem | json
xml | 200, 204, 400, 500 |
| •
| GET | /collections/{id} | 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 | /collections/{id}/ancestors

Return a list of all ancestor communities a collection with id belongs to.

-

idOnly=false
immediateOnly=true

{{[id

#sort_id]}} 
{{[name

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

Return a list of all ancestor communities a collection with id belongs to.

-

idOnly=false
immediateOnly=true

#sort_id]}} 
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="657a9ecf-2713-4465-b3cf-694e040eed1a"><ac:plain-text-body><![CDATA[{{[name

#sort_name]}} 
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4cdd9155-011a-4d24-9708-96b978ef37af"><ac:plain-text-body><![CDATA[#sort_name]}} 
{{[countitems

#sort_countitems]}}
]]></ac:plain-text-body></ac:structured-macro>
| 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 |
h5.

Mandatory parameters

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

Optional parameters

|| Parameter || Description ||
|

Sorting fields:

|| Parameter || Description || Ordering supported ||
|

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

Repository manipulation

|| C

 •

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