C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes |
---|
• | 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 collection children - add existing 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 elements: collections children administrators | id, {{eid }}
cid cid - | - | Response code | json xml | |
•
| POST | /collections | Action to be done under collection id , adding new content or values.
Supported actions: createAdministrators createSubmitters createTemplateItem createWorkflowGroup
| id, {{ action }} - - - step
| - | Id ow newly created element | json xml | 200, 400, 401, 403, 500 |
•
| PUT | /collections/{id}/{element } | 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 } | Delete collection from the system | - | - | Response code | json xml | 200, 400, 401, 403, 500 |
| DELETE | /collections/{id}/{element}/{cid } | Remove attribute/value cid from collection id Supported attributes: administrators item submitters templateItem | id, {{cid }} | - | Response code | json xml | |
| PUT | /collections/{id}/logo | Set the logo for collection id | id | | Response code | binary | |
| | | | | | | | |