Small Improvements audit-record-resource API

Audit Record Resource

OpenAPI Specification

small-improvements-audit-record-resource-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: The Small Improvements REST API (v2) provides programmatic access to the core performance management platform, covering users, feedback cycles, review questionnaires, objectives, 1:1 meetings, pulse surveys, praise, messages, and administrative settings. Authentication uses personal Bearer access tokens generated from user profile settings.
  version: '2.0'
  title: Small Improvements action-item-resource audit-record-resource API
  contact:
    url: https://www.small-improvements.com
    name: Small Improvements
  x-api-id: small-improvements-rest-api
servers:
- url: https://app.small-improvements.com/api
  description: Small Improvements API
security:
- BearerAuth: []
tags:
- name: audit-record-resource
  description: Audit Record Resource
paths:
  /v2/audit-record:
    post:
      tags:
      - audit-record-resource
      summary: getLogs
      operationId: getLogsUsingPOST
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/AuditRecordQuery'
        description: query
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/CursorResultList_AuditRecordMediumDto_'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v2/audit-record/categories:
    get:
      tags:
      - audit-record-resource
      summary: getCategories
      operationId: getCategoriesUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int32
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v2/audit-record/types:
    get:
      tags:
      - audit-record-resource
      summary: getTypes
      operationId: getTypesUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int32
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v2/audit-record/{id}:
    get:
      tags:
      - audit-record-resource
      summary: getLog
      operationId: getLogUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AuditRecordDto'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    AuditRecordDto:
      type: object
      title: AuditRecordDto
    AuditRecordQuery:
      type: object
      title: AuditRecordQuery
    CursorResultList_AuditRecordMediumDto_:
      type: object
      title: CursorResultList«AuditRecordMediumDto»
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Personal access token generated from user profile settings