• | GET | /communities/{id}/collections | Return a list of collections in the id community. | - | idOnly=false | id | #sort_id]}} <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="84996d97-f7b0-4c77-ad4d-43d3de82080f"><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="aa51f4ea-6aba-46e5-8cb0-3aaed5cfee80"><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="88d9d11b-4304-45a9-ad2f-d0ec2ec3b2d6"><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="615e8b0d-a3ca-49b5-9530-fef0d0e0ff96"><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="ea06e821-27be-4940-a9f9-686649f81238"><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
| id | #sort_id]}} <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6cca5a20-77ab-4240-8985-d96012516f12"><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="30f3af54-23a2-490f-8a85-899a1cc2f859"><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 || |
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 | | 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 | | 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. h5.
Optional parameters
|| Parameter || Description || |
topLevelOnly | returns only top level communities | | idOnly | if true return only the identifiers for the record | | Anchor |
---|
| immediateonly |
---|
| immediateonly |
---|
|
immediateOnly | return only direct parent community | h5.
Sorting fields:
|| Parameter || Description || Ordering supported || |
id | sort results by entity id | asc | ascending desc | descending | | name | sort results by entity name | asc | ascending desc | descending | | Anchor |
---|
| sort_countitems |
---|
| sort_countitems |
---|
| countitems | sort results by number of items contained | asc | ascending desc | descending | | Anchor |
---|
| sort_lastmodified |
---|
| sort_lastmodified |
---|
|
lastmodified | sort results by date of last item modification | asc | ascending desc | descending | | Anchor |
---|
| sort_submittername |
---|
| sort_submittername |
---|
|
submitterName | sort results by submitter name | asc | ascending desc | descending | | Anchor |
---|
| sort_submitterid |
---|
| sort_submitterid |
---|
|
submitterId | sort results by submitter id | asc | ascending desc | descending | h5.
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
| Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes |
---|