> ## Documentation Index
> Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List a record's audit history (paginated)



## OpenAPI

````yaml GET /api/v1/internal/audit/records/{record}
openapi: 3.1.0
info:
  title: Risk Cloud API
  description: >-
    The Risk Cloud API is a collection of RESTful API endpoints that empower you
    and your team to directly integrate, automate, and build with the Risk
    Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints
    supporting exports in CSV and XSLX formats for flexible integration.


    This API documentation showcases our Risk Cloud API v1, containing a variety
    of endpoints with continued support for enabling integrations with the Risk
    Cloud.


    Visit the [LogicGate Risk Cloud Developer
    Portal](https://www.logicgate.com/developer/) to get started with building
    your custom integration with quick start guides, usage guides, release
    notes, and more. Or download the [v1 OpenAPI
    specification](/legacy-openapi.json).


    Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html)
    endpoints and documentation as well. [Risk Cloud API
    v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First
    endpoints that are tailor made for our developer users, offer concise and
    highly documented details, are supported by a [Postman
    collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc)
    and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi),
    and contain our latest API endpoint releases.
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.11.0
servers:
  - url: https://{subdomain}.logicgate.com
    description: Your Risk Cloud environment.
    variables:
      subdomain:
        description: Your Risk Cloud environment's subdomain (e.g. `qa`).
        default: your-instance
security:
  - ApiToken: []
  - basic: []
tags:
  - name: Authentication
    description: >-
      Getting Started: How to create an [API Access
      Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/)
      to begin integrating with the Risk Cloud API
  - name: Attachment
    description: Endpoints for uploading, downloading, and retrieving record attachments.
  - name: Field
    description: Endpoints for creating, updating, and querying fields.
  - name: Principal
    description: >-
      Endpoints for the authenticated principal to view and manage their own
      details.
  - name: Record Audit
    description: Endpoints for retrieving record audit history and productivity data.
  - name: Step
    description: Endpoints for retrieving steps and the steps a user can access.
  - name: Table Report
    description: Endpoints for retrieving and managing table reports.
  - name: User Group
    description: Endpoints for managing user groups and their membership.
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/
paths:
  /api/v1/internal/audit/records/{record}:
    get:
      tags:
        - Record Audit
      summary: List a record's audit history (paginated).
      operationId: getByRecord
      parameters:
        - name: record
          in: path
          description: ID of the record whose audit history is returned.
          required: true
          schema:
            type: string
        - name: pageable
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/Pageable_RecordAuditSummary'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/PageRecordAudit_RecordAuditSummary'
                  - type: array
                    items:
                      $ref: '#/components/schemas/RecordAudit_RecordAuditSummary'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse_RecordAuditSummary'
components:
  schemas:
    Pageable_RecordAuditSummary:
      type: object
      properties:
        paged:
          type: boolean
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/SortObject_RecordAuditSummary'
        unpaged:
          type: boolean
        offset:
          type: integer
          format: int64
    PageRecordAudit_RecordAuditSummary:
      type: object
      properties:
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
        first:
          type: boolean
        last:
          type: boolean
        numberOfElements:
          type: integer
          format: int32
        pageable:
          $ref: '#/components/schemas/Pageable_RecordAuditSummary'
        sort:
          $ref: '#/components/schemas/SortObject_RecordAuditSummary'
        size:
          type: integer
          format: int32
        content:
          type: array
          items:
            $ref: '#/components/schemas/RecordAudit_RecordAuditSummary'
        number:
          type: integer
          format: int32
        empty:
          type: boolean
    RecordAudit_RecordAuditSummary:
      type: object
      discriminator:
        propertyName: auditType
      oneOf:
        - $ref: '#/components/schemas/CreatedAudit_RecordAuditSummary'
        - description: >-
            And other types: CopiedAudit_RecordAuditSummary,
            DeletedAudit_RecordAuditSummary, MovedAudit_RecordAuditSummary,
            AssignedAudit_RecordAuditSummary, PreservedAudit_RecordAuditSummary,
            UnassignedAudit_RecordAuditSummary, LinkingAudit_RecordAuditSummary,
            SecondaryAssignedAudit_RecordAuditSummary,
            SecondaryUnassignedAudit_RecordAuditSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        record:
          type: string
          description: record
        source:
          $ref: '#/components/schemas/Step_RecordAuditSummary'
        target:
          $ref: '#/components/schemas/Step_RecordAuditSummary'
        user:
          $ref: '#/components/schemas/User_RecordAuditSummary'
        sourceUser:
          $ref: '#/components/schemas/User_RecordAuditSummary'
        targetUser:
          $ref: '#/components/schemas/User_RecordAuditSummary'
        fieldAudits:
          type: array
          items:
            $ref: '#/components/schemas/FieldAudit_RecordAuditSummary'
        dueDate:
          type: string
          format: date-time
        stepDueDate:
          type: string
          format: date-time
        auditType:
          type: string
      required:
        - active
        - auditType
        - created
        - dueDate
        - fieldAudits
        - id
        - record
        - source
        - sourceUser
        - stepDueDate
        - target
        - targetUser
        - updated
        - user
    AppBadRequestResponse_RecordAuditSummary:
      type: object
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          format: int32
        detail:
          type: string
        instance:
          type: string
          format: uri
        properties:
          type: object
          additionalProperties: {}
    SortObject_RecordAuditSummary:
      type: object
      properties:
        sorted:
          type: boolean
        unsorted:
          type: boolean
        empty:
          type: boolean
    CreatedAudit_RecordAuditSummary:
      allOf:
        - description: Circular reference to RecordAudit_RecordAuditSummary
      required:
        - active
        - auditType
        - created
        - dueDate
        - id
        - record
        - source
        - sourceUser
        - stepDueDate
        - target
        - targetUser
        - updated
        - user
    Step_RecordAuditSummary:
      type: object
      description: An entity to store details about a specific step within a workflow
      discriminator:
        propertyName: stepType
      oneOf:
        - $ref: '#/components/schemas/Origin_RecordAuditSummary'
        - description: >-
            And other types: Chain_RecordAuditSummary, End_RecordAuditSummary,
            Origin_RecordAuditSummary, Chain_RecordAuditSummary,
            End_RecordAuditSummary
      properties:
        stepType:
          type: string
          description: >-
            Step type. Advisory on writes. The server resolves the persisted
            step's type from the step id and ignores any client-supplied value.
          enum:
            - ORIGIN
            - CHAIN
            - END
        name:
          type: string
          description: Step name.
        description:
          type: string
          description: Description of the step.
        priority:
          type: integer
          format: int32
          description: >-
            Determines the step's place in the workflow. Priority is in
            descending order with 0 being the first step.
        userGroupOperationType:
          type: string
          description: >-
            Determine how users are able to interact with user groups on the
            step. By default, new steps will allow FULL_ACCESS user group
            editing.
          enum:
            - FULL_ACCESS
            - ADD_ONLY
            - READ_ONLY
        xpos:
          type: integer
          format: int32
          description: Vertical position of the step on the process screen.
        ypos:
          type: integer
          format: int32
          description: Horizontal position of the step on the process screen.
        isPublic:
          type: boolean
          description: >-
            Allows a step to become a public step. Public steps allow for a
            shareable public record link to be generated in the step edit
            screen. Public steps do not require any login credentials.
        commentsEnabled:
          type: boolean
          description: Allows comments to be displayed on a step.
        documentsEnabled:
          type: boolean
          description: Allows documents to be generated on a step.
        externalUserMfaRequired:
          type: boolean
          description: >-
            Whether or not to require MFA for external users to access this
            step.
        uxriEnabled:
          type: boolean
          description: Whether or not to enable UXRI on the step.
        autofillEnabled:
          type: boolean
          description: Whether or not to enable autofill on the step.
        sla:
          $ref: '#/components/schemas/ServiceLevelAgreement_RecordAuditSummary'
          description: Object containing all SLA information.
        workflow:
          $ref: '#/components/schemas/Workflow_RecordAuditSummary'
          description: Workflow that the step belongs to.
        assignableUserType:
          type: string
          description: >-
            Determine what users are able to be assigned to a record. By
            default, new records will allow APP_USERS as assignees.
          enum:
            - APP_AND_EXTERNAL_USERS
            - APP_USERS
            - EXTERNAL_USERS
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        end:
          type: boolean
        contains:
          description: Circular reference to Step_RecordAuditSummary
          writeOnly: true
        origin:
          type: boolean
        chain:
          type: boolean
      required:
        - active
        - assignableUserType
        - autofillEnabled
        - commentsEnabled
        - created
        - description
        - documentsEnabled
        - externalUserMfaRequired
        - id
        - isPublic
        - name
        - priority
        - sla
        - stepType
        - updated
        - userGroupOperationType
        - uxriEnabled
        - workflow
        - xpos
        - ypos
    User_RecordAuditSummary:
      allOf:
        - $ref: '#/components/schemas/CurrentValue_RecordAuditSummary'
        - type: object
          properties:
            email:
              type: string
            company:
              type: string
            imageUrl:
              type: string
            status:
              type: string
            tier:
              type: string
              enum:
                - PRIMARY
                - SECONDARY
                - LIMITED
            pricingUserTier:
              type: string
              enum:
                - STANDARD
                - POWER
            first:
              type: string
            last:
              type: string
            mfaEnabled:
              type: boolean
            mfaSetup:
              type: boolean
            autoprovisioned:
              type: boolean
            scimStatus:
              type: string
            automatedUser:
              type: boolean
            automatedUserFieldLabels:
              type: array
              items:
                type: string
            lastLogin:
              $ref: '#/components/schemas/AccessAudit_RecordAuditSummary'
            lastDeactivated:
              type: string
              format: date-time
            external:
              type: boolean
            disabled:
              type: boolean
            serviceAccount:
              type: boolean
            superUser:
              type: boolean
            name:
              type: string
            locked:
              type: boolean
      description: Entity for storing all information pertaining to a user.
      discriminator:
        propertyName: status
      oneOf:
        - description: Circular reference to Active_RecordAuditSummary
        - description: >-
            And other types: Automated_RecordAuditSummary,
            Disabled_RecordAuditSummary, External_RecordAuditSummary,
            Locked_RecordAuditSummary, Service_RecordAuditSummary
      properties:
        status:
          type: string
      required:
        - status
    FieldAudit_RecordAuditSummary:
      type: object
      properties:
        fieldName:
          type: string
        fieldValues:
          type: array
          items:
            type: string
        field:
          $ref: '#/components/schemas/Field_RecordAuditSummary'
        user:
          $ref: '#/components/schemas/User_RecordAuditSummary'
        record:
          $ref: '#/components/schemas/Record_RecordAuditSummary'
        executorId:
          type: string
        executorName:
          type: string
        executionType:
          type: string
          enum:
            - ANALYSIS_COMPLETE
            - AUTOMATED_CONTROLS_TESTING
            - BASICS_CREATE_ENDPOINT
            - BASICS_UPDATE_ENDPOINT
            - BUILDER_CONFIGURATION_CHANGE
            - BULK_CREATE_AND_LINK_OPERATION
            - BULK_LINK_RECORDS
            - BULK_UPDATE_FIELD_OPERATION
            - CALCULATION_UPDATE
            - DATE_CALCULATION_UPDATE
            - COPY_RECORD
            - CREATE_RECORD
            - CREATE_RECORD_JOB
            - COLLECT_EVIDENCE_JOB
            - EVIDENCE_UPLOAD
            - FORM_STACK
            - JIRA
            - PUBLIC_STEP
            - RECORD_IMPORT
            - SPARK_AI
            - SPARK_AI_AUTOFILL
            - SPARK_AI_TESTING
            - UPDATE_FIELD_JOB
            - USER_ACTION
            - WOPI
            - WORKFLOW_AGENT
            - WORKFLOW_LINK
        defaultValue:
          type: boolean
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        fieldId:
          type: string
      required:
        - active
        - created
        - defaultValue
        - executionType
        - executorId
        - executorName
        - field
        - fieldName
        - fieldValues
        - id
        - record
        - updated
        - user
    Origin_RecordAuditSummary:
      allOf:
        - description: Circular reference to Step_RecordAuditSummary
    ServiceLevelAgreement_RecordAuditSummary:
      type: object
      properties:
        enabled:
          type: boolean
        duration:
          type: integer
          format: int64
      required:
        - duration
        - enabled
    Workflow_RecordAuditSummary:
      type: object
      description: >-
        An entity that contains information about a set of steps within a
        particular application.
      discriminator:
        propertyName: workflowType
      oneOf:
        - $ref: '#/components/schemas/ControlWorkflow_RecordAuditSummary'
        - description: 'And other types: JiraWorkflow_RecordAuditSummary'
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
          description: Name of the workflow.
        description:
          type: string
          description: Description of the workflow.
          maxLength: 2000
          minLength: 0
        recordPrefix:
          type: string
          description: Name to be used for every record created from the workflow.
        allowGroups:
          type: boolean
          description: Nodes created in the workflow are allowed user groups.
        requireGroups:
          type: boolean
          description: Nodes created in the workflow require user groups.
        xpos:
          type: integer
          format: int32
          description: X axis position of the workflow on the application screen
        ypos:
          type: integer
          format: int32
          description: Y axis position of the workflow on the application screen
        priority:
          type: integer
          format: int32
          description: >-
            Determines the workflow's place in the application. Priority is in
            descending order with 0 being the first workflow.
        sla:
          $ref: '#/components/schemas/ServiceLevelAgreement_RecordAuditSummary'
          description: Object containing all SLA information.
        allowAec:
          type: boolean
          description: Enables automated evidence collection.
        allowRcsa:
          type: boolean
          description: Allow Risk & Control Self-Assessments.
        sequence:
          $ref: '#/components/schemas/WorkflowSequence_RecordAuditSummary'
        application:
          $ref: '#/components/schemas/Application_RecordAuditSummary'
          description: Application that the workflow belongs to.
        userGroups:
          type: array
          description: User groups that are allowed access to the workflow
          items:
            $ref: '#/components/schemas/UserGroup_RecordAuditSummary'
        primaryField:
          $ref: '#/components/schemas/PrimaryField_RecordAuditSummary'
        workflowType:
          type: string
          enum:
            - WORKFLOW
            - JIRA_WORKFLOW
            - CONTROL_WORKFLOW
            - ANALYSIS_WORKFLOW
        currentValueUserGroupMappings:
          type: array
          items:
            $ref: >-
              #/components/schemas/CurrentValueUserGroupMapping_RecordAuditSummary
        automatedAccessEnabled:
          type: boolean
        automatedAccessFields:
          type: array
          description: Fields that triggers automated access changes
          items:
            $ref: '#/components/schemas/Field_RecordAuditSummary'
          maxItems: 6
          minItems: 0
        automatedAccessFieldId:
          type: string
        summaryFields:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowSummaryField_RecordAuditSummary'
          maxItems: 5
          minItems: 0
        contains:
          description: Circular reference to Workflow_RecordAuditSummary
          writeOnly: true
        canSelect:
          description: Circular reference to Workflow_RecordAuditSummary
          writeOnly: true
        pluralizedRecordPrefix:
          type: string
      required:
        - active
        - allowAec
        - allowGroups
        - allowRcsa
        - application
        - automatedAccessEnabled
        - automatedAccessFieldId
        - automatedAccessFields
        - created
        - currentValueUserGroupMappings
        - description
        - id
        - name
        - primaryField
        - priority
        - recordPrefix
        - requireGroups
        - sequence
        - sla
        - summaryFields
        - updated
        - userGroups
        - workflowType
        - xpos
        - ypos
    CurrentValue_RecordAuditSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_RecordAuditSummary'
        - description: >-
            And other types: CurrentDateValue_RecordAuditSummary,
            CurrentDateRangeValue_RecordAuditSummary,
            CurrentJobValue_RecordAuditSummary,
            CurrentCommonValue_RecordAuditSummary,
            CurrentDateValue_RecordAuditSummary,
            CurrentDateRangeValue_RecordAuditSummary,
            LabelValue_RecordAuditSummary, CleanAttachment_RecordAuditSummary,
            DirtyAttachment_RecordAuditSummary,
            PendingAttachment_RecordAuditSummary,
            CurrentGoogleAttachmentValue_RecordAuditSummary,
            CurrentSharepointAttachmentValue_RecordAuditSummary,
            Active_RecordAuditSummary, Automated_RecordAuditSummary,
            Disabled_RecordAuditSummary, External_RecordAuditSummary,
            Locked_RecordAuditSummary, Service_RecordAuditSummary,
            CurrentNumericRangeValue_RecordAuditSummary,
            CurrentJobValue_RecordAuditSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        discriminator:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - created
        - discriminator
        - id
        - updated
    AccessAudit_RecordAuditSummary:
      type: object
      description: Entity used to track authentication attempts.
      discriminator:
        propertyName: accessType
      oneOf:
        - $ref: '#/components/schemas/LogIn_RecordAuditSummary'
        - description: >-
            And other types: LogOut_RecordAuditSummary,
            LogInFail_RecordAuditSummary, CredentialsRolled_RecordAuditSummary,
            TokenRolled_RecordAuditSummary, LogIn_RecordAuditSummary,
            LogOut_RecordAuditSummary, LogInFail_RecordAuditSummary,
            CredentialsRolled_RecordAuditSummary, TokenRolled_RecordAuditSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        accessType:
          type: string
      required:
        - accessType
        - active
        - created
        - id
        - updated
    Field_RecordAuditSummary:
      type: object
      description: >-
        An entity used to manage input fields used to capture record data for
        different workflows.
      discriminator:
        propertyName: fieldType
      oneOf:
        - $ref: '#/components/schemas/Text_RecordAuditSummary'
        - description: >-
            And other types: ExternalUser_RecordAuditSummary,
            ExternalId_RecordAuditSummary, TextArea_RecordAuditSummary,
            DatePicker_RecordAuditSummary, Number_RecordAuditSummary,
            ESignature_RecordAuditSummary, Checkbox_RecordAuditSummary,
            MultiSelect_RecordAuditSummary, Radio_RecordAuditSummary,
            Select_RecordAuditSummary, Attachment_RecordAuditSummary,
            User_RecordAuditSummary, Evidence_RecordAuditSummary,
            Calculation_RecordAuditSummary,
            FixedDateCalculation_RecordAuditSummary,
            LinkedRecordsCount_RecordAuditSummary, DueDate_RecordAuditSummary,
            TransientFieldDaysUntilDue_RecordAuditSummary,
            AnnualLossExposure_RecordAuditSummary, AecInfo_RecordAuditSummary,
            Text_RecordAuditSummary, ExternalUser_RecordAuditSummary,
            ExternalId_RecordAuditSummary, TextArea_RecordAuditSummary,
            DatePicker_RecordAuditSummary, Number_RecordAuditSummary,
            ESignature_RecordAuditSummary, Checkbox_RecordAuditSummary,
            MultiSelect_RecordAuditSummary, Radio_RecordAuditSummary,
            Select_RecordAuditSummary, Attachment_RecordAuditSummary,
            User_RecordAuditSummary, Evidence_RecordAuditSummary,
            Calculation_RecordAuditSummary,
            TextConcatenation_RecordAuditSummary,
            FixedDateCalculation_RecordAuditSummary,
            LinkedRecordsCount_RecordAuditSummary, DueDate_RecordAuditSummary,
            TransientFieldDaysUntilDue_RecordAuditSummary,
            AnnualLossExposure_RecordAuditSummary, AecInfo_RecordAuditSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        fieldType:
          type: string
          enum:
            - TEXT
            - EXTERNAL_USER
            - EXTERNAL_ID
            - TEXT_AREA
            - DATE_PICKER
            - NUMBER
            - E_SIGNATURE
            - CHECKBOX
            - MULTI_SELECT
            - RADIO
            - SELECT
            - USER
            - ATTACHMENT
            - CALCULATION
            - TEXT_CONCATENATION
            - FIXED_DATE_CALCULATION
            - LINKED_RECORDS_COUNT
            - DUE_DATE
            - DAYS_UNTIL_DUE
            - EVIDENCE
            - AEC_INFO
            - ANNUAL_LOSS_EXPOSURE
        name:
          type: string
          description: The name of the field.
        copyRecordAccessField:
          type: boolean
        currencyForNumberDisplayingFields:
          description: Circular reference to Field_RecordAuditSummary
          writeOnly: true
        requiresUniqueValue:
          type: boolean
        parameterizedCurrentValues:
          type: array
          items:
            $ref: '#/components/schemas/CurrentValueObject_RecordAuditSummary'
          writeOnly: true
        analysisOutputField:
          type: boolean
        currentValuesFromOtherField:
          description: Circular reference to Field_RecordAuditSummary
          writeOnly: true
        formatForNumberDisplayingFields:
          description: Circular reference to Field_RecordAuditSummary
          writeOnly: true
        crossWorkflowCalculation:
          type: boolean
        validTypeForCalculationInput:
          type: boolean
      required:
        - active
        - copyRecordAccessField
        - created
        - fieldType
        - id
        - name
        - updated
    Record_RecordAuditSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        state:
          type: string
          enum:
            - ARCHIVED
            - LIVE
        sequenceId:
          type: integer
          format: int64
        recordName:
          type: string
        lastUpdated:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - INACTIVE
            - NOT_ASSIGNED
            - ASSIGNED
            - IN_PROGRESS
            - COMPLETE
        viewableTitle:
          type: string
        initialStateEndStep:
          type: boolean
        workflowDueDate:
          type: string
          format: date-time
        recordType:
          type: string
          enum:
            - RECORD
            - JIRA_RECORD
        name:
          type: string
        isPublic:
          type: boolean
      required:
        - active
        - created
        - id
        - lastUpdated
        - recordName
        - sequenceId
        - state
        - updated
    ControlWorkflow_RecordAuditSummary:
      allOf:
        - description: Circular reference to Workflow_RecordAuditSummary
        - type: object
          properties:
            summaryFields:
              type: array
              items: {}
              maxItems: 5
              minItems: 0
            recordCount:
              type: integer
              format: int32
            centralFramework:
              type: boolean
      required:
        - active
        - allowAec
        - centralFramework
        - created
        - id
        - recordCount
        - requireGroups
        - updated
        - workflowType
    WorkflowSequence_RecordAuditSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
      required:
        - active
        - created
        - id
        - updated
    Application_RecordAuditSummary:
      type: object
      description: >-
        An entity for managing top-level application data. A application
        represents the highest level of organization for other entities within
        the application.
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
          description: Name of the application.
        createdBy:
          $ref: '#/components/schemas/User_RecordAuditSummary'
          description: Creator of the application.
        description:
          type: string
          description: Description of the application.
          maxLength: 2000
          minLength: 0
        color:
          type: string
          description: Icon color of the application.
        icon:
          type: string
          description: Icon type of the application.
          enum:
            - >-
              fa-bookmark, fa-bolt, fa-bullhorn,
              fa-certificate,fa-check-square-o, fa-cloud, fa-comments,
              fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder,
              fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring,
              fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal,
              fa-university, fa-user-circle
        type:
          type: string
        sourceApplicationId:
          type: string
        sourceEnvironment:
          type: string
        permissionsEnabled:
          type: boolean
        imported:
          type: boolean
        copied:
          type: boolean
        live:
          type: boolean
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
        uxriEnabled:
          type: boolean
          description: Whether or not UXRI is enabled on this application.
        shortCode:
          type: string
          description: Short display code for the application in navigation.
          pattern: ^(?! +$)[a-zA-Z0-9 ]{1,10}$
        defaultHomeScreen:
          $ref: '#/components/schemas/HomeScreen_RecordAuditSummary'
      required:
        - active
        - color
        - copied
        - created
        - createdBy
        - currency
        - defaultHomeScreen
        - description
        - icon
        - id
        - imported
        - live
        - name
        - permissionsEnabled
        - shortCode
        - sourceApplicationId
        - sourceEnvironment
        - type
        - updated
        - uxriEnabled
    UserGroup_RecordAuditSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        recordDefault:
          type: boolean
        title:
          type: string
        automatedUserGroup:
          type: boolean
        automatedUserGroupFieldLabel:
          type: string
      required:
        - active
        - automatedUserGroup
        - automatedUserGroupFieldLabel
        - created
        - id
        - recordDefault
        - title
        - updated
    PrimaryField_RecordAuditSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        field:
          $ref: '#/components/schemas/Field_RecordAuditSummary'
        systemField:
          type: string
          enum:
            - NAME
            - STATUS
            - CREATED
            - ENTERED_STEP_DATE
            - USER_DATE
            - EFFECTIVE_DUE_DATE
            - STEP_DUE_DATE
            - CURRENT_DATE
            - DUE_DATE
            - DAYS_UNTIL_DUE
            - SIMILARITY
            - RATIONALE
            - MATCH_CONFIDENCE
            - COMPLETED_DATE
            - LAST_COMPLETED_DATE
            - ID
            - SEQUENCE
            - ASSESSMENT_COUNT
            - USER_NAME
            - USER_ID
            - CREATOR_NAME
            - USER_GROUP
            - STEP_NAME
            - STEP_ID
            - ORIGIN_NAME
            - ORIGIN_ID
            - WORKFLOW_NAME
            - WORKFLOW_RECORD_PREFIX
            - WORKFLOW_ID
            - PRIMARY_FIELD
            - STATE
        name:
          type: string
      required:
        - active
        - created
        - field
        - id
        - name
        - systemField
        - updated
    CurrentValueUserGroupMapping_RecordAuditSummary:
      type: object
      properties:
        currentValue:
          $ref: '#/components/schemas/CurrentValue_RecordAuditSummary'
        userGroup:
          $ref: '#/components/schemas/UserGroup_RecordAuditSummary'
      required:
        - currentValue
        - userGroup
    WorkflowSummaryField_RecordAuditSummary:
      type: object
      properties:
        workflow:
          description: Circular reference to Workflow_RecordAuditSummary
          writeOnly: true
        field:
          $ref: '#/components/schemas/Field_RecordAuditSummary'
        priority:
          type: integer
          format: int32
        neo4jId:
          type: string
        fieldId:
          type: string
      required:
        - priority
    CurrentCommonValue_RecordAuditSummary:
      allOf:
        - description: Circular reference to CurrentValue_RecordAuditSummary
      required:
        - description
    LogIn_RecordAuditSummary:
      allOf:
        - description: Circular reference to AccessAudit_RecordAuditSummary
      required:
        - accessType
    Text_RecordAuditSummary:
      allOf:
        - description: Circular reference to Field_RecordAuditSummary
      required:
        - fieldType
    CurrentValueObject_RecordAuditSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_RecordAuditSummary'
        - description: >-
            And other types: CurrentDateValue_RecordAuditSummary,
            CurrentDateRangeValue_RecordAuditSummary,
            CurrentJobValue_RecordAuditSummary,
            CurrentCommonValue_RecordAuditSummary,
            CurrentDateValue_RecordAuditSummary,
            CurrentDateRangeValue_RecordAuditSummary,
            LabelValue_RecordAuditSummary, CleanAttachment_RecordAuditSummary,
            DirtyAttachment_RecordAuditSummary,
            PendingAttachment_RecordAuditSummary,
            CurrentGoogleAttachmentValue_RecordAuditSummary,
            CurrentSharepointAttachmentValue_RecordAuditSummary,
            Active_RecordAuditSummary, Automated_RecordAuditSummary,
            Disabled_RecordAuditSummary, External_RecordAuditSummary,
            Locked_RecordAuditSummary, Service_RecordAuditSummary,
            CurrentNumericRangeValue_RecordAuditSummary,
            CurrentJobValue_RecordAuditSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        discriminator:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - created
        - discriminator
        - id
        - updated
    HomeScreen_RecordAuditSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
      required:
        - active
        - created
        - id
        - updated
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.