Read Analysis Source - MindBridge Documentation

GET

analysis-sources

{analysisSourceId}

Read Analysis Source

curl --request GET \
  --url https://{tenant}.mindbridge.ai/api/v1/analysis-sources/{analysisSourceId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "engagementId": "<string>",
  "analysisId": "<string>",
  "analysisPeriodId": "<string>",
  "analysisSourceTypeId": "<string>",
  "fileManagerFileId": "<string>",
  "additionalDataColumnField": "<string>",
  "warningsIgnored": true,
  "warnings": [
    {
      "code": "<string>",
      "defaultMessage": "<string>"
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "defaultMessage": "<string>"
    }
  ],
  "applyDegrouper": true,
  "degrouperApplied": true,
  "fileInfo": {
    "id": "<string>",
    "version": 123,
    "creationDate": "2023-11-07T05:31:56Z",
    "lastModifiedDate": "2023-11-07T05:31:56Z",
    "createdUserInfo": {
      "userId": "<string>",
      "userName": "<string>"
    },
    "lastModifiedUserInfo": {
      "userId": "<string>",
      "userName": "<string>"
    },
    "name": "<string>",
    "formatDetected": true
  },
  "proposedColumnMappings": [
    {
      "columnPosition": 123,
      "virtualColumnIndex": 123,
      "mindbridgeField": "<string>",
      "additionalColumnName": "<string>"
    }
  ],
  "columnMappings": [
    {
      "position": 123,
      "field": "<string>",
      "mindbridgeField": "<string>",
      "additionalColumnName": "<string>"
    }
  ],
  "proposedVirtualColumns": [
    {
      "columnIndex": 123,
      "name": "<string>"
    }
  ],
  "virtualColumns": [
    {
      "name": "<string>",
      "columnIndex": 123,
      "id": "<string>",
      "version": 123,
      "creationDate": "2023-11-07T05:31:56Z",
      "lastModifiedDate": "2023-11-07T05:31:56Z",
      "createdUserInfo": {
        "userId": "<string>",
        "userName": "<string>"
      },
      "lastModifiedUserInfo": {
        "userId": "<string>",
        "userName": "<string>"
      },
      "index": 123
    }
  ],
  "proposedAmbiguousColumnResolutions": [
    {
      "position": 1,
      "selectedFormat": "<string>"
    }
  ],
  "ambiguousColumnResolutions": [
    {
      "position": 123,
      "ambiguousFormats": [
        "<string>"
      ],
      "selectedFormat": "<string>"
    }
  ],
  "proposedTransactionIdSelection": {
    "columnSelection": [
      123
    ],
    "virtualColumnSelection": [
      123
    ],
    "applySmartSplitter": true
  },
  "transactionIdSelection": {
    "columnSelection": [
      123
    ],
    "virtualColumnSelection": [
      123
    ],
    "applySmartSplitter": true
  },
  "fileInfoVersions": {},
  "fileManagerFiles": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

analysisSourceId

string

required

Response

200 - application/json

string

The unique object identifier.

version

integer<int64>

Indicates the data integrity version to ensure data consistency.

creationDate

string<date-time>

The date that the object was originally created.

lastModifiedDate

string<date-time>

The date that the object was last updated or modified.

createdUserInfo

User Info · object

read-only

Details about the user who created the object.

Show child attributes

lastModifiedUserInfo

User Info · object

read-only

Details about the user who last modified or updated the object.

Show child attributes

engagementId

string

Identifies the associated engagement.

analysisId

string

Identifies the associated analysis.

analysisPeriodId

string

Identifies the analysis period within MindBridge.

analysisSourceTypeId

string

Identifies the analysis source type.

fileManagerFileId

string

deprecated

Identifies the specific file manager file within MindBridge.

additionalDataColumnField

string

When creating an additional data source type, this indicates which additional data column is being targeted.

warningsIgnored

boolean

Indicates whether or not warnings should be ignored.

warnings

object[]

Details about the warnings associated with the source.

Show child attributes

errors

object[]

Details about the errors associated with the specific source.

Show child attributes

workflowState

enum<string>

The current state of the workflow.

Available options:

COMPLETED,

CANCELLED,

FAILED,

STARTED,

DETECTING_FORMAT,

ANALYZING_COLUMNS,

CHECKING_INTEGRITY,

SCANNING_TRANSACTION_COMBINATIONS,

PARSING,

PARSING_ICEBERG,

ANALYZING_EFFECTIVE_DATE_METRICS,

FORMAT_DETECTION_COMPLETED,

COLUMN_MAPPINGS_CONFIRMED,

SETTINGS_CONFIRMED,

PREPARING_ICEBERG,

ANALYSIS_PERIOD_SELECTED,

FUNDS_REVIEWED,

RUNNING,

UNPACK_COMPLETE,

UPLOADED,

FORMAT_DETECTED,

COLUMNS_ANALYZED,

INTEGRITY_CHECKED,

PARSED,

AUTHENTICATED,

CONFIGURED,

EFFECTIVE_DATE_METRICS_ANALYZED,

DATA_VALIDATION_CONFIRMED

targetWorkflowState

enum<string>

The state that the current workflow will advance to.

Available options:

COMPLETED,

CANCELLED,

FAILED,

STARTED,

DETECTING_FORMAT,

ANALYZING_COLUMNS,

CHECKING_INTEGRITY,

SCANNING_TRANSACTION_COMBINATIONS,

PARSING,

PARSING_ICEBERG,

ANALYZING_EFFECTIVE_DATE_METRICS,

FORMAT_DETECTION_COMPLETED,

COLUMN_MAPPINGS_CONFIRMED,

SETTINGS_CONFIRMED,

PREPARING_ICEBERG,

ANALYSIS_PERIOD_SELECTED,

FUNDS_REVIEWED,

RUNNING,

UNPACK_COMPLETE,

UPLOADED,

FORMAT_DETECTED,

COLUMNS_ANALYZED,

INTEGRITY_CHECKED,

PARSED,

AUTHENTICATED,

CONFIGURED,

EFFECTIVE_DATE_METRICS_ANALYZED,

DATA_VALIDATION_CONFIRMED

detectedFormat

enum<string>

The data format that MindBridge detected.

Available options:

QUICKBOOKS_JOURNAL,

QUICKBOOKS_JOURNAL_2024,

QUICKBOOKS_TRANSACTION_DETAIL_BY_ACCOUNT,

SAGE50_LEDGER,

SAGE50_TRANSACTIONS,

CCH_ACCOUNT_LIST,

MS_DYNAMICS_JOURNAL,

SAGE50_UK

applyDegrouper

boolean

Indicates whether or not the degrouper should be applied.

degrouperApplied

boolean

Indicates whether or not the degrouper was applied.

fileInfo

File Info · object

deprecated

Details about the file being imported into MindBridge.

File Info
Tabular File Info

Show child attributes

proposedColumnMappings

Proposed Column Mapping · object[]

Details about the proposed column mapping.

Show child attributes

columnMappings

Column Mapping · object[]

Details about column mapping.

Show child attributes

proposedVirtualColumns

(Proposed Duplicate Virtual Column · object | Proposed Join Virtual Column · object | Proposed Split By Delimiter Virtual Column · object | Proposed Split By Position Virtual Column · object)[]

Details about the proposed virtual columns added during the file import process.

Proposed Duplicate Virtual Column
Proposed Join Virtual Column
Proposed Split By Delimiter Virtual Column
Proposed Split By Position Virtual Column

Show child attributes

virtualColumns

(Duplicate Virtual Column · object | Join Virtual Column · object | Split By Delimiter Virtual Column · object | Split By Position Virtual Column · object)[]

Details about the virtual columns added during file ingestion.

Duplicate Virtual Column
Join Virtual Column
Split By Delimiter Virtual Column
Split By Position Virtual Column

Show child attributes

proposedAmbiguousColumnResolutions

Proposed Ambiguous Column Resolution · object[]

Details about the virtual columns added during file ingestion.

Show child attributes

ambiguousColumnResolutions

Ambiguous Column Resolution · object[]

Details about resolutions to ambiguity in a column.

Show child attributes

proposedTransactionIdSelection

Transaction ID Selection · object

The proposed columns to include when selecting a transaction ID.

Show child attributes

transactionIdSelection

Transaction ID Selection · object

Details about transaction ID selection.

Show child attributes

fileInfoVersions

object

A map of providing a set of file info IDs by their Analysis Source File Version.

Show child attributes

fileManagerFiles

object

A map of providing a set of file manager file IDs by their Analysis Source File Version.

Show child attributes

Read Effective Date MetricsQuery the results of the **Analysis Period** step in the data import process (based on the effective date column), including displaying the histogram by day, week, or month, as well as debit and credit sums for the period and more. ### Permissions - `api.analysis-sources.read`

⌘I

Read Analysis Source

curl --request GET \
  --url https://{tenant}.mindbridge.ai/api/v1/analysis-sources/{analysisSourceId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "engagementId": "<string>",
  "analysisId": "<string>",
  "analysisPeriodId": "<string>",
  "analysisSourceTypeId": "<string>",
  "fileManagerFileId": "<string>",
  "additionalDataColumnField": "<string>",
  "warningsIgnored": true,
  "warnings": [
    {
      "code": "<string>",
      "defaultMessage": "<string>"
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "defaultMessage": "<string>"
    }
  ],
  "applyDegrouper": true,
  "degrouperApplied": true,
  "fileInfo": {
    "id": "<string>",
    "version": 123,
    "creationDate": "2023-11-07T05:31:56Z",
    "lastModifiedDate": "2023-11-07T05:31:56Z",
    "createdUserInfo": {
      "userId": "<string>",
      "userName": "<string>"
    },
    "lastModifiedUserInfo": {
      "userId": "<string>",
      "userName": "<string>"
    },
    "name": "<string>",
    "formatDetected": true
  },
  "proposedColumnMappings": [
    {
      "columnPosition": 123,
      "virtualColumnIndex": 123,
      "mindbridgeField": "<string>",
      "additionalColumnName": "<string>"
    }
  ],
  "columnMappings": [
    {
      "position": 123,
      "field": "<string>",
      "mindbridgeField": "<string>",
      "additionalColumnName": "<string>"
    }
  ],
  "proposedVirtualColumns": [
    {
      "columnIndex": 123,
      "name": "<string>"
    }
  ],
  "virtualColumns": [
    {
      "name": "<string>",
      "columnIndex": 123,
      "id": "<string>",
      "version": 123,
      "creationDate": "2023-11-07T05:31:56Z",
      "lastModifiedDate": "2023-11-07T05:31:56Z",
      "createdUserInfo": {
        "userId": "<string>",
        "userName": "<string>"
      },
      "lastModifiedUserInfo": {
        "userId": "<string>",
        "userName": "<string>"
      },
      "index": 123
    }
  ],
  "proposedAmbiguousColumnResolutions": [
    {
      "position": 1,
      "selectedFormat": "<string>"
    }
  ],
  "ambiguousColumnResolutions": [
    {
      "position": 123,
      "ambiguousFormats": [
        "<string>"
      ],
      "selectedFormat": "<string>"
    }
  ],
  "proposedTransactionIdSelection": {
    "columnSelection": [
      123
    ],
    "virtualColumnSelection": [
      123
    ],
    "applySmartSplitter": true
  },
  "transactionIdSelection": {
    "columnSelection": [
      123
    ],
    "virtualColumnSelection": [
      123
    ],
    "applySmartSplitter": true
  },
  "fileInfoVersions": {},
  "fileManagerFiles": {}
}