Page History

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.
Order of communities is ???

json
xml

200, 400, 500

GET

/communities/{id}

Return information about id community.

-

-

-

TBD

json
xml

200, 204, 400, 500

•

PUT GET

/communities/{id}/ancestors

Return a list of all ancestor communities of the Change description of id community.

name -

-

-

TBD

json
xml

200, 204, 500, 501

•

POST

/communities

Add community to the system

name

logo
parent
other metadata

-

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. TBD

json
xml

200, 201204, 204400, 500 , 501

  •

GET

/communities/{id}/ancestorschildren

Return Returns a list of all ancestor communities immediate sub-communities (children) of the id community.

-

idOnly=false immediateOnly=true

id id
name
countitems

Contains item count, identifiers, handle and name or 204 if id is already top-levelnone. Additionaly, based on parameter idOnly=true the method returns only identifiers.
Order of ancestors is ??? immediate first or most distant first?

json
xml

200, 204, 400, 500

  •

GET

/communities/{id}/childrencollections

Returns Return a list of immediate sub-communities (children) of collections in the id community.

-

idOnly=false

id
name
countitems

Contains item count, identifiers, name, archival status, handle and name last modification and handle of collections, or 204 if there are none of them. Additionaly , based on parameter with idOnly=true the method returns only identifiers .
Order of children is ???are returned.

json
xml

200, 204, 400, 500

  •

GET

/communities/{id}/collectionsrecent

Return a list of collections in the id recent submissions to a community.

-

idOnly=false

id
name
lastmodified
countitems submitter

Contains complete items from recent submissions in community.
Additionaly, contains only identifiers when idOnly=true is used.

json
xml

200, 204, 400, 500

GET

/collections

Return a list of all collections in the system.

-

idOnly=false

id
name
countitems

Contains item count, identifiers, name item count, identifiers, name, archival status, last modification and handle of collections, or 204 if
there are none of them. Additionaly with In the case idOnly=true is used, returns only
identifiers are returnedof collections.

json
xml

200, 204, 400, 500

  •

GET

/communitiescollections/{id}/recentancestors

Return a list of recent submissions to a communityall ancestor communities a collection with id belongs to.

-

idOnly=false
immediateOnly=true

id
name
lastmodified
submitter countitems

Contains item count, identifier, name and handle of collections, or 204 if
there are none of them. Additionaly, Contains complete items from recent submissions in community.
Additionaly, contains only identifiers when idOnly=true is used. , return
only identifiers.

json
xml

200, 204, 400, 500

GET

/collections/{id}/items

Returns Return a list of all collections in the systemitems from the collection id.

-

idOnly=false
in_archive=false

id
name
lastmodified
countitems submitter

Contains item count, identifiers, name and handle of collections, full information info including name, submitter, collections related or 204 if
there are none of them. In the case idOnly=true is used, returns return only
identifiers of collectionsresults.

json
xml

200, 204, 400, 500

returns only top level communities

if true return only the identifiers for the record

sort results by entity id

sort results by entity name

 •

PUT

/communities/{id}

Change description of id community

name

-

TBD

json 

GET

/collections/{id}/ancestors

Return a list of all ancestor communities a collection with id belongs to.

-

idOnly=false
immediateOnly=true

id
name
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
in_archive=false

id
name
lastmodified
submitter

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

 •

POST

returns only top level communities

/communities

Add community to the system

name

logo 
parent 
other metadata

TBD

json 
xml

200, 204, 400, 500

GET

/search

Return a list of all objects found by searching criteria.
Notice: community and collection are mutually exclusive options.

-

TBD modifiers{{query=query}}&(community=id or
collection={{collection=id}}
idOnly=false

id
name
lastmodified
submitter

Item info with basic metadata for the search results. Additionally return only
identifiers when idOnly=true is used.

json
xml

200, 204, 400, 500

GET

/harvest

Return a list of all objects that have been created, modified or withdrawn within specified time range.

-

startdate
{enddate}}
community
collection
idOnly=false
withdrawn=false
Notice: community and collection are mutually exclusive options

-

Contains item info including id, name, handle, metadata, bitstreams according to
the defined requirements. Additionally when idOnly=true only identifiers of
results are returned. If the date is in incompatible format, error 400 is returned.

json
xml

200, 204, 400, 500