...
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. | - | By default contains item count, identifier, handle and name and other referencing data, or 204 if none. Additionaly, based on parameter | | 200, 400, 500 | |||||||||||||||||||||||||
• | | | Return information about | - | - | - TBD | Contains information about community, including id, handle, name, collections, ancestors, subcommunities, administrators, metadata | | 200, 204, 400, 500 | |||||||||||||||||||||||
• | | | Return entities according to relation and parameters specified |
|
|
|
|
| | - | Contains entities selected and sorted in conformance to request parameters | | 200, 204, 400, 500 | |||||||||||||||||||
• | | | Return a list of all ancestor communities of the | - | | 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. | | 200, 204, 400, 500 | ||||||||||||||||||||||||
• | | | Returns a list of immediate sub-communities (children) of the | - | | Contains item count, identifiers, handle and name or 204 if none. Additionaly, based on parameter | | 200, 204, 400, 500 | ||||||||||||||||||||||||
• | | | Return a list of collections in the | - | | | {{[id | #sort_id]}} | #sort_name]}} | #sort_countitems]}} | | | | #sort_id]}} | #sort_name]}} | #sort_countitems]}} | Return a list of all ancestor communities a collection with | - | idOnly=false | | Contains item count, identifier, name and handle of collections, or 204 if | | | Return information about |
| | | • | | Returns Return a list of all items from the collection | - | | {{[id | #sort_id]}} | #sort_name]}} | #sort_countitems]}} |
Mandatory parameters
Parameter | Description | Values | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| Return entities satisfying requested property relation | | | | | restriction on type - only entity with specifed type(s) would be returned |
| ||||||
|
|
|
|
Note: incomplete/orientative properties, for more info check Vocabularies.
Optional parameters
...
Parameter
...
Description
...
returns only top level communities
...
if true return only the identifiers for the record
Sorting fields:
...
Parameter
...
Description
...
Ordering supported
...
sort results by entity id
...
asc | ascending
desc | descending
...
sort results by entity name
...
asc | ascending
desc | descending
...
sort results by number of items contained
...
asc | ascending
desc | descending
Controlling results
Parameter | Description | Default | Example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
_start | position of the first entity to return | 0 (first) |
topLevelOnly | returns only top level communities ||
idOnly | if true return only the identifiers for the record ||
immediateOnly | return only direct parent community |h5. Sorting fields: || Parameter || Description || Ordering supported || |
id | sort results by entity id | asc | ascending desc | descending | |
name | sort results by entity name | asc | ascending desc | descending | |
desc | descending | |
lastmodified | sort results by date of last item modification | asc | ascending desc | descending | |
submitterName | sort results by submitter name | asc | ascending desc | descending | |
submitterId | sort results by submitter id | asc | ascending desc | descending | h5. Controlling results || Parameter || Description || Default || Example || | _start | position of the first entity to return | 0 (first) | _start=5 to list 6th item and onwards | | _page | page of data to display | 0 (first) | _page=2, to display second page with query results | | _perpage | number of results to show on each page | 0 (all) | _perpage=10 to display 10 results per page | | _limit | maximum number of entities to return | 0 (all) | _limit=50 | | _sort | the sort order to return entities in should be comma separated list of field names suffix determines ordering suffixes: _asc, _ascending, _desc, _descending | ascending default | _sort=name _sort=name,email_desc,lastname_desc | h4. Repository manipulation || C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
• | | /communities/{id} | Change description of | name | - | TBD | | 200, 204, 400, 500 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
• | | | Add community to the system | name | | TBD | | 200, 204, 400, 500 |
...