C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes |
---|
• | PUT | /communities/{id}/{element } | Change description of element describing id community
| id, {{element }} | - | Response code | json xml | 200, 400, 401, 403, 500 | • | POST
| /communities | Action to be done under community id , adding new content or values.
Supported actions: createAdministrators createCollection createSubcommunity | id
- 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 |
• | DELETE PUT | /communities/{id} | Delete community from the system | 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 collections children - add existing subcommunities | id
value value value value value cid cid | - | Response code | json xml | 200, 400, 401, 403, 500 |
•
| DELETE | /communities/{id } /administrators
| Delete community Remove the administrators group from the community system | id | - | Response code | json xml | | •
| DELETE | /communities/{id}/collections/{cid }
| Remove collection cid from community id | id
cid | Response code | | 200, 400, 401, 403, 500 |
•
| DELETE | /communities/{id}/children{element}/{cideid }
| Remove subcommunity cid from attribute eid of element element from the community id . id Suported attributes: cid collections
| Response code | | | •
| POST | /communities/{id}/administrators
| Create a default administrators group if one does not already exists | id | - | Id of newly created group
| children
| id, {{eid }} | - | Response code | json xml | |
•
| POST DELETE | /communities/{id}/collections
/{cid }
| Remove collection cid from Create a new collection within community id | id,{{cid }}
| - Id | of newly created collection Response code | | |
•
| DELETE PUT
| /communities/{id}/collectionschildren/{cid }
| Add an existing collection cid to Remove subcommunity cid from community id | id
, {{cid }}
| - -
| Response code | | |
•
| POST PUT | /communities/{id}/children
collections/{cid }
| Add an existing collection cid to Create a new subcommunity within community id | id cid | -- | Response code Id of newly created subcommunity | | |
•
| 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 | | |
| DELETE | /collections/{id}/templateitem | Remove the template item from the collection | id | - | Response code | | |
| POST | /collections/{id}/items | Add an item to the collection | id
| itemId | Response code | | |
| PUT | /collections/{id}/metadata | Set metadata value | id
| metadataField metadataValue
| Response code | | |
| PUT | /collections/{\id}/licence | Set collection licence | id | licence | Response code | | |
| | | | | | | | |