Page History

...

{{\[id

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

Wiki Markup

#sort_id]}}
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5929cfce-e8f0-4f56-8a3a-350ea00c0bea"><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="40f1bb22-6465-4495-a463-156dd5a85685"><ac:plain-text-body><![CDATA[
name
{{[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/{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
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="13853703b6929178-9778416f-46d14b7c-be9cbf30-001c2ba28f6fb466ac18fb85"><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="983d064a0d6928c1-86dd5757-44b640eb-956081e0-5c19705caf12dd4b77c49db4"><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="f83db12f45160863-c72a143e-43fe42cb-bd6cbcb0-c33637da2c1e5759fb467b22"><ac:plain-text-body><![CDATA[{{[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. | 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

Wiki Markup
{{\[

id

#sort_id]}}
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4b8753809684f6db-94f6fc52-46f1468a-ac38ab1d-bb070da35382c9c13ee139c6"><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="383724eb034e16a6-ad4138e8-44994eee-a2e18e1c-e42f5bfbb1c3fc57004d4c3c"><ac:plain-text-body><![CDATA[{{[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 |

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 - contain only entity id and name in response |
Note: incomplete/orientative properties, for more info check Vocabularies.

Optional parameters

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

Sorting fields:

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

Anchor

	sort_id
	sort_id

Anchor

	sort_name
	sort_name

Anchor

	sort_countitems
	sort_countitems

Anchor

	sort_lastmodified
	sort_lastmodified

Anchor

	sort_submittername
	sort_submittername

Anchor

	sort_submitterid
	sort_submitterid

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 |

Repository manipulation

|| C

Verb

URL

Description

Mandatory parameters

Optional parameters

Response Data

Formats

Response codes

•

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

...

Page tree

Versions Compared

Old Version 52

New Version 53

Key

Mandatory parameters

Optional parameters

Sorting fields:

Controlling results

Repository manipulation