Activity
Method & Permission
| API | GET | POST | PUT | PATCH | DELETE |
|---|---|---|---|---|---|
| Trail List | Admin, Project Admin, Project Edit, Project View | - | - | - | - |
| Trail Detail | Admin, Project Admin, Project Edit, Project View | - | - | - | - |
GET Trail List
Endpoint: /tables/activity/list/{level}/{sid}/{serializer}/
Parameter: level (path, string)
organization
Parameter: sid (path, string)
organization sid
Parameter: serializer (path, string)
Parameter: token (header, string)
Authentication token
Parameter: row__sid (query, string)
If not provided, the most recent activities will be returned.
Response: 200 — Cake successfully retrieved.
# serializer = name
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 7,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "svyB0a40xf8fuzEJOTY4",
"name": "Updated Section (Overview) date_updated"
},
...
]
}
# serializer = list
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 7,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"icon": "edit",
"user": {
"sid": "hknq0a40x42jotyDINS",
"first_name": "Test",
"last_name": "Labii",
"email": "test@labii.com"
},
"action": "Updated",
"field": "Section (Overview) date_updated",
"date_created": "2020-09-22T22:56:59.337833Z",
"change_permission": false
},
...
]
}
# serializer = detail
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 7,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"icon": "edit",
"row": {
"sid": "xADG0a40x6702zEJOTY49",
"name": "EP1055: Test Name 20200922155614"
},
"version": {
"sid": "470c0a40x2bfc26afkpuzE",
"name": "EP1055: Test Name 20200922155614 (v2)"
},
"user": {
"sid": "hknq0a40x42jotyDINS",
"first_name": "Test",
"last_name": "Labii",
"email": "test@labii.com"
},
"action": "Updated",
"field": "Section (Overview) date_updated",
"old_data": "2020-09-22 22:56:44.452333+00:00",
"new_data": "2020-09-22 22:56:59.327526+00:00",
"date_created": "2020-09-22T22:56:59.337833Z",
"change_permission": false
},
...
]
}
Response: 406
Invalid row__sid (xxx)
GET Trail Detail
Endpoint: /tables/activity/detail/{sid}/
Parameter: sid (path, string)
trail sid
Parameter: token (header, string)
Response: 200
{
"icon": "edit",
"row": {
"sid": "xADG0a40x6702zEJOTY49",
"name": "EP1055: Test Name 20200922155614"
},
"version": {
"sid": "470c0a40x2bfc26afkpuzE",
"name": "EP1055: Test Name 20200922155614 (v2)"
},
"user": {
"sid": "hknq0a40x42jotyDINS",
"first_name": "Test",
"last_name": "Labii",
"email": "test@labii.com"
},
"action": "Updated",
"field": "Section (Overview) date_updated",
"old_data": "2020-09-22 22:56:44.452333+00:00",
"new_data": "2020-09-22 22:56:59.327526+00:00",
"date_created": "2020-09-22T22:56:59.337833Z",
"change_permission": false
}