Перейти к основному содержимому

Создать импорт из файла

POST 
/api/v1/clients/:clientId/importTasks

Описание метода​

Метод позволяет создать задачу на импорт данных. Импорт из файла будет выполняться асинхронно. В связи с этим в качестве успешного результата будет возвращаться номер задачи на импорт. Результат выполнения задачи можно проверить методом GET /api/v1/clients/{clientId}/importTasks/{taskId}

Валидации запроса​

  • Тело запроса задано корректно.
  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Файл, из которого нужно загрузить данные, существует.
  • Файл, из которого нужно загрузить данные, имеет одно из допустимых расширений.
  • Файл, из которого нужно загрузить данные, не превышает допустимый максимальный размер в байтах.
  • Текущий пользователь клиента имеет возможность создавать задачи на загрузку данных из файла.
  • Данные для заданного типа данных задачи корректны.
  • Тело запроса задано.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. файла для асинхронной загрузки задан.
  • Тип данных асинхронной загрузки задан.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Проверяет, что файл с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует.
  • Проверяет, что файл является файлом с одним из указанных расширений.
  • Проверяет, что размер файла в байтах не превышает максимальное допустимое значение.
  • Количество активных задач, созданных пользователем клиента, не превышает максимальное допустимое значение.
  • Пользователь с указанным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. является создателем файла, из которого нужно загрузить данные.
  • Выполняет валидацию данных для асинхронной загрузки в зависимости от типа данных.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. файла для асинхронной загрузки задан.
  • Проверяет, что тип данных для асинхронной загрузки задан.
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.
  • Проверяет, что количество активных задач, созданных пользователем клиента, не превышает допустимый максимум.
  • Проверяет, что пользователь с указанным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. является создателем файла, из которого нужно загрузить данные.

Request​

Responses​

Успешная операция.