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

Создание записи загрузки

Метод позволяет создать запись о загрузке.

Адрес: {pp_url}/api/uploads
Тип: POST
Authorization: авторизация

Описание заголовков

Ключ заголовков Описание Тип Обязательность
User-Id Идентификатор пользователя в системе агрегатора string о (в случае если запрос отправляется от имени агрегатора)

Описание тела запроса

ContentType: application/json

Переменная Описание Тип Обязательность
originalName1 Имя файла архива string o
hash1 SHA1 хэш архива string o
sendOnWarnings Отправлять при предупреждениях boolean

Ответы

Код ответа Описание
500 Не удалось добавить запись в базу данных
401 Неавторизованный пользователь
400 Возникла ошибка связанная с текущим состоянием данных и входными данными. Подробнее смотрите в свойствах ответа
201 Запись для загрузки создана. В заголовке Location находится адрес для выполнения загрузки и получения информации

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

Код: 500
ContentType: application/json

Переменная Тип Nullable Описание
id string true Идентификатор загрузки
originalName string true Имя файла при загрузке
state string true Состояние
uploadedAt string true Дата загрузки

Код: 400
ContentType: application/json

Переменная Тип Nullable Описание
description string true Описание ошибки
content Дополнительное содержимое

Код: 201
Location: содержит адрес для выполнения загрузки и получения информации
ContentType: application/json

Переменная Тип Nullable Описание
id string true Идентификатор загрузки
originalName string true Имя файла при загрузке
state string true Состояние
uploadedAt string true Дата загрузки

Примеры

Код 400

1
2
3
4
{
    "hash":"{{generated_hash}}",
    "originalName":"123.zip"
}
1
2
3
{
    "description": "Некорректное имя архива."
}

Код 201

1
2
3
4
{
    "hash":"3d18a3d000333659e2710b75922c04cce4a69e47",
    "originalName":"req_3f979ec7-43a4-4d7a-90f2-a5d73ea374c9.zip"
}
1
2
3
4
5
6
{
    "id": "80a7597c-758e-4f92-94a3-93a1a51fb4ab",
    "originalName": "req_3f979ec7-43a4-4d7a-90f2-a5d73ea374c9.zip",
    "state": "Created",
    "uploadedAt": "01.01.0001 0:00:00"
}

  1. Отправлять в РР по умолчанию, если при проверке обнаружены только предупреждения.