Rotageek Audits API

openapi: 3.2.0
info:
  title: Rotageek API v1 Audits API
  description: Hello World!
  contact:
    name: Rotageek
    email: office@rotageek.com
  version: '1.0'
security:
- Bearer: []
tags:
- name: Audits
paths:
  /api/v1/audits/{entityType}/{entityId}:
    get:
      tags:
      - Audits
      summary: Retrieve paginated audit logs for an entity
      operationId: Audits_GetAuditTrail
      parameters:
      - name: entityType
        in: path
        description: Type of entity being queried
        required: true
        schema:
          $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.AuditEntityRootType'
      - name: entityId
        in: path
        description: External identifier of the entity
        required: true
        schema:
          type: string
      - name: Sort
        in: query
        description: 'Sorting field for results. Default: CreatedDate'
        schema:
          $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.AuditLogSortField'
      - name: StartDate
        in: query
        description: Start of the timestamp filter range (UTC). When provided, only audit logs on or after this value are returned.
        schema:
          type: string
          format: date-time
      - name: EndDate
        in: query
        description: End of the timestamp filter range (UTC). When provided, only audit logs on or before this value are returned.
        schema:
          type: string
          format: date-time
      - name: Page
        in: query
        description: 'Zero based page number. Default: 0'
        schema:
          maximum: 32767
          minimum: 0
          type: integer
          format: int32
      - name: PageSize
        in: query
        description: 'Number of records per page (1-50). Default: 30'
        schema:
          maximum: 50
          minimum: 1
          type: integer
          format: int32
      - name: Order
        in: query
        description: 'Sorting order. Default: Ascending'
        schema:
          $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.SortOrder'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.ListWrapperModel_1__Rotageek.AspNetCore.PublicApi.Models.v1.AuditLogResponseModel__Rotageek.AspNetCore.PublicApi__Version_2026.10.9.7962__Culture_neutral__PublicKeyToken_null'
            application/json:
              schema:
                $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.ListWrapperModel_1__Rotageek.AspNetCore.PublicApi.Models.v1.AuditLogResponseModel__Rotageek.AspNetCore.PublicApi__Version_2026.10.9.7962__Culture_neutral__PublicKeyToken_null'
            text/json:
              schema:
                $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.ListWrapperModel_1__Rotageek.AspNetCore.PublicApi.Models.v1.AuditLogResponseModel__Rotageek.AspNetCore.PublicApi__Version_2026.10.9.7962__Culture_neutral__PublicKeyToken_null'
components:
  schemas:
    Rotageek.AspNetCore.PublicApi.Models.AuditAction:
      enum:
      - Created
      - Updated
      - Deleted
      - Initialized
      type: string
      description: Describes the type of action recorded in an audit log
    Rotageek.AspNetCore.PublicApi.Models.PaginationModel:
      type: object
      properties:
        pageNumber:
          type: integer
          description: Current number of the requested page (zero based)
          format: int32
        pageSizeRequested:
          type: integer
          description: Number of items that were requested
          format: int32
        itemsCount:
          type: integer
          description: Number of items fetched
          format: int32
        hasMore:
          type: boolean
          description: Flag informing that there are more records then was fetched with this request
      additionalProperties: false
      description: Container object for pagination information
    Rotageek.AspNetCore.PublicApi.Models.SortOrder:
      enum:
      - Ascending
      - Descending
      type: string
      description: Describes items sort order
    Rotageek.AspNetCore.PublicApi.Models.AuditEntitySubType:
      enum:
      - User
      - UserAnnualLeaveCarriedOver
      - UserConfigurableField
      - UserContractedHours
      - UserContractType
      - UserLeaveAllowance
      - UserLeaveTypeAllowance
      - UserLocation
      - UserPayRate
      - UserPosition
      - UserPrimaryLocation
      - UserReadOnlyLocation
      - UserSkill
      - UserTermTime
      - UserVisa
      - UserWorkingDay
      type: string
    Rotageek.AspNetCore.PublicApi.Models.v1.AuditLogResponseModel:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the audit log
          format: uuid
        timestampUtc:
          type: string
          description: Timestamp of the audit entry (UTC)
          format: date-time
        action:
          $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.AuditAction'
        entityId:
          type:
          - string
          - 'null'
          description: Identifier of the entity affected
        entityType:
          $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.AuditEntitySubType'
        actingUserId:
          type:
          - string
          - 'null'
          description: User who performed the action
        deltas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.AuditDeltaModel'
          description: List of deltas describing the change
      additionalProperties: false
      description: "Audit log entry returned from the API\nFor example, the change is to add a new contract type to a user (effective dated)\nThe audit log response would be:\nAction: Created\nEntityId: null (user contract type has no external id) \nThe deltas would be:\nPropertyName: ContractTypeId\nOldValue: CT_7\",\nPropertyName: EffectiveFrom\nOldValue: \"2025-07-11T14:48:38.815Z\","
    Rotageek.AspNetCore.PublicApi.Models.AuditDeltaModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Name of the property changed
        oldValue:
          description: Previous value
        newValue:
          description: New value
      additionalProperties: false
      description: Details of a change captured in an audit log
    Rotageek.AspNetCore.PublicApi.Models.AuditEntityRootType:
      enum:
      - User
      type: string
      description: Supported entity types for audit trail queries
    ? Rotageek.AspNetCore.PublicApi.Models.ListWrapperModel_1__Rotageek.AspNetCore.PublicApi.Models.v1.AuditLogResponseModel__Rotageek.AspNetCore.PublicApi__Version_2026.10.9.7962__Culture_neutral__PublicKeyToken_null
    : type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.v1.AuditLogResponseModel'
          description: Collection of items returned from the request
        pagination:
          $ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.PaginationModel'
      additionalProperties: false
      description: Container for pagination information and items collection
    Rotageek.AspNetCore.PublicApi.Models.AuditLogSortField:
      enum:
      - CreatedDateUtc
      type: string
      description: Fields that audit logs can be ordered by
  securitySchemes:
    Bearer:
      type: http
      description: Paste the JWT access token returned by POST /api/v1/auth. Swagger adds the 'Bearer ' prefix automatically.
      scheme: bearer
      bearerFormat: JWT
    oauth2:
      type: oauth2
      description: OAuth2 Password Grant
      flows:
        password:
          tokenUrl: /api/v1/auth
          scopes: {}