openapi: 3.0.3
info:
  title: VRt.Account [AC]
  version: 6.20.2289
  license:
    name: Proprietary
    url: https://veeroute.ru/
  termsOfService: https://veeroute.ru/resources/terms_of_service
  contact:
    name: Veeroute Support Team
    email: servicedesk@veeroute.com
  x-logo:
    url: ../images/account.svg
    backgroundColor: '#FAFAFA'
    altText: VRt.Account
  description: '# Описание


    Программный интерфейс для управления учетной записью Veeroute.


    ## Диаграмма сущностей


    ![erd](../uml/account.svg)

    '
servers:
- url: https://api.edge.veeroute.tech
  description: Окружение для интеграции и ознакомления с новой функциональностью
- url: https://api.prod.veeroute.com
  description: Основное окружение
security:
- ApiKeyAuth: []
tags:
- name: Auth
  description: 'Авторизация.

    '
- name: Info
  description: 'Информация об аккаунте.

    '
- name: Statistics
  description: 'Статистика.

    '
- name: Audit
  description: 'Пользовательские действия.

    '
- name: Data
  description: 'Пользовательские данные.

    '
- name: Quotas
  description: 'Квотирование.

    '
- name: System
  description: 'Системные функции.

    Вспомогательный функционал, общий для всех сервисов.

    '
externalDocs:
  description: Основной сайт
  url: https://veeroute.ru/
paths:
  /account/token/generation:
    post:
      tags:
      - Auth
      summary: Получение токена
      description: Получение токена по паре логин - пароль.
      operationId: run_token_generation
      security: []
      requestBody:
        description: Запрос на получение токена.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/token_request'
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/token'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/token/validation:
    post:
      tags:
      - Auth
      summary: Проверка токена
      description: Проверка токена.
      operationId: run_token_validation
      security: []
      requestBody:
        description: Запрос на проверку токена.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/token'
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/token_validation_result'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/password:
    post:
      tags:
      - Auth
      summary: Смена пароля
      description: Смена пароля на новый и получение нового токена.
      operationId: change_password
      requestBody:
        description: Данные для смены пароля.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/password_request'
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/token'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/info:
    get:
      tags:
      - Info
      summary: Информация об аккаунте
      description: Получение информации об аккаунте.
      operationId: read_info
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_info'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
    put:
      tags:
      - Info
      summary: Обновление пользователя
      description: 'Обновление информации о пользователе. Возможно обновление только
        полей name, email, phone.

        '
      operationId: update_info
      requestBody:
        description: Запрос на обновление информации о пользователе.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account_info'
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_info'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/statistics:
    get:
      tags:
      - Statistics
      summary: Статистика за период
      description: 'Статистика за период.  Если период не указывается - возвращается
        статистика за текущий месяц - с начала месяца по текущий день (не включая
        его). Если дата "с" не указана - берется начало текущего месяца. Если дата
        "по" не указана - берется вчерашний день (не включая его).

        '
      operationId: generate_statistics
      parameters:
      - $ref: '#/components/parameters/date_from'
      - $ref: '#/components/parameters/date_to'
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/user_statistics'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/report:
    get:
      tags:
      - Statistics
      summary: Создание отчета
      description: 'Создание отчета со статистикой по использованию. Если дата не
        указана - возвращается статистика за текущий месяц - с начала месяца по текущий
        день (не включая его). Если дата "с" не указана - берется начало текущего
        месяца. Если дата "по" не указана - берется текущий день (не включая его).

        '
      operationId: read_report
      parameters:
      - $ref: '#/components/parameters/date_from'
      - $ref: '#/components/parameters/date_to'
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/file_xlsx'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/quota:
    get:
      tags:
      - Quotas
      summary: Чтение списка квот
      description: Чтение списка квот по пользователю.
      operationId: read_quota
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/quotas_result'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/audit:
    get:
      tags:
      - Audit
      summary: Действия за период
      description: 'Действия пользователей за период. Если период не указывается -
        возвращаются данные за текущий день - с начала дня по текущее время включительно.
        Если не указано начало временного отрезка - возвращаются данные с начала текущего
        дня. Если не указан конец временного отрезка - возвращаются данные до текущего
        времени.

        '
      operationId: read_audit
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/datetime_from'
      - $ref: '#/components/parameters/datetime_to'
      - name: service_name
        description: Название сервиса.
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/service_name'
      - name: operation_id
        description: Идентификатор операции.
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/operation_id'
      - name: method_group
        description: Название группы метода.
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/method_group'
      - $ref: '#/components/parameters/sort_field'
      - $ref: '#/components/parameters/sort_direction'
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_audit_result'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/data/{tracecode}:
    get:
      tags:
      - Data
      summary: Чтение данных
      description: Получение данных по `tracecode`.
      operationId: read_data
      parameters:
      - $ref: '#/components/parameters/tracecode'
      - $ref: '#/components/parameters/data_flow_type'
      - $ref: '#/components/parameters/data_flow_stage'
      - $ref: '#/components/parameters/data_flow_convert'
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/file_xlsx'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/system/check:
    get:
      tags:
      - System
      summary: Проверка доступности
      description: Проверка доступности сервиса.
      operationId: check
      security: []
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check_result'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/system/version:
    get:
      tags:
      - System
      summary: Получение версии сервиса
      description: Получение версии сервиса.
      operationId: version
      security: []
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/version_result'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /account/file/{filename}:
    parameters:
    - $ref: '#/components/parameters/filename'
    get:
      tags:
      - System
      summary: Получение документации
      description: Получение файла с документацией на этот сервис.
      operationId: file
      security: []
      responses:
        '200':
          description: Успешное выполнение
          content:
            text/html:
              schema:
                $ref: '#/components/schemas/file_html'
            text/plain:
              schema:
                $ref: '#/components/schemas/file_json'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
components:
  securitySchemes:
    ApiKeyAuth:
      description: "Для [аутентификации](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)\
        \ клиента \nиспользуется [JWT токен](https://ru.wikipedia.org/wiki/JSON_Web_Token),\
        \ \nкоторый необходимо указывать в заголовке для каждого запроса в формате:\n\
        \n`Authorization: Bearer <token>`.\n\nУникальный токен для пользовательского\
        \ аккаунта необходимо получить с помощью VRt.Account API.\n"
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    user_name:
      description: Логин, уникальный идентификатор пользователя.
      type: string
      pattern: \w+
      minLength: 2
      maxLength: 256
      example: my_username_for_login
    token_request:
      description: Данные для получения токена.
      type: object
      additionalProperties: false
      properties:
        username:
          $ref: '#/components/schemas/user_name'
        password:
          description: Пароль.
          type: string
          minLength: 1
          maxLength: 1000
          example: password
          writeOnly: true
        ttl_seconds:
          description: Время действия токена, в секундах.
          type: integer
          format: int32
          minimum: 60
          maximum: 31556926
          example: 86400
          default: 86400
      required:
      - username
      - password
    token:
      description: Токен.
      type: string
      minLength: 1
      maxLength: 1000
      example: jwt
    service_name:
      description: Название сервиса.
      type: string
      enum:
      - UNIVERSAL
      - ROUTING
      - ACCOUNT
      - ADMIN
      - STUDIO
      - MONITOR
      - PACKER
      - AGRO
      - STOCK
      - LONGHAUL
      - CLUSTER
      - CARGOTIMETABLE
      example: UNIVERSAL
    operation_id:
      description: Идентификатор операции.
      type: string
      minLength: 3
      maxLength: 256
      example: run_plan_calculation
    tracedata:
      description: Данные используемые для трассировки запросов.
      type: object
      additionalProperties: false
      properties:
        code:
          description: 'Уникальный идентификатор процесса. Если запущен асинхронный
            процесс, то код для него будет одинаковый, хотя другие поля могут отличаться.

            '
          type: string
          format: uuid
          example: 11111111-2222-3333-4444-555555555555
        client:
          description: 'Уникальный идентификатор клиента (`company_key` + `_|_` +
            `username`), который совершил запрос.

            '
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: company_|_username
        server:
          description: Уникальный идентификатор сервера.
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: server_name
        service:
          $ref: '#/components/schemas/service_name'
        operation:
          $ref: '#/components/schemas/operation_id'
        time:
          description: Дата и время вызова метода сервиса в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          example: '2024-02-21T09:30:00+03:00'
      required:
      - code
      - client
      - server
      - service
      - operation
      - time
    general_400:
      description: Детализация по ошибке 400.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Bad Request
      required:
      - tracedata
    general_401:
      description: Детализация по ошибке 401.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Unauthorized
      required:
      - tracedata
    general_402:
      description: Детализация по ошибке 402.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Payment Required
      required:
      - tracedata
    general_403:
      description: Детализация по ошибке 403.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Forbidden
      required:
      - tracedata
    general_404:
      description: Детализация по ошибке 404.
      type: object
      additionalProperties: false
      properties:
        resource_id:
          description: Идентификатор ресурса.
          type: string
          nullable: true
          default: null
          example: resource_id
        detail:
          description: Детализация по ресурсу.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            tracedata:
              $ref: '#/components/schemas/tracedata'
          required:
          - tracedata
    general_429:
      description: Детализация по ошибке 429.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Too many requests
      required:
      - tracedata
    general_500:
      description: Детализация по ошибке 500.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Internal Server Error
      required:
      - tracedata
    user_role:
      description: Роль.
      type: string
      enum:
      - ADMIN
      - PARTNER
      - USER
      - BOT
      example: USER
    user_roles:
      description: Перечень ролей пользователя.
      type: array
      uniqueItems: true
      minItems: 0
      maxItems: 2
      default: []
      items:
        $ref: '#/components/schemas/user_role'
    token_validation_result:
      description: Результат проверки токена.
      type: object
      additionalProperties: false
      properties:
        valid:
          description: Статус токена.
          type: boolean
          example: true
          default: false
        roles:
          $ref: '#/components/schemas/user_roles'
      required:
      - valid
    password_request:
      description: Данные для замены пароля.
      type: object
      additionalProperties: false
      properties:
        current_password:
          description: Текущий пароль.
          type: string
          minLength: 1
          maxLength: 1000
          example: password
          writeOnly: true
        new_password:
          description: Новый пароль.
          type: string
          minLength: 1
          maxLength: 1000
          example: password
          writeOnly: true
      required:
      - current_password
      - new_password
    company_key:
      description: Ключ компании, которая объединяет разных пользователей в одну группу.
      type: string
      pattern: \w+
      minLength: 3
      maxLength: 256
      example: my_company
    account_info:
      description: Информация об аккаунте.
      type: object
      additionalProperties: false
      properties:
        username:
          $ref: '#/components/schemas/user_name'
        name:
          description: ФИО пользователя.
          type: string
          nullable: true
          default: null
          minLength: 2
          maxLength: 256
          example: my_visible_name
        email:
          description: Почта пользователя.
          type: string
          format: email
          nullable: true
          default: null
          minLength: 5
          maxLength: 256
          example: admin@company.com
        phone:
          description: Телефон пользователя.
          type: string
          nullable: true
          default: null
          minLength: 5
          maxLength: 32
          example: '+71112223333'
        company_key:
          $ref: '#/components/schemas/company_key'
        timezone:
          description: Базовая временная зона, которая используется для расчета статистики.
          type: integer
          format: int32
          minimum: -12
          maximum: 12
          default: 0
          example: 3
      required:
      - username
      - company_key
    method_group:
      description: "Название группы метода. Уникальность точек считается в рамках\
        \ одной группы. \n"
      type: string
      enum:
      - NOTRACE
      - TRACE
      - PLAN
      - ACTUALIZE
      - REFINE
      - CONVERT
      - ANALYTICS
      - PREDICT
      - VALIDATE
      - ROUTE
      - MATRIX
      - PACK
      example: PLAN
    method_statistics:
      description: Статистика по использованию метода сервиса.
      type: object
      additionalProperties: false
      properties:
        method_group:
          $ref: '#/components/schemas/method_group'
        unique_points_per_day:
          description: Уникальные точки в день.
          type: integer
          format: int32
          minimum: 0
          maximum: 10000000
          example: 1500
        points_per_day:
          description: Неуникальные точки в день.
          type: integer
          format: int32
          minimum: 0
          maximum: 10000000
          example: 1500
      required:
      - method_group
      - unique_points_per_day
      - points_per_day
    service_statistics:
      description: Статистика по использованию всех методов сервиса.
      type: object
      additionalProperties: false
      properties:
        service:
          $ref: '#/components/schemas/service_name'
        methods:
          description: Список статистик по использованию методов указанного сервиса.
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/method_statistics'
      required:
      - service
      - methods
    date_statistics:
      description: Статистика за определенную дату.
      type: object
      additionalProperties: false
      properties:
        date:
          description: Дата в формате YYYY-MM-DD.
          type: string
          format: date
          example: '2024-02-05'
        services:
          description: Список статистик по каждому сервису на указанную дату.
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/service_statistics'
      required:
      - date
      - services
    user_statistics:
      description: Статистика по использованию сервисов конкретным пользователем.
      type: object
      additionalProperties: false
      properties:
        username:
          $ref: '#/components/schemas/user_name'
        dates:
          description: Список статистик по каждому дню для указанного пользователя.
          type: array
          minItems: 0
          maxItems: 3653
          items:
            $ref: '#/components/schemas/date_statistics'
      required:
      - username
      - dates
    file_xlsx:
      description: Файл с данными в формате [XLSX](https://ru.wikipedia.org/wiki/Microsoft_Excel).
      type: string
      format: byte
    method_quota:
      description: 'Квота на группу методов сервиса.  При превышении любой из квот
        запрос не возвращается с ошибкой превышения квоты.

        '
      type: object
      additionalProperties: false
      properties:
        method_group:
          $ref: '#/components/schemas/method_group'
        points_per_request:
          description: Максимальное количество неуникальных точек на один запрос.
          type: integer
          format: int32
          minimum: 0
          maximum: 1000000
          example: 15
        points_per_day:
          description: Максимальное количество неуникальных точек на один запрос в
            сутки.
          type: integer
          format: int32
          minimum: 0
          maximum: 100000000
          example: 1500
        points_per_date_window:
          description: 'Максимальное суммарное количество неуникальных точек за указанный
            временной период, кратный суткам. Если временной период равен суткам -
            то параметр не учитывается , так как за одни сутки отвечает points_per_day.

            '
          type: integer
          format: int32
          nullable: true
          default: null
          minimum: 0
          maximum: 100000000
          example: 1500
        max_concurrent_execution:
          description: 'Максимальное количество одновременных запусков.  Если не указано
            или null - ограничение не учитывается.

            '
          type: integer
          format: int32
          nullable: true
          default: null
          minimum: 0
          maximum: 1000
          example: 5
      required:
      - method_group
      - points_per_request
      - points_per_day
    service_quota:
      description: Квота на сервис.
      type: object
      additionalProperties: false
      properties:
        service:
          $ref: '#/components/schemas/service_name'
        methods:
          description: Список квот на группу методов.
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/method_quota'
      required:
      - service
      - methods
    quota_base:
      description: Квота на все сервисы.
      type: object
      additionalProperties: false
      properties:
        services:
          description: Список квот на сервисы.
          type: array
          uniqueItems: true
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/service_quota'
      required:
      - services
    quotas_result:
      description: Результат запроса на квоты.
      type: object
      additionalProperties: false
      properties:
        base:
          $ref: '#/components/schemas/quota_base'
      required:
      - base
    time_duration:
      description: 'Продолжительность временного отрезка в формате [ISO 8601 duration](https://ru.wikipedia.org/wiki/ISO_8601#Durations).

        '
      type: string
      format: duration
      x-custom-format: duration
      pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$
      minLength: 3
      maxLength: 16
      default: PT0S
      example: P1Y1M1DT2H12M34.3S
    audit_action_statistics:
      description: 'Детальная статистика по действию пользователя.

        '
      type: object
      additionalProperties: false
      properties:
        points_count:
          description: Количество неуникальных точек в запросе (применимо только к
            запросам, которые содержат точки).
          type: integer
          format: int32
          minimum: 0
          maximum: 10000000
          default: 0
          example: 1500
        duration:
          description: Длительность выполнения операции - не включает время обмена
            данными с сервером.
          $ref: '#/components/schemas/time_duration'
    audit_action:
      description: Действие пользователя.
      type: object
      additionalProperties: false
      properties:
        username:
          $ref: '#/components/schemas/user_name'
        company_key:
          $ref: '#/components/schemas/company_key'
        tracedata:
          $ref: '#/components/schemas/tracedata'
        method_group:
          $ref: '#/components/schemas/method_group'
        statistics:
          $ref: '#/components/schemas/audit_action_statistics'
      required:
      - username
      - company_key
      - tracedata
      - method_group
      - statistics
    audit_stats_detail:
      description: Детальная статистика по списку записей.
      type: object
      additionalProperties: false
      properties:
        total:
          description: Количество записей.
          type: integer
          format: int32
          minimum: 0
          maximum: 100000000
          example: 1
      required:
      - total
    audit_stats:
      description: Статистика по списку записей.
      type: object
      additionalProperties: false
      properties:
        overall:
          $ref: '#/components/schemas/audit_stats_detail'
        filter:
          $ref: '#/components/schemas/audit_stats_detail'
      required:
      - overall
      - filter
    account_audit_result:
      description: Результат запроса действий по пользователю.
      type: object
      additionalProperties: false
      properties:
        actions:
          description: Список пользовательских действий.
          type: array
          uniqueItems: false
          minItems: 0
          maxItems: 10000000
          items:
            $ref: '#/components/schemas/audit_action'
        statistics:
          $ref: '#/components/schemas/audit_stats'
      required:
      - actions
      - statistics
    flow_type:
      description: Тип потока обработки данных.
      type: string
      enum:
      - INPUT
      - OUTPUT
      default: INPUT
      example: OUTPUT
    flow_convert:
      description: Конвертация возвращаемых данных в указанный формат.
      type: string
      deprecated: true
      enum:
      - ORIGIN
      - JSON
      - XLSX
      default: ORIGIN
      example: JSON
    check_result:
      description: Результат проверки работоспособности сервиса.
      type: object
      additionalProperties: false
      properties:
        health:
          description: "Текущий показатель здоровья сервиса.      \n0 означает неготовность\
            \ сервиса выполнять задачи.      \n1 означает полную готовность сервиса\
            \ для выполнения задач.\n"
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.999
      required:
      - health
    version_result:
      description: Версия сервиса.
      type: object
      additionalProperties: false
      properties:
        major:
          description: "Версия продукта.\nВ рамках одной версии гарантируется совместимость\
            \ общих структур данных между сервисами.     \nИзменение версии указывает\
            \ на несовместимые с предыдущими версиями продукта (и, соответственно,\
            \ всех сервисов) изменения.\n"
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          example: 4
        minor:
          description: 'Минорная версия сервиса.

            Изменение версии указывает на новую функциональность.

            Обновление имеет обратную совместимость в рамках мажорной версии сервиса.

            '
          type: integer
          format: int32
          minimum: 0
          maximum: 111
          example: 4
        build:
          description: "Версия сборки.       \nИзменяется при обновлении документации\
            \ и исправлении ошибок.\n"
          type: string
          minLength: 1
          maxLength: 64
          example: 1754RC
      required:
      - major
      - minor
      - build
    file_html:
      description: Файл с данными в формате [HTML](https://html.spec.whatwg.org/).
      type: string
    file_json:
      description: Файл с данными в формате [JSON](https://www.json.org/).
      type: string
  responses:
    '400':
      description: 'Неверный запрос - входные данные содержат ошибки

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_400'
    '401':
      description: 'Ошибка доступа - токен отсутствует или невалиден

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_401'
    '402':
      description: Необходима оплата
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_402'
    '403':
      description: 'Действие запрещено - уровень прав доступа не позволяет совершить
        данное действие

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_403'
    '404':
      description: Запрашиваемая сущность не найдена
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_404'
    '405':
      description: 'Метод запрещен для данного ресурса, проверьте указанный метод
        (POST, GET, ...)

        '
    '406':
      description: 'Клиент не способен обработать формат ответа, проверьте заголовки

        '
    '415':
      description: 'Неприемлемый формат запроса, проверьте заголовки

        '
    '429':
      description: Превышено количество запросов
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_429'
    '500':
      description: Внутренняя ошибка сервера
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_500'
    '501':
      description: Функциональность не доступна для использования
    '502':
      description: Неверный шлюз
    '503':
      description: Сервис не доступен
    '504':
      description: Шлюз не отвечает
  parameters:
    date_from:
      name: from
      description: Дата в формате YYYY-MM-DD, начиная с которой будет производится
        выгрузка данных.
      in: query
      required: false
      schema:
        description: Дата в формате YYYY-MM-DD, начиная с которой будет производится
          выгрузка данных.
        type: string
        format: date
        example: '2024-02-22'
    date_to:
      name: to
      description: Дата в формате YYYY-MM-DD, по которую включительно будет производится
        выгрузка данных.
      in: query
      required: false
      schema:
        description: Дата в формате YYYY-MM-DD, по которую включительно будет производится
          выгрузка данных.
        type: string
        format: date
        example: '2024-02-22'
    offset:
      name: offset
      description: Количество пропущенных сущностей до возвращаемого списка.
      in: query
      schema:
        description: Количество пропущенных сущностей до возвращаемого списка.
        type: integer
        format: int32
        minimum: 0
        maximum: 10000000
        default: 0
        example: 10
      required: false
    limit:
      name: limit
      description: Максимальное количество возвращаемых сущностей.
      in: query
      schema:
        description: Максимальное количество возвращаемых сущностей.
        type: integer
        format: int32
        minimum: 1
        maximum: 10000000
        default: 100
        example: 10
      required: false
    datetime_from:
      name: from
      description: 'Дата и время в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6),
        начиная с которого (включительно) будет производится выгрузка данных. Если
        не указано - возвращаются данные с начала текущего дня.

        '
      in: query
      required: false
      schema:
        description: 'Дата и время в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6),
          начиная с которого (включительно) будет производится выгрузка данных. Если
          не указано - возвращаются данные с начала текущего дня.

          '
        type: string
        format: date-time
        example: '2024-02-21T09:30:00+03:00'
    datetime_to:
      name: to
      description: 'Дата и время в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6),
        до которого (включительно) будет производится выгрузка данных. Если не указано
        - возвращаются данные до текущего времени.

        '
      in: query
      required: false
      schema:
        description: 'Дата и время в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6),
          до которого (включительно) будет производится выгрузка данных. Если не указано
          - возвращаются данные до текущего времени.

          '
        type: string
        format: date-time
        example: '2024-02-21T18:00:00+03:00'
    sort_field:
      name: sort_field
      description: Поле, по которому необходимо делать сортировку.
      in: query
      required: false
      schema:
        description: Поле, по которому необходимо делать сортировку.
        type: string
        minLength: 1
        maxLength: 64
        example: name
    sort_direction:
      name: sort_direction
      description: Направление сортировки.
      in: query
      required: false
      schema:
        description: Направление сортировки.
        type: string
        nullable: false
        enum:
        - ASC
        - DESC
        default: ASC
        example: DESC
    tracecode:
      name: tracecode
      description: Уникальный идентификатор процесса.
      in: path
      required: true
      schema:
        description: Уникальный идентификатор процесса.
        type: string
        format: uuid
        example: 11111111-2222-3333-4444-555555555555
    data_flow_type:
      name: data_flow_type
      description: Тип потока обработки данных.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/flow_type'
    data_flow_stage:
      name: data_flow_stage
      description: Этап потока обработки данных.
      in: query
      required: false
      schema:
        description: "Этап потока обработки данных:\n  * `0` - сырые данные, полученные\
          \ от клиента или отправленные клиенту\n  * `1` - данные во внутреннем представлением\n\
          \  * `2` - данные, отправленные в сторонние сервисы\n  * `3` - резерв\n"
        type: integer
        format: int32
        minimum: 0
        maximum: 3
        default: 0
        example: 1
    data_flow_convert:
      name: data_flow_convert
      description: Конвертация возвращаемых данных.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/flow_convert'
    filename:
      name: filename
      description: Название файла.
      in: path
      required: true
      schema:
        description: Название файла.
        type: string
        minLength: 6
        maxLength: 128
        example: file_en.html