...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| | | Returns a list of all communities on the system or return just top level communities. | - | The list of communities containing respective fields . | | |||||||||
• | | | Return information about | | | - | Fields describing community. | | |||||||
• | | | Return a particular data field found in the community
element): id - entity identifier, internal to the system name - entity name countItems - number of items under community handle - handle of the community (unique persistent resource identifier) type - entity type (object type in the system) collections - collections contained in the community, ordered by id canedit - states user persmission on the community (editing) anchestor - anchestors of the community children - subcommunities, ordered by id administrators - group administrators, ordered by id recent - recent items in the community shortDescription - short description copyrightText - copyright text sidebarText - sidebar text introductoryText - introductory text | | Respective field info | | |||||||||
• | | | Return a community logo | | - | - | Contains community logo (bitstream) | | |||||||
• | | | Return a list of all collections in the system. | - | The list of the collections containing respective fields. | | |||||||||
• | | | Return information about | | Fields of the collection entity. | | |||||||||
• | | | Return a particular data field found in the collection
element): id - entity identifier, internal to the system name - collection name licence - collection licence items - items contained in collection handle - handle of the collection (unique persistent resource identifier) canedit - states user permission on the collection (edit) communities - communities collection is a part of countItems - number of the items in the collection type - entity type (object type in the system) shortDescription - short description of the collection introText - introductory text for the collection copyrightText - copyright text for the collection sidebarText - sidebar text for the collection provenance - provenance | | Respective field info | | |||||||||
|
|
|
|
|
|
|
|
|
|
Note: modifier idOnly is referred only to first layer of the results. For all other layers (e.g. nested results) only ids are returned in some cases, due to possible loops. Example: for community containing collections, on second level the response contains only ids for some elements where multiple loops may be created (community->has_collection->has_community....). Other data is modified according to idOnly flag.
...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|
• | | | Action to be done under community |
| - | | | 200, 400, 401, 403, 500 |
| | /communities/{id}/{element} | Update the field | | - | Response code |
| 200, 400, 401, 403, 500 |
| | | Set the logo for community | | - | Response code | binary | 200, 400, 401, 403, 500 |
• | | | Delete community from the system | | - | Response code | | 200, 400, 401, 403, 500 |
• | | | Remove attribute/value |
| - | Response code | |
|
• | | | Action to be done under collection | | - | Id ow newly created element | | 200, 400, 401, 403, 500 |
• | | | Update field | | - | Response code | | 200, 400, 401, 403, 500 |
• | | | Delete collection from the system | - | - | Response code | | 200, 400, 401, 403, 500 |
| | | Remove attribute/value |
| | Response code | |
|
| | | Set the logo for collection | |
| Response code | binary |
|
|
|
|
|
|
|
|
|
|
...