List of resources in a resource group
Pagination list of all resources, see Creating a resource
Error rendering macro 'macro-html' : Page loading timed out
Headers |
Authorization | Bearer token |
Accept | application/json |
X-Client | ios-cctv|android-cctv|thick-legal|web |
X-UUID | unique device id |
Body |
analytic_groupoptional | int | Unique identifier of the resource group |
pagerequired | int | Page number of the pagination |
per_pagerequired | int | Number of items per page in the pagination. Default is 25 items |
exclude_files_idsrequired | array | Array of resource IDs to exclude. Excluded IDs will not be reflected in the output |
searchrequired | int | Search for resources by name |
Response |
Error rendering macro 'macro-html' : Page loading timed out | Returns the list of resources on the i-th page of the pagination |
JSON
{
"data": [
{
"id": 1,
"name": "name",
"type": "type",
"type_pretty": "type_pretty",
"uuid": null,
"body": "1111AA7",
"url": "https://vms.local/storage/analytic-files/2022/4/8/CmICjV9h4RNgP3V9evqeNg7HTbRk0juCB0XXXXay7.jpg",
"created_at": "2022-04-08 16:01:33",
"updated_at": "2022-04-08 16:01:33"
}
],
"links": {
"first": "https://vms.local/api/v1/analytics/files?analytic_case=945&page=1",
"last": "https://vms.local/api/v1/analytics/files?analytic_case=945&page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": null,
"last_page": 1,
"links": [
{
"url": null,
"label": "pagination.previous",
"active": false
},
{
"url": "https://vms.local/api/v1/analytics/files?analytic_case=945&page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "pagination.next",
"active": false
}
],
"path": "https://vms.local/api/v1/analytics/files",
"per_page": 25,
"to": 1,
"total": 1
}
}
|
Error rendering macro 'macro-html' : Page loading timed out | Authorization token not provided or invalid, see Obtaining a token |
Error rendering macro 'macro-html' : Page loading timed out | Returns a JSON object with an error, see Validation |
JSON
{
"message": "There won't be any informative message here",
"errors": {
"any_key": [
"Here the error cause will be described"
]
}
}
|
Example |
JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytics/groups/{analytic_group}/files?page=int&per_page=int&exclude_files_ids=array&search=int' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
|
