Files
Get a collection of files.
Authorizations
Query parameters
filterstringOptional
Use the filter
query parameter to retrieve just a subset of a collection.
searchstringOptional
Use the search
query parameter to restrict the results of a request to match a search criterion.
orderbystringOptional
Use the orderby
query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
skipinteger · int32OptionalDefault:
Use the skip
query parameter to set the number of items to skip at the start of a collection.
0
topinteger · int32 · min: 1 · max: 100OptionalDefault:
Use the top
query parameter to specify the page size of the result set.
100
Responses
200
OK
application/json
4XX
Error
get
GET /api/files HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"size": 0,
"media_type": "audio/vnd.wave",
"created_at": "2017-07-21T17:32:28Z"
}
]
}
Get file details by it's unique ID.
Authorizations
Path parameters
idall ofRequired
The unique ID of the file.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
4XX
Error
get
GET /api/files/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"size": 0,
"media_type": "audio/vnd.wave",
"created_at": "2017-07-21T17:32:28Z"
}