Versions Compared

Old Version 64

changes.mady.by.user Bojan Suzic

Saved on

compared with

New Version 65

changes.mady.by.user Bojan Suzic

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

-

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 | • | GET | /collections/{id}/recentancestors | 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 
name 
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}

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

Return a collection logo

-

-

-

Contains collection logo (bitstream)

binary

200, 400

Mandatory parameters

...

Optional parameters

...

Sorting fields:

...

Controlling results

...

all ancestor communities a collection with id belongs to. | -  | idOnly=false
 immediateOnly=true
|

Wiki Markup
\| {{\[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>&nbsp;</code>&nbsp; <br class="atl-forced-newline" />
{{[name|#sort_name]}}<code>&nbsp;</code>&nbsp; <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. | &#45; | <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 | &#45; | &#45; | &#45; | 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. | &#45; | <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>&nbsp;</code> <br class="atl-forced-newline" />
<code><ac:link ac:anchor="sort_name"><ac:link-body>name</ac:link-body></ac:link></code><code>&nbsp;</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 | &#45; | <code>idOnly=false</code> | &#45; | Contains&nbsp;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 | &#45; | &#45; | &#45; | 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" />
&#124;&#124; Parameter &#124;&#124; Description &#124;&#124; Values &#124;&#124; Example &#124;&#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="0a05f4e0-fbf7-4612-b9b4-887462529f7b"><ac:parameter ac:name="">property</ac:parameter></ac:structured-macro>
<br class="atl-forced-newline" />
<code>property</code> &#124; Return entities satisfying requested property relation &#124; 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" />
&#124; <code>property=ds:hasCommunity</code> &#45; return subcommunities of a community
<br class="atl-forced-newline" />
<code>property=ds:isPartOfCommunity</code> &#45; return communities current community is part of (children)
<br class="atl-forced-newline" />
<code>property=ds:hasCollection</code> &#45; return collections belonging to community
<br class="atl-forced-newline" />
<code>property=ds:hasItem</code> &#45; return Items belonging to community &#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="31df06bc-fbe1-4b78-9765-98fac74191c8"><ac:parameter ac:name="">rtype</ac:parameter></ac:structured-macro>
<br class="atl-forced-newline" />
<code>rtype</code> &#124; restriction on type - only entity with specifed type(s) would be returned &#124; <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" />
&#124; <code>rtype=ds:Collection</code> &#45; return entities of Collection type &#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="1e372e7c-5c70-433b-af6f-da8e8e843838"><ac:parameter ac:name="">rfield</ac:parameter></ac:structured-macro>
<br class="atl-forced-newline" />
<code>rfield</code> &#124; restriction on fields - return only selected fields; by default all fields are returned &#124; <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) &#124; <code>rfield=id,name</code> &#45; contain only entity id and name in response &#124;
<br class="atl-forced-newline" />
Note: incomplete/orientative properties, for more info check&nbsp;<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" />
&#124;&#124; Parameter &#124;&#124; Description &#124;&#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="2bc58e7c-d3d4-48ab-9f4c-f6471d7059c8"><ac:parameter ac:name="">toplevelonly</ac:parameter></ac:structured-macro><code>topLevelOnly</code> &#124; returns only top level communities &#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="e191e586-5b15-49f3-b275-a4ce6900cf40"><ac:parameter ac:name="">idonly</ac:parameter></ac:structured-macro><code>idOnly</code> &#124; if true return only the identifiers for the record &#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="24d0fcf5-cef0-4381-8ee4-f3514fa1877e"><ac:parameter ac:name="">immediateonly</ac:parameter></ac:structured-macro><br class="atl-forced-newline" />
<code>immediateOnly</code> &#124; return only direct parent community &#124;
<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" />
&#124;&#124; Parameter &#124;&#124; Description &#124;&#124; Ordering supported &#124;&#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="cc33e717-22a7-45bb-b4ad-1acb7c789d4e"><ac:parameter ac:name="">sort_id</ac:parameter></ac:structured-macro><br/>
<code>id</code>
<br class="atl-forced-newline" />
&#124; sort results by entity id &#124; asc &#124; ascending
<br class="atl-forced-newline" />
desc &#124; descending &#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="a4ef17ad-17dd-479a-a1cf-9246da6cdfb2"><ac:parameter ac:name="">sort_name</ac:parameter></ac:structured-macro><br/>
name &#124; sort results by entity name &#124; asc &#124; ascending
<br class="atl-forced-newline" />
desc &#124; descending
<br class="atl-forced-newline" />
&#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="0f9bec25-c1b4-4e3d-a1fb-44bc882a2e47"><ac:parameter ac:name="">sort_countitems</ac:parameter></ac:structured-macro>countitems &#124; sort results by number of items contained &#124; asc &#124; ascending
<br class="atl-forced-newline" />
desc &#124; descending
<br class="atl-forced-newline" />
&#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="415dcd16-a2c5-4327-b802-63e7aee406ad"><ac:parameter ac:name="">sort_lastmodified</ac:parameter></ac:structured-macro><br class="atl-forced-newline" />
lastmodified &#124; sort results by date of last item modification &#124; asc &#124; ascending&nbsp;
<br class="atl-forced-newline" />
desc &#124; descending
<br class="atl-forced-newline" />
&#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="eb305f44-0097-43c2-a0d8-a056bc9f361c"><ac:parameter ac:name="">sort_submittername</ac:parameter></ac:structured-macro><br class="atl-forced-newline" />
submitterName &#124; sort results by submitter name &#124; asc &#124; ascending&nbsp;
<br class="atl-forced-newline" />
desc &#124; descending
<br class="atl-forced-newline" />
&#124;
<br class="atl-forced-newline" />
&#124; <ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="b6e8fe13-5e05-49ba-9556-4aac665e3ab6"><ac:parameter ac:name="">sort_submitterid</ac:parameter></ac:structured-macro><br class="atl-forced-newline" />
submitterId &#124; sort results by submitter id &#124; asc &#124; ascending&nbsp;
<br class="atl-forced-newline" />
desc &#124; descending
<br class="atl-forced-newline" />
&#124;
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br/>
h5. Controlling&nbsp;results<br class="atl-forced-newline" />
<br/>

<br class="atl-forced-newline" />
&#124;&#124; Parameter &#124;&#124; Description &#124;&#124; Default &#124;&#124; Example &#124;&#124;
<br class="atl-forced-newline" />
&#124; &#95;start &#124; position of the first entity to return &#124; 0 (first) &#124; &#95;start=5 to list 6th item and onwards &#124;
<br class="atl-forced-newline" />
&#124; &#95;page &#124; page of data to display &#124; 0 (first) &#124; &#95;page=2, to display second page with query results &#124;
<br class="atl-forced-newline" />
&#124; &#95;perpage &#124; number of results to show on each page &#124; 0 (all) &#124; &#95;perpage=10 to display 10 results per page &#124;
<br class="atl-forced-newline" />
&#124; &#95;limit &#124; maximum number of entities to return &#124; 0 (all) &#124; &#95;limit=50 &#124;
<br class="atl-forced-newline" />
&#124; &#95;sort &#124; 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&nbsp;determines ordering
<br class="atl-forced-newline" />
suffixes: &#95;asc, &#95;ascending, &#95;desc, &#95;descending &#124; ascending default &#124; &#95;sort=name
<br class="atl-forced-newline" />
&#95;sort=name,email_desc,lastname_desc &#124;
<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" />
&#124;&#124; C &#124;&#124; 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> \

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

...