...
This endpoint returns all the available REST endpoints.
| Status |
|---|
| colour | Yellow |
|---|
| title | ENDPOINT Url |
|---|
|
/testExample response:
| Code Block |
|---|
|
[
{
"user": "myusername"
},
{
"info": "{ /api/v1/test}"
},
{
"info": "{ /api/v1/upload}"
},
...
} |
...
The groups endpoint returns all the groups the authenticating user has access to.
| Status |
|---|
| colour | Yellow |
|---|
| title | ENDPOINT Url |
|---|
|
/groupsExample Response:
| Code Block |
|---|
[
{
"id": 1234,
"name": "dataset",
"version": 2,
"created": "2020-06-02T18:40:57Z",
"lastModified": "2020-06-10T18:30:24Z",
"numItems": 345,
"owner": 111,
"type": "Private",
"description": "",
"url": "",
"syncInfo": null
},
{
"id": 56789,
"name": "Shared Group",
"version": 3,
"created": "2019-08-15T18:02:36Z",
"lastModified": "2019-08-15T18:12:40Z",
"numItems": 5555,
"owner": 1123,
"type": "Private",
"description": "",
"url": "",
"syncInfo": null
}
] |
...
This endpoint returns information about a specific group. The returned information will also include sync information for a group.
| Status |
|---|
| colour | Yellow |
|---|
| title | ENDPOINT Url |
|---|
|
/groups/{groupId}Example Response:
| Code Block |
|---|
{
"id": 1234,
"name": "dataset",
"version": 18,
"created": "2018-11-19T21:34:21Z",
"lastModified": "2020-09-22T21:11:07Z",
"numItems": 37,
"owner": 1111,
"type": "Private",
"description": "<p>This is for testing Citesphere.</p>",
"url": "",
"syncInfo": {
"createdOn": "2020-09-30T13:17:26-04:00",
"status": "DONE"
}
} |
...
The collections endpoint returns all collections in a group or in a collection.
| Status |
|---|
| colour | Yellow |
|---|
| title | ENDPOINT Url |
|---|
|
/groups/{groupId}/collections, /groups/{groupId}/collections/{collectionId}/collections| Status |
|---|
| colour | Blue |
|---|
| title | Parameters |
|---|
|
...
The items endpoint returns the items in a group or collection.
| Status |
|---|
| colour | Yellow |
|---|
| title | ENDPOINT Url |
|---|
|
/groups/{groupId}/items, /groups/{groupId}/collections/{collectionId}/items| Status |
|---|
| colour | Blue |
|---|
| title | Parameters |
|---|
|
...