Files

Scheme: files.

GET

/api/files

Получение списка файлов

Запрос

Параметры запроса:

Name	In	Type	Description
where (Optional)	url parameters	JSON object	Фильтр элементов. Используется синтаксис mongo запросов.
sort (Optional)	url parameters	string	Сортировка элементов.
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.
page (Optional)	url parameters	integer	Номер страницы элементов.
max_results (Optional)	url parameters	integer	Максимальное число элементов на одной странице.

Пример запроса:

curl -X GET http://tkcontrol/api/files

Ответ

Пример ответа:

{
    "_items": [
        {
            "_id": "5f73049d836e90817cbccaab",
            "data": "/api/media/5f73049d836e90817cbccaa9",
            "name": "addresses.xlsx",
            "_updated": "Tue, 29 Sep 2020 09:55:41 GMT",
            "_created": "Tue, 29 Sep 2020 09:55:41 GMT",
            "_links": {
                "self": {
                    "title": "File",
                    "href": "files/5f73049d836e90817cbccaab"
                }
            }
        }
    ],
    "_links": {
        "parent": {
            "title": "home",
            "href": "/"
        },
        "self": {
            "title": "files",
            "href": "files"
        }
    },
    "_meta": {
        "page": 1,
        "max_results": 25,
        "total": 1
    }
}

GET

/api/files/{id}

Получение файла по id

Запрос

Параметры запроса:

Name	In	Type	Description
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.

Пример запроса:

curl -X GET http://tkcontrol/api/files/5f73049d836e90817cbccaab

Ответ

Пример ответа:

{
    "_id": "5f73049d836e90817cbccaab",
    "data": "/api/media/5f73049d836e90817cbccaa9",
    "name": "addresses.xlsx",
    "_updated": "Tue, 29 Sep 2020 09:55:41 GMT",
    "_created": "Tue, 29 Sep 2020 09:55:41 GMT",
    "_links": {
        "self": {
            "title": "File",
            "href": "files/5f73049d836e90817cbccaab"
        },
        "parent": {
            "title": "home",
            "href": "/"
        },
        "collection": {
            "title": "files",
            "href": "files"
        }
    }
}

POST

/api/files

Сохранить новый файл

Save new file.

Запрос

Параметры запроса:

Name	In	Type	Description
name (Optional)	body	string	Имя файла.
data (Optional)	body	binary	Данные файла.

Пример запроса:

curl -X POST http://tkcontrol/api/files -d '\
    data: (binary) \
    name: addresses.xlsx \
'