openapi: 3.0.3
info:
  title: VRt.Account [AC]
  version: 6.20.2289
  license:
    name: Proprietary
    url: https://veeroute.zh/
  termsOfService: https://veeroute.zh/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: '# Description


    Veeroute Account Panel.


    ## Entity relationship diagram


    ![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: 'User data.

    '
- name: Quotas
  description: 'Quotas.

    '
- name: System
  description: '系统功能。

    所有服务共有的辅助功能。

    '
externalDocs:
  description: 主站点
  url: https://veeroute.zh/
paths:
  /account/token/generation:
    post:
      tags:
      - Auth
      summary: Obtaining a token
      description: Obtaining a token using the login and password.
      operationId: run_token_generation
      security: []
      requestBody:
        description: Token request.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/token_request'
      responses:
        '200':
          description: Successful execution
          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: Validating a token
      description: Validating a token.
      operationId: run_token_validation
      security: []
      requestBody:
        description: Token validate request.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/token'
      responses:
        '200':
          description: Successful execution
          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: Change password
      description: Change password and get new token.
      operationId: change_password
      requestBody:
        description: Password change request data.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/password_request'
      responses:
        '200':
          description: Successful execution
          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: Account information
      description: Getting a account information.
      operationId: read_info
      responses:
        '200':
          description: Successful execution
          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: Account update
      description: Updating the account information.
      operationId: update_info
      requestBody:
        description: Account update request.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account_info'
      responses:
        '200':
          description: Successful execution
          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: Statistics for the period
      description: 'User statistics for the period. If the period is not specified,
        the statistics for the current month returns (from the beginning of the month
        to the present day). If no ''from'' datetime is specified, data are returned
        from the beginning of the month. If no ''to'' datetime is specified, data
        are returned be to the present day (excluding).

        '
      operationId: generate_statistics
      parameters:
      - $ref: '#/components/parameters/date_from'
      - $ref: '#/components/parameters/date_to'
      responses:
        '200':
          description: Successful execution
          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: Report creating
      description: 'Creating report with usage statistics. If the period is not specified,
        records are returned from the beginning of the month to the present day (excluding).
        If no ''from'' datetime is specified, data are returned from the beginning
        of the month. If no ''to'' datetime is specified, data are returned be the
        the present day (excluding).

        '
      operationId: read_report
      parameters:
      - $ref: '#/components/parameters/date_from'
      - $ref: '#/components/parameters/date_to'
      responses:
        '200':
          description: Successful execution
          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: Obtaining the quotas
      description: Obtaining the quotas for the user.
      operationId: read_quota
      responses:
        '200':
          description: Successful execution
          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: Actions for the period
      description: 'User actions for the period.  If the period is not specified,
        records for the current day are returned from the beginning of the day to
        the current time. If no ''from'' datetime is specified, audit data are returned
        from the beginning of the day. If no ''to'' datetime is specified, audit data
        are returned be the end of the current day.

        '
      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: Service name.
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/service_name'
      - name: operation_id
        description: Operation identifier.
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/operation_id'
      - name: method_group
        description: Method group name.
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/method_group'
      - $ref: '#/components/parameters/sort_field'
      - $ref: '#/components/parameters/sort_direction'
      responses:
        '200':
          description: Successful execution
          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: Reading data
      description: Receiving data by `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: Successful execution
          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: Successful execution
          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: Successful execution
          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: Successful execution
          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)

        [JWT 令牌](https://en.wikipedia.org/wiki/JSON_Web_Token) 被使用，

        必须在每个请求的标头中以以下格式指定：


        `授权：承载 <token>`。


        Token 可以通过 VRt.Account API 获取。

        '
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    user_name:
      description: Login, unique identifier.
      type: string
      pattern: \w+
      minLength: 2
      maxLength: 256
      example: my_username_for_login
    token_request:
      description: Token obtaining data.
      type: object
      additionalProperties: false
      properties:
        username:
          $ref: '#/components/schemas/user_name'
        password:
          description: Password.
          type: string
          minLength: 1
          maxLength: 1000
          example: password
          writeOnly: true
        ttl_seconds:
          description: Token validity time, in seconds.
          type: integer
          format: int32
          minimum: 60
          maximum: 31556926
          example: 86400
          default: 86400
      required:
      - username
      - password
    token:
      description: Token.
      type: string
      minLength: 1
      maxLength: 1000
      example: jwt
    service_name:
      description: Service name.
      type: string
      enum:
      - UNIVERSAL
      - ROUTING
      - ACCOUNT
      - ADMIN
      - STUDIO
      - MONITOR
      - PACKER
      - AGRO
      - STOCK
      - LONGHAUL
      - CLUSTER
      - CARGOTIMETABLE
      example: UNIVERSAL
    operation_id:
      description: Operation identifier.
      type: string
      minLength: 3
      maxLength: 256
      example: run_plan_calculation
    tracedata:
      description: Data for request tracing.
      type: object
      additionalProperties: false
      properties:
        code:
          description: 'Unique process identifier. If an asynchronous process is running,
            then the code for it will be the same, although other fields may differ.

            '
          type: string
          format: uuid
          example: 11111111-2222-3333-4444-555555555555
        client:
          description: 'The unique identifier of the client (`company_key` + `_|_`
            + `username`) that made the request.

            '
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: company_|_username
        server:
          description: Server identifier.
          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: Date and time service method run in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format.
          type: string
          format: date-time
          example: '2024-02-21T09:30:00+03:00'
      required:
      - code
      - client
      - server
      - service
      - operation
      - time
    general_400:
      description: 400 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Bad Request
      required:
      - tracedata
    general_401:
      description: 401 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Unauthorized
      required:
      - tracedata
    general_402:
      description: 402 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Payment Required
      required:
      - tracedata
    general_403:
      description: 403 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Forbidden
      required:
      - tracedata
    general_404:
      description: 404 Error details.
      type: object
      additionalProperties: false
      properties:
        resource_id:
          description: Resource identifier.
          type: string
          nullable: true
          default: null
          example: resource_id
        detail:
          description: Resource details.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            tracedata:
              $ref: '#/components/schemas/tracedata'
          required:
          - tracedata
    general_429:
      description: 429 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Too many requests
      required:
      - tracedata
    general_500:
      description: 500 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Internal Server Error
      required:
      - tracedata
    user_role:
      description: Role.
      type: string
      enum:
      - ADMIN
      - PARTNER
      - USER
      - BOT
      example: USER
    user_roles:
      description: List of user roles.
      type: array
      uniqueItems: true
      minItems: 0
      maxItems: 2
      default: []
      items:
        $ref: '#/components/schemas/user_role'
    token_validation_result:
      description: Token validation result.
      type: object
      additionalProperties: false
      properties:
        valid:
          description: Token status.
          type: boolean
          example: true
          default: false
        roles:
          $ref: '#/components/schemas/user_roles'
      required:
      - valid
    password_request:
      description: Password change data.
      type: object
      additionalProperties: false
      properties:
        current_password:
          description: Current Password.
          type: string
          minLength: 1
          maxLength: 1000
          example: password
          writeOnly: true
        new_password:
          description: New Password.
          type: string
          minLength: 1
          maxLength: 1000
          example: password
          writeOnly: true
      required:
      - current_password
      - new_password
    company_key:
      description: Company key.
      type: string
      pattern: \w+
      minLength: 3
      maxLength: 256
      example: my_company
    account_info:
      description: User information.
      type: object
      additionalProperties: false
      properties:
        username:
          $ref: '#/components/schemas/user_name'
        name:
          description: Full name of user.
          type: string
          nullable: true
          default: null
          minLength: 2
          maxLength: 256
          example: my_visible_name
        email:
          description: User mail address.
          type: string
          format: email
          nullable: true
          default: null
          minLength: 5
          maxLength: 256
          example: admin@company.com
        phone:
          description: User phone.
          type: string
          nullable: true
          default: null
          minLength: 5
          maxLength: 32
          example: '+71112223333'
        company_key:
          $ref: '#/components/schemas/company_key'
        timezone:
          description: Basic time zone used for statistics.
          type: integer
          format: int32
          minimum: -12
          maximum: 12
          default: 0
          example: 3
      required:
      - username
      - company_key
    method_group:
      description: 'Method group name. Uniqueness of points is considered within one
        group.

        '
      type: string
      enum:
      - NOTRACE
      - TRACE
      - PLAN
      - ACTUALIZE
      - REFINE
      - CONVERT
      - ANALYTICS
      - PREDICT
      - VALIDATE
      - ROUTE
      - MATRIX
      - PACK
      example: PLAN
    method_statistics:
      description: Usage statistics of the service method.
      type: object
      additionalProperties: false
      properties:
        method_group:
          $ref: '#/components/schemas/method_group'
        unique_points_per_day:
          description: Unique points per day.
          type: integer
          format: int32
          minimum: 0
          maximum: 10000000
          example: 1500
        points_per_day:
          description: Non-unique points per day.
          type: integer
          format: int32
          minimum: 0
          maximum: 10000000
          example: 1500
      required:
      - method_group
      - unique_points_per_day
      - points_per_day
    service_statistics:
      description: Usage statistics of all service methods.
      type: object
      additionalProperties: false
      properties:
        service:
          $ref: '#/components/schemas/service_name'
        methods:
          description: Usage statistics list of the specified service methods.
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/method_statistics'
      required:
      - service
      - methods
    date_statistics:
      description: Statistics for the specific date.
      type: object
      additionalProperties: false
      properties:
        date:
          description: Date in the YYYY-MM-DD format.
          type: string
          format: date
          example: '2024-02-05'
        services:
          description: Statistics list for each service on the specified date.
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/service_statistics'
      required:
      - date
      - services
    user_statistics:
      description: Usage service statistics by the specific user.
      type: object
      additionalProperties: false
      properties:
        username:
          $ref: '#/components/schemas/user_name'
        dates:
          description: Statistics list for each day for the specified user.
          type: array
          minItems: 0
          maxItems: 3653
          items:
            $ref: '#/components/schemas/date_statistics'
      required:
      - username
      - dates
    file_xlsx:
      description: File with data in [XLSX](https://en.wikipedia.org/wiki/Microsoft_Excel)
        format.
      type: string
      format: byte
    method_quota:
      description: 'Quota for the service method group.  If any of the quotas are
        exceeded, the request is not returned with the quota exceeded error.

        '
      type: object
      additionalProperties: false
      properties:
        method_group:
          $ref: '#/components/schemas/method_group'
        points_per_request:
          description: Maximum number of non-unique points per request.
          type: integer
          format: int32
          minimum: 0
          maximum: 1000000
          example: 15
        points_per_day:
          description: Maximum number of non-unique points per request per day.
          type: integer
          format: int32
          minimum: 0
          maximum: 100000000
          example: 1500
        points_per_date_window:
          description: "The maximum total number of non-unique points for the specified\
            \ time period, multiple of a day. If the time period equals to a day,\
            \ this parameter is not taken into account, since it is responsible for\
            \ one day   \n"
          type: integer
          format: int32
          nullable: true
          default: null
          minimum: 0
          maximum: 100000000
          example: 1500
        max_concurrent_execution:
          description: 'The maximum total number of concurrent method execution.

            '
          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: Service quota.
      type: object
      additionalProperties: false
      properties:
        service:
          $ref: '#/components/schemas/service_name'
        methods:
          description: List of quotas for a group of methods.
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/method_quota'
      required:
      - service
      - methods
    quota_base:
      description: All services quota.
      type: object
      additionalProperties: false
      properties:
        services:
          description: All services quota list.
          type: array
          uniqueItems: true
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/service_quota'
      required:
      - services
    quotas_result:
      description: Quota request result.
      type: object
      additionalProperties: false
      properties:
        base:
          $ref: '#/components/schemas/quota_base'
      required:
      - base
    time_duration:
      description: 'Time duration according to [ISO 8601 duration](https://en.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: 'Detail user action statistics.

        '
      type: object
      additionalProperties: false
      properties:
        points_count:
          description: Non-unique points per request.
          type: integer
          format: int32
          minimum: 0
          maximum: 10000000
          default: 0
          example: 1500
        duration:
          description: The duration of the operation - does not include the time of
            data exchange with the server.
          $ref: '#/components/schemas/time_duration'
    audit_action:
      description: User action.
      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: Detail statistics by records list.
      type: object
      additionalProperties: false
      properties:
        total:
          description: Count of records.
          type: integer
          format: int32
          minimum: 0
          maximum: 100000000
          example: 1
      required:
      - total
    audit_stats:
      description: Statistics by records list.
      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: User actions request result.
      type: object
      additionalProperties: false
      properties:
        actions:
          description: User actions list.
          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: Data flow type.
      type: string
      enum:
      - INPUT
      - OUTPUT
      default: INPUT
      example: OUTPUT
    flow_convert:
      description: Data result convert.
      type: string
      deprecated: true
      enum:
      - ORIGIN
      - JSON
      - XLSX
      default: ORIGIN
      example: JSON
    check_result:
      description: Service availability result.
      type: object
      additionalProperties: false
      properties:
        health:
          description: 'Current health.

            '
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.999
      required:
      - health
    version_result:
      description: 服务版本。
      type: object
      additionalProperties: false
      properties:
        major:
          description: '产品版本。

            在单个版本中，保证了服务之间通用数据结构的兼容性。

            版本更改表示与以前版本的产品（和所有服务）不兼容的更改。

            '
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          example: 4
        minor:
          description: '服务的小版本。

            版本更改表示新功能。

            该更新向后兼容服务的主要版本。

            '
          type: integer
          format: int32
          minimum: 0
          maximum: 111
          example: 4
        build:
          description: '构建版本。

            包含向后兼容的错误修复和文档更新。

            '
          type: string
          minLength: 1
          maxLength: 64
          example: 1754RC
      required:
      - major
      - minor
      - build
    file_html:
      description: File with data in [HTML](https://html.spec.whatwg.org/) format.
      type: string
    file_json:
      description: File with data in [JSON](https://www.json.org/) format.
      type: string
  responses:
    '400':
      description: 'Bad request - input data contains errors

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_400'
    '401':
      description: 'Unauthorized - token missing or invalid

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_401'
    '402':
      description: Payment Required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_402'
    '403':
      description: 'Forbidden - no permission to execute this operation

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_403'
    '404':
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_404'
    '405':
      description: 'Method not allowed, check method (POST, GET, ...)

        '
    '406':
      description: 'Client is unable to process a format of response, check headers

        '
    '415':
      description: 'Unsupported media type, check headers

        '
    '429':
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_429'
    '500':
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_500'
    '501':
      description: Not implemented
    '502':
      description: Bad gateway
    '503':
      description: Service unavailable
    '504':
      description: Gateway timeout
  parameters:
    date_from:
      name: from
      description: Date 'from' in the YYYY-MM-DD format.
      in: query
      required: false
      schema:
        description: Date 'from' in the YYYY-MM-DD format.
        type: string
        format: date
        example: '2024-02-22'
    date_to:
      name: to
      description: Date 'to' in the YYYY-MM-DD format.
      in: query
      required: false
      schema:
        description: Date 'to' in the YYYY-MM-DD format.
        type: string
        format: date
        example: '2024-02-22'
    offset:
      name: offset
      description: The number of items to skip before starting to collect the result
        set.
      in: query
      schema:
        description: The number of items to skip before starting to collect the result
          set.
        type: integer
        format: int32
        minimum: 0
        maximum: 10000000
        default: 0
        example: 10
      required: false
    limit:
      name: limit
      description: The number of items to return.
      in: query
      schema:
        description: The number of items to return.
        type: integer
        format: int32
        minimum: 1
        maximum: 10000000
        default: 100
        example: 10
      required: false
    datetime_from:
      name: from
      description: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
        format. If no datetime is specified, audit data are returned from the beginning
        of the day.

        '
      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: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
        format. If not specified, data up to the current time is returned.

        '
      in: query
      required: false
      schema:
        description: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
          format. If not specified, data up to the current time is returned.

          '
        type: string
        format: date-time
        example: '2024-02-21T18:00:00+03:00'
    sort_field:
      name: sort_field
      description: Field to sort by.
      in: query
      required: false
      schema:
        description: Field to sort by.
        type: string
        minLength: 1
        maxLength: 64
        example: name
    sort_direction:
      name: sort_direction
      description: Sort direction.
      in: query
      required: false
      schema:
        description: Sort direction.
        type: string
        nullable: false
        enum:
        - ASC
        - DESC
        default: ASC
        example: DESC
    tracecode:
      name: tracecode
      description: Unique process identifier.
      in: path
      required: true
      schema:
        description: Unique process identifier.
        type: string
        format: uuid
        example: 11111111-2222-3333-4444-555555555555
    data_flow_type:
      name: data_flow_type
      description: Data flow type.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/flow_type'
    data_flow_stage:
      name: data_flow_stage
      description: Data flow stage.
      in: query
      required: false
      schema:
        description: Data flow stage.
        type: integer
        format: int32
        minimum: 0
        maximum: 3
        default: 0
        example: 1
    data_flow_convert:
      name: data_flow_convert
      description: Data result convert.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/flow_convert'
    filename:
      name: filename
      description: File name.
      in: path
      required: true
      schema:
        description: File name.
        type: string
        minLength: 6
        maxLength: 128
        example: file_en.html