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

Статистика документов

POST 
/api/v1/clients/:clientId/documents/getStatistics

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

Метод возвращает количество документов по разным показателям.

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

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

Request​

Responses​

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