Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Files

Returns a list of archived items.

get/files

Query parameters

sortstring[]

Comma separated list of of fields that should be sorted.

  • sort= - not providing any value will result in error 400
  • sort=+name,+name - same values will result in error 400
  • sort=-name,+name - mutially exclusive values will return error 400
  • maxItem=3 - Only Three values will be accepted, more will return error 400
  • qRelevance is optional ordering parameter which is available if q filter is used, if q filter is not passed qRelevance as ordering parameter will return error 400
mimeType'video/mp4' | 'application/directory'

The media content type.

Example:video/mp4

Exact content type.

mimeType__contains'video/mp4' | 'application/directory'

The media content type.

Example:video/mp4

Content type contains filter.

createTimestamp__ltestring date-time

Date and time when the item was created.

Example:2021-04-22T00:00:00.000Z

Maximum timestamp for file creation date.

createTimestamp__gtestring date-time

Date and time when the item was created.

Example:2021-04-22T00:00:00.000Z

Minimum timestamp for file creation date.

directorystring

Name of the parent directory.

Example:/Bundles/North Door

Name of parent directory.

directory__containsstring

Name of the parent directory.

Example:/Bundles/North Door

Item directory contains filter.

namestring

Name of the item.

Example:Video North Door 2022-08-03 23-04-50.mp4

Exact name of the item.

name__containsstring

Filter to get the accounts whose name contains the provided substring. The lookup is exact and case insensitive.

notes__containsstring

User entered annotations.

Example:Kids throwing rocks.

Notes filter.

size__lteinteger

Size of the file in Bytes.

Example:4242194

Maximum file size.

size__gteinteger

Size of the file in Bytes.

Example:4242194

Minimum file size.

includestring[]

The fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. You can use the special value * during development to return all fields, however, to achieve better performance, it is advisable to explicitly select only the fields you need.

[
  "accountId",
  "publicShare",
  "notes",
  "createTimestamp",
  "updateTimestamp",
  "size",
  "metadata",
  "tags",
  "childCount",
  "details"
]
pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Response

OK

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger nullable

The number of resource entries being returned from the result set. This can be omitted if the API endpoint does not have total size information.

Example response

{
  "results": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "directory": "/Bundles/North Door",
      "mimeType": "video/mp4",
      "name": "Video North Door 2022-08-03 23-04-50.mp4"
    }
  ]
}