Versions Compared

Old Version 53

changes.mady.by.user Bojan Suzic

Saved on

compared with

New Version 54

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

{{[id

#sort_id]}}
name
{{[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. | 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="01bb5e443061c9ef-8e7207b9-43ad4fd4-98e69e2f-e8177b4118526eca275ebfca"><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="936520713106a7ae-fc2eed80-4c984cdb-8eb5962c-ade61c266800abfaca9565b6"><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="dbd5aa186bcb5cb9-7f80489b-4c2341f3-87378afc-e34208aa682e2d76c83d8365"><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="97c43e0d488e9975-ef51cd26-43cf4671-ad00a597-4a5d2b541852dafe467b6bc3"><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="61479ba4f167dde3-0764f0e1-468d4579-837690a6-69a447fd79883b1f8b98414f"><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

id
| sort results by entity id | asc | ascending
desc | descending |
|
Anchor
sort_name
sort_name

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
|



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

...