Chaitin Tech report/task/{task_id} API

报表中心/任务/task_id 参数

OpenAPI Specification

chaitin-report-task-task-id-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: APISec Management account report/task/{task_id} API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: report/task/{task_id}
  description: 报表中心/任务/task_id 参数
paths:
  /report/task/{task_id}:
    post:
      summary: 报表订阅更新
      deprecated: false
      description: ''
      tags:
      - report/task/{task_id}
      parameters:
      - name: task_id
        in: path
        description: ''
        required: true
        example: string
        schema:
          type: string
      - name: X-CS-Header-App
        in: header
        description: 应用id
        required: true
        example: '{{app}}'
        schema:
          type: string
      - name: X-CS-Header-Company
        in: header
        description: 公司id
        required: true
        example: '{{company_id}}'
        schema:
          type: string
      - name: X-CS-Header-Crypt
        in: header
        description: 加密算法,请参考:https://servaltech.feishu.cn/docs/doccnQCZ2cw32uazgNSO0DFwceb
        required: true
        example: ''
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 对于支持「ETAG」的接口,将上一次请求的响应header的Etag,填入到下一次请求。若匹配,则返回304(无变更),否则会返回新版本的数据 + 新Etag
        required: true
        example: string
        schema:
          type: string
      - name: X-CS-Header-Debug
        in: header
        description: ''
        required: true
        example: '{{debug}}'
        schema:
          type: string
      - name: Accept-Language
        in: header
        description: ''
        required: true
        example: zh
        schema:
          type: string
      - name: X-Cs-Header-Timezone
        in: header
        description: ''
        required: true
        example: Asia/Shanghai
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Accept
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                dashboard_id:
                  type: string
                period_options:
                  type: object
                  properties:
                    hour:
                      type: integer
                    minute:
                      type: integer
                    period_category:
                      type: string
                    day:
                      type: 'null'
                    weekday:
                      type: 'null'
                  required:
                  - hour
                  - minute
                  - period_category
                  - day
                  - weekday
                send_channel:
                  type: string
                notification_bot_ids:
                  type: array
                  items:
                    type: string
                email_topic:
                  type: string
                append_time:
                  type: boolean
                email_receivers:
                  type: array
                  items:
                    type: string
                send_options:
                  type: object
                  properties:
                    send_text:
                      type: boolean
                    content:
                      type: string
                  required:
                  - send_text
                  - content
                period_category:
                  type: string
              required:
              - name
              - dashboard_id
              - period_options
              - send_channel
              - notification_bot_ids
              - email_topic
              - append_time
              - email_receivers
              - send_options
              - period_category
            example:
              name: 旺测试
              dashboard_id: 6ce2041a-351c-40e4-8c50-2d6142750d30
              period_options:
                hour: 17
                minute: 30
                period_category: day
                day: null
                weekday: null
              send_channel: email
              notification_bot_ids:
              - 572f41b8-c72c-426c-b7f0-346a263a4b41
              email_topic: 报告订阅测试
              append_time: true
              email_receivers:
              - xingwang.xu@cyberserval.cn
              send_options:
                send_text: true
                content: 这是由{{system_name}}定时发送的{{dashboard_name}},查看更多内容可点击{{url}}
              period_category: day
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
              example: {}
      security: []