Versions Compared

Key

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

...

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 -

...

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



...