Перейти к содержанию

Файлы

Добавление файла

Метод: POST
URL: https://beta.api.gigma.ru/files
Авторизация: Bearer token

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

  • file_type_id - ID типа загружаемого файла из запроса
  • file - URL(FILE)
  • link - произвольная ссылка (например, на видео), которая будет прикреплена к файлу

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

https://beta.api.gigma.ru/files FORM DATA (Multipart) file_type_id 1 file test.py (FILE) link https://google.ru

Ответ

При успешном действии возвращается HTTP код 200.

{
    "file": {
        "id": 2201,
        "name": "downloader.py",
        "type": {
            "id": 1,
            "name": "Трудовой договор",
            "avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/7NYkKhv2Tm9CGlpcDzzLcsrKtrce8K39M4uU9pDw",
        "link": "https:\/\/google.ru",
        "created_at": "2024-12-03T10:42:18.000000Z",
        "updated_at": "2024-12-03T10:42:18.000000Z"
    }
}

Описание полей ответа

  • id - первичный ключ
  • name - имя загруженного файла
  • type - объект с информацией о типе файла. Для получения информации о полях см. запрос
  • path - URL-адрес файла
  • link - произвольная URL ссылка
  • created_at - дата и время добавления
  • created_at - дата и время обновления

Получение выбранного файла

Метод: GET
URL: https://beta.api.gigma.ru/files/{id}
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/files/1

Ответ

При успешном действии возвращается HTTP код 200.

{
    "file": {
        "id": 1,
        "name": "logo.svg",
        "type": {
            "id": 1,
            "name": "Трудовой договор",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "path": "http:\/\/localhost:8000\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
        "created_at": "2024-04-14T20:04:32.000000Z",
        "updated_at": "2024-04-14T20:04:32.000000Z"
    }
}

Описание полей ответа

  • id - первичный ключ
  • name - имя загруженного файла
  • type - объект с информацией о типе файла. Для получение информации о полях см. запрос
  • path - URL-адрес файла
  • link - произвольная URL ссылка
  • created_at - дата и время добавления
  • created_at - дата и время обновления

Удаление выбранного файла

Метод: DELETE
URL: https://beta.api.gigma.ru/files/{id}
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/files/1

Ответ

При успешном действии возвращается HTTP код 200.

{
    "message": "File successfully deleted"
}

Описание полей ответа

  • message - информационное сообщение