Page History

•

POST

/communities

Action to be done under community id, adding new content or values.

Supported actions:
createAdministrators
createCollection
createSubcommunity

id, {{action}}


-
name
name

-

Id of newly created entity, depending on the action selected:
id of group of administrators
id of collection
id of subcommunity

json 
xml

200, 400, 401, 403, 500

PUT

/communities/{id}/{element}

Update the field element of the community id.

Supported fields:
name - change name
shortDescription - change short description
copyrightText - change copyright text
sidebarText - change sidebar text
introductoryText - change introductory text
collections - add existing collectionscollection
children - add existing subcommunities subcommunity

id


value
value
value
value
value
cid
cid

-

Response code

200, 400, 401, 403, 500

PUT

/communities/{id}/logo

Set the logo for community id

id

-

Response code

binary

200, 400, 401, 403, 500

•

DELETE

/communities/{id}

Delete community from the system

id

-

Response code

json
xml

200, 400, 401, 403, 500

•

DELETE

/communities/{id}/{element}/{eid}

Remove attribute/value eid of element element from the community id.

Suported attributeselements:
collections
children
administrators

id, {{eid}}



cid
cid
-

-

Response code

json
xml

•

DELETE POST

/communities/{id}/collections/{cid}

Remove collection cid from community id

Action to be done under collection id, adding new content or values.

Supported actions:
createAdministrators
createSubmitters
createTemplateItem
createWorkflowGroup

id, {{cidaction}}
-

Response code

-
-
step

-

Id ow newly created element

json
xml

200, 400, 401, 403, 500  

•

DELETE PUT

/communitiescollections/{id}/children/{cidelement}

Remove subcommunity cid from community id

id, {{cid}}

-

Response code

•

PUT

/communities/{id}/collections/{cid}

Add an existing collection cid to community id

id
cid

--

Response code

•

PUT

/communities/{id}/children/{cid}

Add an existing community cid as a subcommunity of community id

id
cid

-

Response code

PUT

/communities/{id}/metadata

Set metadata value

id

metadataField
metadataValue

Response code

•

PUT

/collections/{id}

Change description of id collection

id

Response code

json
xml

200, 400, 401, 403, 500

•

POST

/collections

Add collection to the system

name
communityId

Id of newly created collection

json
xml

200, 400, 401, 403, 500

•

DELETE

/collections/{id}

Delete collection from the system

-

-

Response code

json
xml

200, 400, 401, 403, 500

DELETE

/collections/{id}/items/{cid}

Delete item cid from collection id

id

cid

Response code

json
xml

PUT

/collections/{id}/logo

Set the logo for collection id

id

Response code

POST

/collections/{id}/administrators

Create a default administrators group if one does not already exists

id

-

Response code

DELETE

/collections/{id}/administrators

Remove the administrators group from the collection

id

-

Response code

PUT

/collections/{id}/submitters

Create a default submitters group if one does not already exists

id

-

Response code

DELETE

/collections/{id}/submitters

Remove the submitters group

id

-

Response code

PUT

/collections/{id}/templateitem

Create an empty template item for this collection

id

-

Response code

Update field element of the collection id.

Supported elements:
shortDescription - short description
introText - introductory text
copyrightText - copyright text
sidebarText - sidebar text
provenance - provenance
licence - collection licence
name - collection name

id

value
value
value
value
value
value
value

-

Response code

json
xml

200, 400, 401, 403, 500

•  

DELETE

/collections/{id} /templateitem

Delete collection Remove the template item from the collection system

id -

-

Response code

json
xml

200, 400, 401, 403, 500  

POST DELETE

/collections/{id}/{element}/items

Add an item to the collection

id

itemId

Response code

PUT

/collections/{id}/metadata

Set metadata value

id

metadataField
metadataValue

Response code

{cid}

Remove attribute/value cid from collection id
Supported attributes:
administrators
item
submitters
templateItem

id, {{cid}}

-

Response code

json
xml  

PUT

/collections/{\id}/licencelogo

Set the logo for collection licence id

id

licence  

Response code

  binary