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

# Find a visual report by ID

> Retrieves the visual report with the given ID.



## OpenAPI

````yaml GET /api/v1/internal/visualReports/{visualReportId}
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/visualReports/{visualReportId}:
    get:
      tags:
        - Visual Report
      summary: Find a visual report by ID.
      description: Retrieves the visual report with the given ID.
      operationId: findById_6
      parameters:
        - name: visualReportId
          in: path
          description: ID of the visual report to return.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VisualReport_VisualReportExtendedSummary'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AppStatusResponse_VisualReportExtendedSummary
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AppStatusResponse_VisualReportExtendedSummary
components:
  schemas:
    VisualReport_VisualReportExtendedSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        colorBy:
          type: string
          enum:
            - XY_AXIS
            - Z_AXIS
        name:
          type: string
        chartType:
          type: string
        chartSubType:
          type: string
        stacked:
          type: boolean
        description:
          type: string
        readyForGapAnalysis:
          type: boolean
        aiInsightsEnabled:
          type: boolean
        heatMapConfig:
          $ref: '#/components/schemas/HeatMapConfig_VisualReportExtendedSummary'
        trendReportConfig:
          $ref: '#/components/schemas/TrendReportConfig_VisualReportExtendedSummary'
        creator:
          $ref: '#/components/schemas/User_VisualReportExtendedSummary'
        workflow:
          $ref: '#/components/schemas/Workflow_VisualReportExtendedSummary'
        tableReport:
          $ref: '#/components/schemas/TableReport_VisualReportExtendedSummary'
        axes:
          type: array
          items:
            $ref: '#/components/schemas/Axis_VisualReportExtendedSummary'
        workflowId:
          type: string
        filterByFieldValues:
          type: boolean
        viewableTitle:
          type: string
        createdByGapAnalysis:
          type: boolean
        chartSettings:
          $ref: '#/components/schemas/ChartSettings_VisualReportExtendedSummary'
      required:
        - active
        - aiInsightsEnabled
        - axes
        - chartSubType
        - chartType
        - colorBy
        - created
        - creator
        - description
        - filterByFieldValues
        - heatMapConfig
        - id
        - name
        - readyForGapAnalysis
        - stacked
        - tableReport
        - trendReportConfig
        - updated
        - workflow
        - workflowId
    AppStatusResponse_VisualReportExtendedSummary:
      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: {}
    HeatMapConfig_VisualReportExtendedSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        expression:
          type: string
        labelsEnabled:
          type: boolean
        logicalHandling:
          type: string
          enum:
            - EQUALS
            - NOT_EQUALS
            - IS
            - IS_NOT
            - GREATER_THAN
            - GREATER_THAN_EQUALS
            - LESS_THAN
            - LESS_THAN_EQUALS
            - CONTAINS
            - DOES_NOT_CONTAIN
            - 'NULL'
            - NOT_NULL
            - DATE_RANGE
            - NUMERIC_RANGE
        fieldInputs:
          type: array
          items:
            $ref: '#/components/schemas/Crossflow_VisualReportExtendedSummary'
        currentValues:
          type: array
          items:
            $ref: >-
              #/components/schemas/CurrentValueObject_VisualReportExtendedSummary
      required:
        - active
        - created
        - currentValues
        - expression
        - fieldInputs
        - id
        - labelsEnabled
        - logicalHandling
        - updated
    TrendReportConfig_VisualReportExtendedSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        record:
          $ref: '#/components/schemas/Record_VisualReportExtendedSummary'
        workflow:
          $ref: '#/components/schemas/Workflow_VisualReportExtendedSummary'
      required:
        - active
        - created
        - id
        - record
        - updated
        - workflow
    User_VisualReportExtendedSummary:
      allOf:
        - $ref: '#/components/schemas/Field_VisualReportExtendedSummary'
      required:
        - fieldType
        - permissionSets
        - roles
    Workflow_VisualReportExtendedSummary:
      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_VisualReportExtendedSummary'
        - description: 'And other types: JiraWorkflow_VisualReportExtendedSummary'
      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_VisualReportExtendedSummary
          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_VisualReportExtendedSummary'
        application:
          $ref: '#/components/schemas/Application_VisualReportExtendedSummary'
          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_VisualReportExtendedSummary'
        primaryField:
          $ref: '#/components/schemas/PrimaryField_VisualReportExtendedSummary'
        workflowType:
          type: string
          enum:
            - WORKFLOW
            - JIRA_WORKFLOW
            - CONTROL_WORKFLOW
            - ANALYSIS_WORKFLOW
        currentValueUserGroupMappings:
          type: array
          items:
            $ref: >-
              #/components/schemas/CurrentValueUserGroupMapping_VisualReportExtendedSummary
        automatedAccessEnabled:
          type: boolean
        automatedAccessFields:
          type: array
          description: Fields that triggers automated access changes
          items:
            $ref: '#/components/schemas/Field_VisualReportExtendedSummary'
          maxItems: 6
          minItems: 0
        automatedAccessFieldId:
          type: string
        summaryFields:
          type: array
          items:
            $ref: >-
              #/components/schemas/WorkflowSummaryField_VisualReportExtendedSummary
          maxItems: 5
          minItems: 0
        contains:
          description: Circular reference to Workflow_VisualReportExtendedSummary
          writeOnly: true
        canSelect:
          description: Circular reference to Workflow_VisualReportExtendedSummary
          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
    TableReport_VisualReportExtendedSummary:
      allOf:
        - $ref: '#/components/schemas/Layout_VisualReportExtendedSummary'
        - type: object
          properties:
            priority:
              type: integer
              format: int32
            description:
              type: string
            documentsEnabled:
              type: boolean
            inlineEditEnabled:
              type: boolean
            asyncExportEnabled:
              type: boolean
            includeArchivedRecords:
              type: boolean
            flattenTableEnabled:
              type: boolean
            flattenReducer:
              type: string
              enum:
                - MOST_RECENTLY_CREATED
                - FIRST_CREATED
            aiInsightsEnabled:
              type: boolean
            autoExpand:
              type: boolean
            version:
              type: integer
              format: int32
            pageSize:
              type: integer
              format: int32
            viewableTitle:
              type: string
      required:
        - aiInsightsEnabled
        - asyncExportEnabled
        - autoExpand
        - description
        - documentsEnabled
        - flattenReducer
        - flattenTableEnabled
        - includeArchivedRecords
        - inlineEditEnabled
        - priority
        - version
    Axis_VisualReportExtendedSummary:
      type: object
      discriminator:
        propertyName: axisSubtype
      oneOf:
        - $ref: '#/components/schemas/TimeSeriesAxis_VisualReportExtendedSummary'
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        field:
          $ref: '#/components/schemas/Field_VisualReportExtendedSummary'
        colors:
          type: array
          items:
            $ref: '#/components/schemas/VisualReportColor_VisualReportExtendedSummary'
        workflow:
          $ref: '#/components/schemas/Workflow_VisualReportExtendedSummary'
        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
        sort:
          $ref: '#/components/schemas/AxisSort_VisualReportExtendedSummary'
        name:
          type: string
        label:
          type: string
        priority:
          type: integer
          format: int32
        operation:
          type: string
        type:
          type: string
        dateGroupUnit:
          type: string
          enum:
            - Nanos
            - Micros
            - Millis
            - Seconds
            - Minutes
            - Hours
            - HalfDays
            - Days
            - Weeks
            - Months
            - Years
            - Decades
            - Centuries
            - Millennia
            - Eras
            - Forever
        currentValueId:
          type: string
        currentValueIds:
          type: array
          items:
            type: string
          uniqueItems: true
        displayUserWithEmail:
          type: boolean
        colorable:
          type: boolean
        tick:
          $ref: '#/components/schemas/Tick_VisualReportExtendedSummary'
        axisSubtype:
          type: string
      required:
        - active
        - axisSubtype
        - colors
        - created
        - currentValueId
        - currentValueIds
        - dateGroupUnit
        - displayUserWithEmail
        - field
        - id
        - label
        - name
        - operation
        - priority
        - sort
        - systemField
        - type
        - updated
        - workflow
    ChartSettings_VisualReportExtendedSummary:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data_VisualReportExtendedSummary'
        legend:
          $ref: '#/components/schemas/Legend_VisualReportExtendedSummary'
      required:
        - data
        - legend
    Crossflow_VisualReportExtendedSummary:
      type: object
      description: An entity for managing cross-workflow field data and crossflow rules.
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        crossflowReducer:
          type: string
          description: Determination of a field in X_TO_MANY linked workflow scenarios.
          enum:
            - NEWEST
            - OLDEST
            - MOST_RECENTLY_LINKED
            - LEAST_RECENTLY_LINKED
            - SUM
            - AVERAGE
            - HIGHEST
            - LOWEST
        systemField:
          type: string
          description: >-
            Optional. A system field that will drive crossflow rules. Will
            always be null when an field rule uses a custom field instead of a
            system field.
          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
        fieldWorkflow:
          $ref: '#/components/schemas/Workflow_VisualReportExtendedSummary'
          description: The owning workflow of the field that will drive crossflow rules.
        customField:
          $ref: '#/components/schemas/Field_VisualReportExtendedSummary'
          description: >-
            Optional. A field that will drive crossflow rules. Will always be
            null when an field rule uses a system field instead of a custom
            field.
        priority:
          type: integer
          format: int32
          description: >-
            Determines the fields place within the expression. Priority is in
            descending order with 0 being the first field in the expression.
        calcSpecificToStep:
          type: boolean
          description: Determines if calc field operation is specific to step.
        calcStep:
          $ref: '#/components/schemas/Step_VisualReportExtendedSummary'
          description: Selected step for calc field operation.
      required:
        - active
        - calcSpecificToStep
        - calcStep
        - created
        - crossflowReducer
        - customField
        - fieldWorkflow
        - id
        - priority
        - systemField
        - updated
    CurrentValueObject_VisualReportExtendedSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_VisualReportExtendedSummary'
        - description: >-
            And other types: CurrentDateValue_VisualReportExtendedSummary,
            CurrentDateRangeValue_VisualReportExtendedSummary,
            CurrentJobValue_VisualReportExtendedSummary,
            CurrentCommonValue_VisualReportExtendedSummary,
            CurrentDateValue_VisualReportExtendedSummary,
            CurrentDateRangeValue_VisualReportExtendedSummary,
            LabelValue_VisualReportExtendedSummary,
            CleanAttachment_VisualReportExtendedSummary,
            DirtyAttachment_VisualReportExtendedSummary,
            PendingAttachment_VisualReportExtendedSummary,
            CurrentGoogleAttachmentValue_VisualReportExtendedSummary,
            CurrentSharepointAttachmentValue_VisualReportExtendedSummary,
            Active_VisualReportExtendedSummary,
            Automated_VisualReportExtendedSummary,
            Disabled_VisualReportExtendedSummary,
            External_VisualReportExtendedSummary,
            Locked_VisualReportExtendedSummary,
            Service_VisualReportExtendedSummary,
            CurrentNumericRangeValue_VisualReportExtendedSummary,
            CurrentJobValue_VisualReportExtendedSummary
      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
    Record_VisualReportExtendedSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        viewableTitle:
          type: string
        initialStateEndStep:
          type: boolean
        recordType:
          type: string
          enum:
            - RECORD
            - JIRA_RECORD
        isPublic:
          type: boolean
      required:
        - active
        - created
        - id
        - updated
    Field_VisualReportExtendedSummary:
      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_VisualReportExtendedSummary'
        - description: >-
            And other types: ExternalUser_VisualReportExtendedSummary,
            ExternalId_VisualReportExtendedSummary,
            TextArea_VisualReportExtendedSummary,
            DatePicker_VisualReportExtendedSummary,
            Number_VisualReportExtendedSummary,
            ESignature_VisualReportExtendedSummary,
            Checkbox_VisualReportExtendedSummary,
            MultiSelect_VisualReportExtendedSummary,
            Radio_VisualReportExtendedSummary,
            Select_VisualReportExtendedSummary,
            Attachment_VisualReportExtendedSummary,
            User_VisualReportExtendedSummary,
            Evidence_VisualReportExtendedSummary,
            Calculation_VisualReportExtendedSummary,
            FixedDateCalculation_VisualReportExtendedSummary,
            LinkedRecordsCount_VisualReportExtendedSummary,
            DueDate_VisualReportExtendedSummary,
            TransientFieldDaysUntilDue_VisualReportExtendedSummary,
            AnnualLossExposure_VisualReportExtendedSummary,
            AecInfo_VisualReportExtendedSummary,
            Text_VisualReportExtendedSummary,
            ExternalUser_VisualReportExtendedSummary,
            ExternalId_VisualReportExtendedSummary,
            TextArea_VisualReportExtendedSummary,
            DatePicker_VisualReportExtendedSummary,
            Number_VisualReportExtendedSummary,
            ESignature_VisualReportExtendedSummary,
            Checkbox_VisualReportExtendedSummary,
            MultiSelect_VisualReportExtendedSummary,
            Radio_VisualReportExtendedSummary,
            Select_VisualReportExtendedSummary,
            Attachment_VisualReportExtendedSummary,
            User_VisualReportExtendedSummary,
            Evidence_VisualReportExtendedSummary,
            Calculation_VisualReportExtendedSummary,
            TextConcatenation_VisualReportExtendedSummary,
            FixedDateCalculation_VisualReportExtendedSummary,
            LinkedRecordsCount_VisualReportExtendedSummary,
            DueDate_VisualReportExtendedSummary,
            TransientFieldDaysUntilDue_VisualReportExtendedSummary,
            AnnualLossExposure_VisualReportExtendedSummary,
            AecInfo_VisualReportExtendedSummary
      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
        currentValues:
          type: array
          description: >-
            Relationship to current values that are associated to the field. A
            field maybe have multiple current values associated to it.
          items:
            $ref: '#/components/schemas/CurrentValue_VisualReportExtendedSummary'
        defaultValues:
          type: array
          description: >-
            Relationship to current values that are defaulted to the field. A
            field maybe have multiple default current values associated to it.
          items:
            $ref: '#/components/schemas/CurrentValue_VisualReportExtendedSummary'
        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
        operators:
          type: array
          items:
            type: string
            enum:
              - EQUALS
              - NOT_EQUALS
              - IS
              - IS_NOT
              - GREATER_THAN
              - GREATER_THAN_EQUALS
              - LESS_THAN
              - LESS_THAN_EQUALS
              - CONTAINS
              - DOES_NOT_CONTAIN
              - 'NULL'
              - NOT_NULL
              - DATE_RANGE
              - NUMERIC_RANGE
        convertibleTo:
          type: array
          items:
            type: string
        copyRecordAccessField:
          type: boolean
        currencyForNumberDisplayingFields:
          description: Circular reference to Field_VisualReportExtendedSummary
          writeOnly: true
        valueType:
          type: string
        global:
          type: boolean
        requiresUniqueValue:
          type: boolean
        parameterizedCurrentValues:
          type: array
          items:
            $ref: >-
              #/components/schemas/CurrentValueObject_VisualReportExtendedSummary
          writeOnly: true
        analysisOutputField:
          type: boolean
        discrete:
          type: boolean
        currentValuesFromOtherField:
          description: Circular reference to Field_VisualReportExtendedSummary
          writeOnly: true
        formatForNumberDisplayingFields:
          description: Circular reference to Field_VisualReportExtendedSummary
          writeOnly: true
        crossWorkflowCalculation:
          type: boolean
        validTypeForCalculationInput:
          type: boolean
      required:
        - active
        - analysisEstimate
        - analysisType
        - convertibleTo
        - copyRecordAccessField
        - created
        - currency
        - currentValues
        - defaultValues
        - enabledForRecordAccess
        - fieldType
        - format
        - helpText
        - id
        - label
        - labels
        - name
        - operators
        - tooltip
        - updated
    ControlWorkflow_VisualReportExtendedSummary:
      allOf:
        - description: Circular reference to Workflow_VisualReportExtendedSummary
        - type: object
          properties:
            recordCount:
              type: integer
              format: int32
            centralFramework:
              type: boolean
      required:
        - active
        - allowAec
        - centralFramework
        - created
        - id
        - recordCount
        - requireGroups
        - updated
        - workflowType
    ServiceLevelAgreement_VisualReportExtendedSummary:
      type: object
      properties:
        enabled:
          type: boolean
        duration:
          type: integer
          format: int64
      required:
        - duration
        - enabled
    WorkflowSequence_VisualReportExtendedSummary:
      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_VisualReportExtendedSummary:
      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_VisualReportExtendedSummary'
          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_VisualReportExtendedSummary'
      required:
        - active
        - color
        - copied
        - created
        - createdBy
        - currency
        - defaultHomeScreen
        - description
        - icon
        - id
        - imported
        - live
        - name
        - permissionsEnabled
        - shortCode
        - sourceApplicationId
        - sourceEnvironment
        - type
        - updated
        - uxriEnabled
    UserGroup_VisualReportExtendedSummary:
      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_VisualReportExtendedSummary:
      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_VisualReportExtendedSummary'
        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_VisualReportExtendedSummary:
      type: object
      properties:
        currentValue:
          $ref: '#/components/schemas/CurrentValue_VisualReportExtendedSummary'
        userGroup:
          $ref: '#/components/schemas/UserGroup_VisualReportExtendedSummary'
      required:
        - currentValue
        - userGroup
    WorkflowSummaryField_VisualReportExtendedSummary:
      type: object
      properties:
        workflow:
          description: Circular reference to Workflow_VisualReportExtendedSummary
          writeOnly: true
        field:
          $ref: '#/components/schemas/Field_VisualReportExtendedSummary'
        priority:
          type: integer
          format: int32
        neo4jId:
          type: string
        fieldId:
          type: string
      required:
        - priority
    Layout_VisualReportExtendedSummary:
      type: object
      description: >-
        An entity used to group a collection of layout fields related to record
        data
      discriminator:
        propertyName: layoutType
      oneOf:
        - description: Circular reference to Default_VisualReportExtendedSummary
        - description: >-
            And other types: Repository_VisualReportExtendedSummary,
            Display_VisualReportExtendedSummary,
            TableReport_VisualReportExtendedSummary,
            Default_VisualReportExtendedSummary,
            Repository_VisualReportExtendedSummary,
            Display_VisualReportExtendedSummary,
            TableReport_VisualReportExtendedSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        title:
          type: string
        defaultLayout:
          type: boolean
        layoutType:
          type: string
      required:
        - active
        - created
        - defaultLayout
        - id
        - title
        - updated
    TimeSeriesAxis_VisualReportExtendedSummary:
      allOf:
        - description: Circular reference to Axis_VisualReportExtendedSummary
        - type: object
          properties:
            startDate:
              type: string
              format: date-time
            endDate:
              type: string
              format: date-time
      required:
        - active
        - created
        - endDate
        - id
        - startDate
        - updated
    VisualReportColor_VisualReportExtendedSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        color:
          type: string
        recordStatus:
          type: string
          enum:
            - INACTIVE
            - NOT_ASSIGNED
            - ASSIGNED
            - IN_PROGRESS
            - COMPLETE
        currentValue:
          $ref: '#/components/schemas/CurrentValueObject_VisualReportExtendedSummary'
      required:
        - active
        - color
        - created
        - currentValue
        - id
        - recordStatus
        - updated
    AxisSort_VisualReportExtendedSummary:
      type: object
      properties:
        direction:
          type: string
          enum:
            - ASC
            - DESC
        property:
          type: string
        ignoreCase:
          type: boolean
        nullHandling:
          type: string
          enum:
            - NATIVE
            - NULLS_FIRST
            - NULLS_LAST
        ascending:
          type: boolean
        descending:
          type: boolean
    Tick_VisualReportExtendedSummary:
      type: object
      properties:
        fit:
          type: boolean
        multiline:
          type: boolean
        culling:
          type: boolean
      required:
        - culling
        - fit
        - multiline
    Data_VisualReportExtendedSummary:
      type: object
      properties:
        labels:
          type: boolean
        numberFormat:
          type: string
          enum:
            - DEFAULT
            - COMMA_SEPARATED
      required:
        - labels
        - numberFormat
    Legend_VisualReportExtendedSummary:
      type: object
      properties:
        position:
          type: string
        show:
          type: boolean
      required:
        - position
        - show
    Step_VisualReportExtendedSummary:
      type: object
      description: An entity to store details about a specific step within a workflow
      discriminator:
        propertyName: stepType
      oneOf:
        - $ref: '#/components/schemas/Origin_VisualReportExtendedSummary'
        - description: >-
            And other types: Chain_VisualReportExtendedSummary,
            End_VisualReportExtendedSummary, Origin_VisualReportExtendedSummary,
            Chain_VisualReportExtendedSummary, End_VisualReportExtendedSummary
      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.
        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_VisualReportExtendedSummary
          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_VisualReportExtendedSummary
          writeOnly: true
        origin:
          type: boolean
        chain:
          type: boolean
      required:
        - active
        - assignableUserType
        - autofillEnabled
        - commentsEnabled
        - created
        - description
        - documentsEnabled
        - externalUserMfaRequired
        - id
        - name
        - priority
        - sla
        - stepType
        - updated
        - userGroupOperationType
        - uxriEnabled
        - xpos
        - ypos
    CurrentCommonValue_VisualReportExtendedSummary:
      allOf:
        - description: Circular reference to CurrentValueObject_VisualReportExtendedSummary
      required:
        - description
        - guidance
    Text_VisualReportExtendedSummary:
      allOf:
        - description: Circular reference to Field_VisualReportExtendedSummary
      required:
        - fieldType
    CurrentValue_VisualReportExtendedSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_VisualReportExtendedSummary'
        - description: >-
            And other types: CurrentDateValue_VisualReportExtendedSummary,
            CurrentDateRangeValue_VisualReportExtendedSummary,
            CurrentJobValue_VisualReportExtendedSummary,
            CurrentCommonValue_VisualReportExtendedSummary,
            CurrentDateValue_VisualReportExtendedSummary,
            CurrentDateRangeValue_VisualReportExtendedSummary,
            LabelValue_VisualReportExtendedSummary,
            CleanAttachment_VisualReportExtendedSummary,
            DirtyAttachment_VisualReportExtendedSummary,
            PendingAttachment_VisualReportExtendedSummary,
            CurrentGoogleAttachmentValue_VisualReportExtendedSummary,
            CurrentSharepointAttachmentValue_VisualReportExtendedSummary,
            Active_VisualReportExtendedSummary,
            Automated_VisualReportExtendedSummary,
            Disabled_VisualReportExtendedSummary,
            External_VisualReportExtendedSummary,
            Locked_VisualReportExtendedSummary,
            Service_VisualReportExtendedSummary,
            CurrentNumericRangeValue_VisualReportExtendedSummary,
            CurrentJobValue_VisualReportExtendedSummary
      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
    HomeScreen_VisualReportExtendedSummary:
      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
    Origin_VisualReportExtendedSummary:
      allOf:
        - description: Circular reference to Step_VisualReportExtendedSummary
  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.