...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
---|---|---|---|---|---|---|---|---|---|
| | | Returns a list of all communities on the system or return just top level communities. | - | By default contains item count, identifier, handle and name and other referencing data, or 204 if none. Additionaly, based on parameter | | 200, 400, 500 | ||
• | | | Return information about | - | - | - | Contains information about community, including id, handle, name, collections, ancestors, subcommunities, administrators, metadata | | 200, 204, 400, 500 |
• | | | Return entities according to relation and parameters specified | | | - | Contains entities selected and sorted in conformance to request parameters | | 200, 204, 400, 500 |
• | | | Return a list of all ancestor communities of the | - | | 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. | | 200, 204, 400, 500 | |
• | | | Returns a list of immediate sub-communities (children) of the | - | | Contains item count, identifiers, handle and name or 204 if none. Additionaly, based on parameter | | 200, 204, 400, 500 | |
• | | | Return a list of collections in the | - | | - | 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. | | 200, 204, 400, 500 |
• | |
| Return a list of all ancestor communities a collection with | - | | | Contains complete items from recent submissions in community. | | 200, 204, 400, 500 |
• | | | Return a community logo | - | - | - | Contains community logo (bitstream) | | 200, 400 |
| | | Return a list of all collections in the system. | - | | Contains item count, identifiers, name and handle of collections, or 204 if | | 200, 204, 400, 500 | |
• | | | Return information about | - | | - | Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem | | 200, 204, 400, 500 |
• | | | Return a collection logo | - | - | - | Contains collection logo (bitstream) | | 200, 400 |
Mandatory parameters
|| Parameter || Description || Values || Example ||
|
Anchor | ||||
---|---|---|---|---|
|
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
| 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
| 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
| returns only top level communities | |
Anchor | ||||
---|---|---|---|---|
|
idOnly
| if true return only the identifiers for the record | |
Anchor | ||||
---|---|---|---|---|
|
immediateOnly
| return only direct parent community | Sorting fields:
|| Parameter || Description || Ordering supported ||
|
Anchor | ||||
---|---|---|---|---|
|
id
| sort results by entity id | asc | ascending
desc | descending |
|
Anchor | ||||
---|---|---|---|---|
|
name | sort results by entity name | asc | ascending
desc | descending
|
|
Anchor | ||||
---|---|---|---|---|
|
desc | descending
|
|
Anchor | ||||
---|---|---|---|---|
|
lastmodified | sort results by date of last item modification | asc | ascending
desc | descending
|
|
Anchor | ||||
---|---|---|---|---|
|
submitterName | sort results by submitter name | asc | ascending
desc | descending
|
|
Anchor | ||||
---|---|---|---|---|
|
submitterId | sort results by submitter id | asc | ascending
desc | descending
|
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 \| {{\[id\|#sort_id\]}} \\
{{\[name\|#sort_name\]}} \\
{{\[countitems\|#sort_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}} \| 200, 204, 400, 500 \|
\| \| {{GET}} \| {{/collections/\{id\}/items}} \| Returns a list of all items from the collection {{id}}. \| - \| {{idOnly=false}} \\
{{inArchive=false}} \| {{\[id\|#sort_id\]}} \\
{{\[name\|#sort_name\]}} \\
{{\[lastmodified\|#sort_lastmodified\]}} \\
{{\[submitterId\|#sort_submitterid\]}}\\
{{\[submitterName\|#sort_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 \|
<span style="color: #003366">{{[id</span>|#sort_id]}}<code> </code> <br class="atl-forced-newline" />
{{[name|#sort_name]}}<code> </code> <br class="atl-forced-newline" />
{{[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. | <code>json</code> <br class="atl-forced-newline" /> <code>xml</code> | 200, 204, 400, 500 |<br/>
| • | <code>GET</code> | <code>/communities/{id}/recent</code> | Return a list of recent submissions to a community. | - | <code>idOnly=false</code> | <code><ac:link ac:anchor="sort_id"><ac:link-body>id</ac:link-body></ac:link></code> <br class="atl-forced-newline" /> <code><ac:link ac:anchor="sort_name"><ac:link-body>name</ac:link-body></ac:link></code> <br class="atl-forced-newline" /> <ac:link ac:anchor="sort_lastmodified"><ac:link-body>lastmodified </ac:link-body></ac:link> <br class="atl-forced-newline" /> <code><ac:link ac:anchor="sort_submitterid"><ac:link-body>submitterId</ac:link-body></ac:link></code> <br class="atl-forced-newline" />
<code><ac:link ac:anchor="sort_submittername"><ac:link-body>submitterName</ac:link-body></ac:link></code> | Contains complete items from recent submissions in community. <br class="atl-forced-newline" />
Additionaly, contains only identifiers when <code>idOnly=true</code> is used. | <code>json</code> <br class="atl-forced-newline" /> <code>xml</code> | 200, 204, 400, 500 |<br/>
| • | <code>GET</code> | <code>/communities/{id}/logo</code> | Return a community logo | - | - | - | Contains community logo (bitstream) | <code>binary</code> | 200, 400 |<br/>
| | <code>GET</code> | <code>/collections</code> | Return a list of all collections in the system. | - | <code>idOnly=false</code> <br class="atl-forced-newline" />
<code>isAuthorized=false</code> | <code><ac:link ac:anchor="sort_id"><ac:link-body>id</ac:link-body></ac:link></code><code> </code> <br class="atl-forced-newline" />
<code><ac:link ac:anchor="sort_name"><ac:link-body>name</ac:link-body></ac:link></code><code> </code> <br class="atl-forced-newline" />
<code><ac:link ac:anchor="sort_countitems"><ac:link-body>countitems</ac:link-body></ac:link></code> | Contains item count, identifiers, name and handle of collections, or 204 if <br class="atl-forced-newline" />
there are none of them. In the case idOnly=true is used, returns only <br class="atl-forced-newline" />
identifiers of collections. | <code>json</code> <br class="atl-forced-newline" />
<code>xml</code> | 200, 204, 400, 500 |<br/>
| • | <code>GET</code> | <code>/collections/{id</code>} | Return information about <code>id</code> collection | - | <code>idOnly=false</code> | - | Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem | <code>json</code> <br class="atl-forced-newline" /> <code>xml</code> | 200, 204, 400, 500 |<br/>
| • | <code>GET</code> | <code>/collections/{id}/logo</code> | Return a collection logo | - | - | - | Contains collection logo (bitstream) | <code>binary</code> | 200, 400 |<br/>
<br/>
<br/>
h5. Mandatory parameters<br class="atl-forced-newline" />
<br/>
<br class="atl-forced-newline" />
|| Parameter || Description || Values || Example ||
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="a19abeef-05f3-45f2-acca-6d0292903e94"><ac:parameter ac:name="">property</ac:parameter></ac:structured-macro>
<br class="atl-forced-newline" />
<code>property</code> | Return entities satisfying requested property relation | Structural properties
<br class="atl-forced-newline" />
<code>ds:isPartOfSite</code>
<br class="atl-forced-newline" />
<code>ds:isPartOfCommunity</code>
<br class="atl-forced-newline" />
<code>ds:isPartOfCollection</code>
<br class="atl-forced-newline" />
<code>ds:isPartOfItem</code>
<br class="atl-forced-newline" />
<code>ds:isPartOfBundle</code>
<br class="atl-forced-newline" />
<code>ds:hasCommunity</code>
<br class="atl-forced-newline" />
<code>ds:hasCollection</code>
<br class="atl-forced-newline" />
<code>ds:hasItem</code>
<br class="atl-forced-newline" />
<code>ds:hasBundle</code>
<br class="atl-forced-newline" />
<code>ds:hasBitstream</code>
<br class="atl-forced-newline" />
<code>ds:hasBitstreamFormat</code>
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
Communities and collections
<br class="atl-forced-newline" />
<code>ds:logo</code>
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
Bistream format
<br class="atl-forced-newline" />
<code>ds:support</code>
<br class="atl-forced-newline" />
<code>ds:fileExtension</code>
<br class="atl-forced-newline" />
<code>ds:mimeType</code>
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
Bitstream
<br class="atl-forced-newline" />
<code>ds:messageDigest</code>
<br class="atl-forced-newline" />
<code>ds:messageDigestAlgorithm</code>
<br class="atl-forced-newline" />
<code>ds:messageDigestOriginator</code>
<br class="atl-forced-newline" />
<code>ds:size</code>
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
Eperson
<br class="atl-forced-newline" />
<code>ds:language</code>
<br class="atl-forced-newline" />
| <code>property=ds:hasCommunity</code> - return subcommunities of a community
<br class="atl-forced-newline" />
<code>property=ds:isPartOfCommunity</code> - return communities current community is part of (children)
<br class="atl-forced-newline" />
<code>property=ds:hasCollection</code> - return collections belonging to community
<br class="atl-forced-newline" />
<code>property=ds:hasItem</code> - return Items belonging to community |
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="166b0f33-8040-4f60-b13c-9cce95429fd2"><ac:parameter ac:name="">rtype</ac:parameter></ac:structured-macro>
<br class="atl-forced-newline" />
<code>rtype</code> | restriction on type - only entity with specifed type(s) would be returned | <code>ds:Bitstream</code>
<br class="atl-forced-newline" />
<code>ds:Bundle</code>
<br class="atl-forced-newline" />
<code>ds:Collection</code>
<br class="atl-forced-newline" />
<code>ds:Community</code>
<br class="atl-forced-newline" />
<code>ds:EPerson</code>
<br class="atl-forced-newline" />
<code>ds:Group</code>
<br class="atl-forced-newline" />
<code>ds:Item</code>
<br class="atl-forced-newline" />
<code>ds:DSpaceObject</code>
<br class="atl-forced-newline" />
<code>ds:Policy</code>
<br class="atl-forced-newline" />
<code>ds:Site</code>
<br class="atl-forced-newline" />
<code>ds:BitstreamFormat</code>
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
| <code>rtype=ds:Collection</code> - return entities of Collection type |
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="56bf6ee7-587b-4f3c-a756-134fa1569995"><ac:parameter ac:name="">rfield</ac:parameter></ac:structured-macro>
<br class="atl-forced-newline" />
<code>rfield</code> | restriction on fields - return only selected fields; by default all fields are returned | <code>id</code>
<br class="atl-forced-newline" />
<code>name</code>
<br class="atl-forced-newline" />
<code>countitems</code>
<br class="atl-forced-newline" />
<code>metadata</code>
<br class="atl-forced-newline" />
<code>subcommunities</code>
<br class="atl-forced-newline" />
<code>ancestors</code>
<br class="atl-forced-newline" />
<code>owner</code>
<br class="atl-forced-newline" />
other (depending on object type, will be documented later) | <code>rfield=id,name</code> - contain only entity id and name in response |
<br class="atl-forced-newline" />
Note: incomplete/orientative properties, for more info check <a href="http://code.google.com/p/dspace-sandbox/source/browse/#svn/modules/dspace-rdf/tags/dspace-rdf-1.5.1/src/main/java/org/dspace/adapters/rdf/vocabularies">Vocabularies</a>.
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br/>
h5. Optional parameters<br class="atl-forced-newline" />
<br/>
<br class="atl-forced-newline" />
|| Parameter || Description ||
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="710526a0-0db3-4682-a8c3-bc2b6df55c62"><ac:parameter ac:name="">toplevelonly</ac:parameter></ac:structured-macro><code>topLevelOnly</code> | returns only top level communities |
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="28f4fa0c-45e1-4eed-ac6c-b40a0f868a64"><ac:parameter ac:name="">idonly</ac:parameter></ac:structured-macro><code>idOnly</code> | if true return only the identifiers for the record |
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="fb0127b7-ec86-4da4-9736-a5f2ed0fdc04"><ac:parameter ac:name="">immediateonly</ac:parameter></ac:structured-macro><br class="atl-forced-newline" />
<code>immediateOnly</code> | return only direct parent community |
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br/>
h5. Sorting fields:<br class="atl-forced-newline" />
<br/>
<br class="atl-forced-newline" />
|| Parameter || Description || Ordering supported ||
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="e4ade4be-a2e3-472b-8a5d-2c47b15751ae"><ac:parameter ac:name="">sort_id</ac:parameter></ac:structured-macro><br/>
<code>id</code>
<br class="atl-forced-newline" />
| sort results by entity id | asc | ascending
<br class="atl-forced-newline" />
desc | descending |
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="9e11ba90-0e13-4990-b694-719a7204ddd1"><ac:parameter ac:name="">sort_name</ac:parameter></ac:structured-macro><br/>
name | sort results by entity name | asc | ascending
<br class="atl-forced-newline" />
desc | descending
<br class="atl-forced-newline" />
|
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="bbb7196a-14a4-4d34-9e36-fc80a7829ec0"><ac:parameter ac:name="">sort_countitems</ac:parameter></ac:structured-macro>countitems | sort results by number of items contained | asc | ascending
<br class="atl-forced-newline" />
desc | descending
<br class="atl-forced-newline" />
|
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="0a149fb3-f4f8-4167-a0bf-59f3a451c04c"><ac:parameter ac:name="">sort_lastmodified</ac:parameter></ac:structured-macro><br class="atl-forced-newline" />
lastmodified | sort results by date of last item modification | asc | ascending
<br class="atl-forced-newline" />
desc | descending
<br class="atl-forced-newline" />
|
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="15cb64de-3059-4b3e-ab04-51fa539e6c81"><ac:parameter ac:name="">sort_submittername</ac:parameter></ac:structured-macro><br class="atl-forced-newline" />
submitterName | sort results by submitter name | asc | ascending
<br class="atl-forced-newline" />
desc | descending
<br class="atl-forced-newline" />
|
<br class="atl-forced-newline" />
| <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="e95fdeb8-c2bd-4827-9a76-23ad8ea0a3b6"><ac:parameter ac:name="">sort_submitterid</ac:parameter></ac:structured-macro><br class="atl-forced-newline" />
submitterId | sort results by submitter id | asc | ascending
<br class="atl-forced-newline" />
desc | descending
<br class="atl-forced-newline" />
|
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br/>
h5. Controlling results<br class="atl-forced-newline" />
<br/>
<br class="atl-forced-newline" />
|| Parameter || Description || Default || Example ||
<br class="atl-forced-newline" />
| _start | position of the first entity to return | 0 (first) | _start=5 to list 6th item and onwards |
<br class="atl-forced-newline" />
| _page | page of data to display | 0 (first) | _page=2, to display second page with query results |
<br class="atl-forced-newline" />
| _perpage | number of results to show on each page | 0 (all) | _perpage=10 to display 10 results per page |
<br class="atl-forced-newline" />
| _limit | maximum number of entities to return | 0 (all) | _limit=50 |
<br class="atl-forced-newline" />
| _sort | the sort order to return entities in
<br class="atl-forced-newline" />
should be comma separated list of field names
<br class="atl-forced-newline" />
suffix determines ordering
<br class="atl-forced-newline" />
suffixes: _asc, _ascending, _desc, _descending | ascending default | _sort=name
<br class="atl-forced-newline" />
_sort=name,email_desc,lastname_desc |
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br/>
h4. Repository manipulation<br class="atl-forced-newline" />
<br/>
<br class="atl-forced-newline" />
|| C || Verb \|\| <span style="color: #003366">URL</span> \|\| <span style="color: #003366">Description</span> \|\| <span style="color: #003366">Mandatory parameters</span> \|\| <span style="color: #003366">Optional parameters</span> \|\| <span style="color: #003366">Response Data</span> \|\| <span style="color: #003366">Formats</span> \|\| <span style="color: #003366">Response codes</span> \ | Wiki Markup
• | | /communities/{id} | Change description of | name | - | TBD | | 200, 204, 400, 500 |
• | | | Add community to the system | name | | TBD | | 200, 204, 400, 500 |
...