> ## 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.

# Return a record based on a field

> Text and numeric values are optional.



## OpenAPI

````yaml GET /api/v1/records
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/records:
    get:
      tags:
        - Record
      summary: Return a Record based on a Field.
      description: Text and numeric values are optional.
      operationId: getForDefineAndReviewScope
      parameters:
        - name: linked-record
          in: query
          description: >-
            If a linked record ID is provided, only records linked to that
            record will be returned.
          required: false
          schema:
            type: string
        - name: workflow
          in: query
          description: All returned records will belong to this workflow with this ID.
          required: true
          schema:
            type: string
        - name: child-workflow
          in: query
          description: |2
                If a child workflow ID is provided, records will be returned with a count of linked records
                from that workflow. Otherwise, this count will default to zero.
          required: false
          schema:
            type: string
        - name: query
          in: query
          description: Optionally search by Record Name or Primary Field value.
          required: false
          schema:
            type: string
        - name: pageable
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/Pageable'
        - name: minUpdated
          in: query
          description: Minimum updated time value. The value is a unix timestamp.
          required: true
          schema:
            type: integer
            format: int64
        - name: field
          in: query
          description: Field ID
          required: true
          schema:
            type: string
        - name: textValue
          in: query
          description: Text value to be searched against
          required: false
          schema:
            type: string
        - name: numericValue
          in: query
          description: Numeric value to be searched against
          required: false
          schema:
            type: number
            format: double
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - type: array
                    items:
                      $ref: '#/components/schemas/Record_FullRecordSummary'
                  - $ref: '#/components/schemas/PageRecordPrimaryFieldOut'
                  - type: array
                    items:
                      $ref: '#/components/schemas/ChildResult_RecordSummary'
components:
  schemas:
    Pageable:
      type: object
      properties:
        paged:
          type: boolean
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/SortObject'
        unpaged:
          type: boolean
        offset:
          type: integer
          format: int64
    Record_FullRecordSummary:
      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
        dueDate:
          type: string
          format: date-time
        stepDueDate:
          type: string
          format: date-time
        userDate:
          type: string
          format: date-time
        activeDate:
          type: string
          format: date-time
        enteredStepDate:
          type: string
          format: date-time
        completedDate:
          type: string
          format: date-time
        lastCompletedDate:
          type: string
          format: date-time
        recordName:
          type: string
        step:
          $ref: '#/components/schemas/Step_FullRecordSummary'
        origin:
          $ref: '#/components/schemas/Step_FullRecordSummary'
        creator:
          $ref: '#/components/schemas/User_FullRecordSummary'
        user:
          $ref: '#/components/schemas/User_FullRecordSummary'
        secondaryAssignees:
          type: array
          items:
            $ref: '#/components/schemas/User_FullRecordSummary'
        userGroups:
          type: array
          items:
            $ref: '#/components/schemas/UserGroup_FullRecordSummary'
        currentValueMaps:
          type: array
          items:
            $ref: '#/components/schemas/ValueMap_FullRecordSummary'
        assignee:
          $ref: '#/components/schemas/User_FullRecordSummary'
        assigneeType:
          type: string
          enum:
            - EXTERNAL
            - INTERNAL
            - NONE
            - SELF
            - STEP
        daysUntilDue:
          $ref: '#/components/schemas/DaysUntilDue_FullRecordSummary'
        activeForRecord:
          description: Circular reference to Record_FullRecordSummary
        lastUpdated:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - INACTIVE
            - NOT_ASSIGNED
            - ASSIGNED
            - IN_PROGRESS
            - COMPLETE
        workflow:
          $ref: '#/components/schemas/Workflow_FullRecordSummary'
        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
        - activeDate
        - activeForRecord
        - assignee
        - assigneeType
        - completedDate
        - created
        - creator
        - currentValueMaps
        - daysUntilDue
        - dueDate
        - enteredStepDate
        - id
        - lastCompletedDate
        - lastUpdated
        - origin
        - recordName
        - secondaryAssignees
        - sequenceId
        - state
        - step
        - stepDueDate
        - updated
        - user
        - userDate
        - userGroups
    PageRecordPrimaryFieldOut:
      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'
        sort:
          $ref: '#/components/schemas/SortObject'
        size:
          type: integer
          format: int32
        content:
          type: array
          items:
            $ref: '#/components/schemas/RecordPrimaryFieldOut'
        number:
          type: integer
          format: int32
        empty:
          type: boolean
    ChildResult_RecordSummary:
      type: object
      properties:
        parent:
          type: string
          description: parent record
        children:
          type: string
          description: children records
      required:
        - children
        - parent
    SortObject:
      type: object
      properties:
        sorted:
          type: boolean
        unsorted:
          type: boolean
        empty:
          type: boolean
    Step_FullRecordSummary:
      type: object
      description: An entity to store details about a specific step within a workflow
      discriminator:
        propertyName: stepType
      oneOf:
        - $ref: '#/components/schemas/Origin_FullRecordSummary'
        - description: >-
            And other types: Chain_FullRecordSummary, End_FullRecordSummary,
            Origin_FullRecordSummary, Chain_FullRecordSummary,
            End_FullRecordSummary
      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_FullRecordSummary'
          description: Object containing all SLA information.
        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_FullRecordSummary
          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
        - xpos
        - ypos
    User_FullRecordSummary:
      allOf:
        - $ref: '#/components/schemas/CurrentValue_FullRecordSummary'
        - 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_FullRecordSummary'
            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_FullRecordSummary
        - description: >-
            And other types: Automated_FullRecordSummary,
            Disabled_FullRecordSummary, External_FullRecordSummary,
            Locked_FullRecordSummary, Service_FullRecordSummary
      properties:
        status:
          type: string
      required:
        - status
    UserGroup_FullRecordSummary:
      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
    ValueMap_FullRecordSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        currentValues:
          type: array
          items:
            $ref: '#/components/schemas/CurrentValue_FullRecordSummary'
        field:
          type: string
          description: field
        aiGenerated:
          type: boolean
        aiUpdatedBy:
          type: string
          enum:
            - AUTOFILL
            - AUTOMATED_CONTROLS_TESTING
            - AGENT
        aiReason:
          type: string
        aiConfidence:
          type: string
        expressionResult:
          type: number
          format: double
        copyable:
          type: boolean
        aiSources:
          type: array
          items:
            $ref: '#/components/schemas/AiSource_FullRecordSummary'
        dynamicProperties:
          type: object
          additionalProperties: {}
      required:
        - active
        - aiConfidence
        - aiGenerated
        - aiReason
        - aiUpdatedBy
        - created
        - currentValues
        - dynamicProperties
        - field
        - id
        - updated
    DaysUntilDue_FullRecordSummary:
      type: object
      description: A summary of the days left until a record is due.
      properties:
        value:
          type: integer
          format: int64
          description: >-
            Days until the effective due date. This value is absolute and will
            always be positive. When overdue, this value will be the number of
            days since the due date.
        label:
          type: string
          description: Label associated with the days until due.
          enum:
            - NO_DUE_DATE
            - COMPLETED
            - OVERDUE
            - DUE_WITHIN_A_WEEK
            - FAR_FROM_DUE
      required:
        - label
        - value
    Workflow_FullRecordSummary:
      type: object
      description: >-
        An entity that contains information about a set of steps within a
        particular application.
      discriminator:
        propertyName: workflowType
      oneOf:
        - description: Circular reference to ControlWorkflow_FullRecordSummary
        - description: 'And other types: JiraWorkflow_FullRecordSummary'
      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_FullRecordSummary'
          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_FullRecordSummary'
        application:
          $ref: '#/components/schemas/Application_FullRecordSummary'
          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_FullRecordSummary'
        primaryField:
          $ref: '#/components/schemas/PrimaryField_FullRecordSummary'
        workflowType:
          type: string
          enum:
            - WORKFLOW
            - JIRA_WORKFLOW
            - CONTROL_WORKFLOW
            - ANALYSIS_WORKFLOW
        currentValueUserGroupMappings:
          type: array
          items:
            $ref: >-
              #/components/schemas/CurrentValueUserGroupMapping_FullRecordSummary
        automatedAccessEnabled:
          type: boolean
        automatedAccessFields:
          type: array
          description: Fields that triggers automated access changes
          items:
            $ref: '#/components/schemas/Field_FullRecordSummary'
          maxItems: 6
          minItems: 0
        automatedAccessFieldId:
          type: string
        summaryFields:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowSummaryField_FullRecordSummary'
          maxItems: 5
          minItems: 0
        contains:
          description: Circular reference to Workflow_FullRecordSummary
          writeOnly: true
        canSelect:
          description: Circular reference to Workflow_FullRecordSummary
          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
    RecordPrimaryFieldOut:
      type: object
      properties:
        recordId:
          type: string
        primaryFieldValue:
          type: string
        childRecordCount:
          type: integer
          format: int64
      required:
        - childRecordCount
        - primaryFieldValue
        - recordId
    Origin_FullRecordSummary:
      allOf:
        - description: Circular reference to Step_FullRecordSummary
    ServiceLevelAgreement_FullRecordSummary:
      type: object
      properties:
        enabled:
          type: boolean
        duration:
          type: integer
          format: int64
      required:
        - duration
        - enabled
    CurrentValue_FullRecordSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_FullRecordSummary'
        - description: >-
            And other types: CurrentDateValue_FullRecordSummary,
            CurrentDateRangeValue_FullRecordSummary,
            CurrentJobValue_FullRecordSummary,
            CurrentCommonValue_FullRecordSummary,
            CurrentDateValue_FullRecordSummary,
            CurrentDateRangeValue_FullRecordSummary,
            LabelValue_FullRecordSummary, CleanAttachment_FullRecordSummary,
            DirtyAttachment_FullRecordSummary,
            PendingAttachment_FullRecordSummary,
            CurrentGoogleAttachmentValue_FullRecordSummary,
            CurrentSharepointAttachmentValue_FullRecordSummary,
            Active_FullRecordSummary, Automated_FullRecordSummary,
            Disabled_FullRecordSummary, External_FullRecordSummary,
            Locked_FullRecordSummary, Service_FullRecordSummary,
            CurrentNumericRangeValue_FullRecordSummary,
            CurrentJobValue_FullRecordSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        valueType:
          type: string
        discriminator:
          type: string
        textValue:
          type: string
        numericValue:
          type: number
          format: double
        isDefault:
          type: boolean
        archived:
          type: boolean
        priority:
          type: integer
          format: int32
        userGroup:
          type: string
          description: usergroup
        fieldId:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - archived
        - created
        - discriminator
        - id
        - isDefault
        - numericValue
        - priority
        - textValue
        - updated
        - userGroup
        - valueType
    AccessAudit_FullRecordSummary:
      type: object
      description: Entity used to track authentication attempts.
      discriminator:
        propertyName: accessType
      oneOf:
        - $ref: '#/components/schemas/LogIn_FullRecordSummary'
        - description: >-
            And other types: LogOut_FullRecordSummary,
            LogInFail_FullRecordSummary, CredentialsRolled_FullRecordSummary,
            TokenRolled_FullRecordSummary, LogIn_FullRecordSummary,
            LogOut_FullRecordSummary, LogInFail_FullRecordSummary,
            CredentialsRolled_FullRecordSummary, TokenRolled_FullRecordSummary
      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
    AiSource_FullRecordSummary:
      type: object
      properties:
        type:
          type: string
          enum:
            - USER_ATTACHMENT
            - FIELD
            - PROMPT
            - GENERATED
        name:
          type: string
      required:
        - name
        - type
    WorkflowSequence_FullRecordSummary:
      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_FullRecordSummary:
      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_FullRecordSummary'
          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_FullRecordSummary'
      required:
        - active
        - color
        - copied
        - created
        - createdBy
        - currency
        - defaultHomeScreen
        - description
        - icon
        - id
        - imported
        - live
        - name
        - permissionsEnabled
        - shortCode
        - sourceApplicationId
        - sourceEnvironment
        - type
        - updated
        - uxriEnabled
    PrimaryField_FullRecordSummary:
      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_FullRecordSummary'
        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_FullRecordSummary:
      type: object
      properties:
        currentValue:
          $ref: '#/components/schemas/CurrentValue_FullRecordSummary'
        userGroup:
          $ref: '#/components/schemas/UserGroup_FullRecordSummary'
      required:
        - currentValue
        - userGroup
    Field_FullRecordSummary:
      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_FullRecordSummary'
        - description: >-
            And other types: ExternalUser_FullRecordSummary,
            ExternalId_FullRecordSummary, TextArea_FullRecordSummary,
            DatePicker_FullRecordSummary, Number_FullRecordSummary,
            ESignature_FullRecordSummary, Checkbox_FullRecordSummary,
            MultiSelect_FullRecordSummary, Radio_FullRecordSummary,
            Select_FullRecordSummary, Attachment_FullRecordSummary,
            User_FullRecordSummary, Evidence_FullRecordSummary,
            Calculation_FullRecordSummary,
            FixedDateCalculation_FullRecordSummary,
            LinkedRecordsCount_FullRecordSummary, DueDate_FullRecordSummary,
            TransientFieldDaysUntilDue_FullRecordSummary,
            AnnualLossExposure_FullRecordSummary, AecInfo_FullRecordSummary,
            Text_FullRecordSummary, ExternalUser_FullRecordSummary,
            ExternalId_FullRecordSummary, TextArea_FullRecordSummary,
            DatePicker_FullRecordSummary, Number_FullRecordSummary,
            ESignature_FullRecordSummary, Checkbox_FullRecordSummary,
            MultiSelect_FullRecordSummary, Radio_FullRecordSummary,
            Select_FullRecordSummary, Attachment_FullRecordSummary,
            User_FullRecordSummary, Evidence_FullRecordSummary,
            Calculation_FullRecordSummary, TextConcatenation_FullRecordSummary,
            FixedDateCalculation_FullRecordSummary,
            LinkedRecordsCount_FullRecordSummary, DueDate_FullRecordSummary,
            TransientFieldDaysUntilDue_FullRecordSummary,
            AnnualLossExposure_FullRecordSummary, AecInfo_FullRecordSummary
      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.
        labels:
          type: array
          items:
            type: string
          uniqueItems: true
        label:
          type: string
          description: >-
            The label will appear as the label for the field when it appears on
            forms for user's to complete.
        tooltip:
          type: string
          description: A text value that will populate any tooltip information.
        helpText:
          type: string
          description: >-
            A text value that supplies necessary context for a person to fill
            out an input field.
        format:
          type: string
          enum:
            - CURRENCY
            - DECIMAL
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
        enabledForRecordAccess:
          type: boolean
        analysisEstimate:
          type: string
          enum:
            - CONFIDENCE
            - MAXIMUM
            - MINIMUM
            - MOST_LIKELY
        analysisType:
          type: string
          enum:
            - CONTACT_FREQUENCY
            - LOSS_EVENT_FREQUENCY
            - LOSS_MAGNITUDE
            - PRIMARY_PRODUCTIVITY_LOSS
            - PRIMARY_RESPONSE_LOSS
            - PRIMARY_REPLACEMENT_LOSS
            - PRIMARY_COMPETITIVE_ADVANTAGE_LOSS
            - PRIMARY_FINES_OR_JUDGEMENTS_LOSS
            - PRIMARY_REPUTATION_DAMAGE_LOSS
            - PROBABILITY_OF_ACTION
            - RESISTANCE_STRENGTH
            - SECONDARY_PRODUCTIVITY_LOSS
            - SECONDARY_RESPONSE_LOSS
            - SECONDARY_REPLACEMENT_LOSS
            - SECONDARY_COMPETITIVE_ADVANTAGE_LOSS
            - SECONDARY_FINES_OR_JUDGEMENTS_LOSS
            - SECONDARY_REPUTATION_DAMAGE_LOSS
            - SECONDARY_LOSS_EVENT_FREQUENCY
            - SECONDARY_LOSS_MAGNITUDE
            - THREAT_CAPABILITY
            - THREAT_EVENT_FREQUENCY
            - VULNERABILITY
        copyRecordAccessField:
          type: boolean
        currencyForNumberDisplayingFields:
          description: Circular reference to Field_FullRecordSummary
          writeOnly: true
        requiresUniqueValue:
          type: boolean
        parameterizedCurrentValues:
          type: array
          items:
            $ref: '#/components/schemas/CurrentValueObject_FullRecordSummary'
          writeOnly: true
        analysisOutputField:
          type: boolean
        currentValuesFromOtherField:
          description: Circular reference to Field_FullRecordSummary
          writeOnly: true
        formatForNumberDisplayingFields:
          description: Circular reference to Field_FullRecordSummary
          writeOnly: true
        crossWorkflowCalculation:
          type: boolean
        validTypeForCalculationInput:
          type: boolean
      required:
        - active
        - analysisEstimate
        - analysisType
        - copyRecordAccessField
        - created
        - currency
        - enabledForRecordAccess
        - fieldType
        - format
        - helpText
        - id
        - label
        - labels
        - name
        - tooltip
        - updated
    WorkflowSummaryField_FullRecordSummary:
      type: object
      properties:
        workflow:
          description: Circular reference to Workflow_FullRecordSummary
          writeOnly: true
        field:
          $ref: '#/components/schemas/Field_FullRecordSummary'
        priority:
          type: integer
          format: int32
        neo4jId:
          type: string
        fieldId:
          type: string
      required:
        - priority
    CurrentCommonValue_FullRecordSummary:
      allOf:
        - description: Circular reference to CurrentValue_FullRecordSummary
      required:
        - description
        - guidance
    LogIn_FullRecordSummary:
      allOf:
        - description: Circular reference to AccessAudit_FullRecordSummary
      required:
        - accessType
    HomeScreen_FullRecordSummary:
      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
    Text_FullRecordSummary:
      allOf:
        - description: Circular reference to Field_FullRecordSummary
      required:
        - fieldType
    CurrentValueObject_FullRecordSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_FullRecordSummary'
        - description: >-
            And other types: CurrentDateValue_FullRecordSummary,
            CurrentDateRangeValue_FullRecordSummary,
            CurrentJobValue_FullRecordSummary,
            CurrentCommonValue_FullRecordSummary,
            CurrentDateValue_FullRecordSummary,
            CurrentDateRangeValue_FullRecordSummary,
            LabelValue_FullRecordSummary, CleanAttachment_FullRecordSummary,
            DirtyAttachment_FullRecordSummary,
            PendingAttachment_FullRecordSummary,
            CurrentGoogleAttachmentValue_FullRecordSummary,
            CurrentSharepointAttachmentValue_FullRecordSummary,
            Active_FullRecordSummary, Automated_FullRecordSummary,
            Disabled_FullRecordSummary, External_FullRecordSummary,
            Locked_FullRecordSummary, Service_FullRecordSummary,
            CurrentNumericRangeValue_FullRecordSummary,
            CurrentJobValue_FullRecordSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        valueType:
          type: string
        discriminator:
          type: string
        textValue:
          type: string
        numericValue:
          type: number
          format: double
        isDefault:
          type: boolean
        archived:
          type: boolean
        priority:
          type: integer
          format: int32
        userGroup:
          type: string
          description: usergroup
        fieldId:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - archived
        - created
        - discriminator
        - id
        - isDefault
        - numericValue
        - priority
        - textValue
        - updated
        - userGroup
        - valueType
  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.