Create Analysis Source - MindBridge Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

POST

/ v1

/analysis-sources

Create Analysis Source

cURL

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/analysis-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "engagementId": "<string>",
  "analysisId": "<string>",
  "analysisSourceTypeId": "<string>",
  "fileManagerFileId": "<string>",
  "analysisPeriodId": "<string>",
  "additionalDataColumnField": "<string>",
  "warningsIgnored": true,
  "applyDegrouper": true,
  "proposedColumnMappings": [
    {
      "columnPosition": 123,
      "virtualColumnIndex": 123,
      "mindbridgeField": "<string>",
      "additionalColumnName": "<string>"
    }
  ],
  "proposedVirtualColumns": [
    {
      "columnIndex": 123,
      "name": "<string>"
    }
  ],
  "proposedAmbiguousColumnResolutions": [
    {
      "position": 1,
      "selectedFormat": "<string>"
    }
  ],
  "presetHeaderRowIndex": 1
}
'

Python

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/analysis-sources"

payload = {
    "engagementId": "<string>",
    "analysisId": "<string>",
    "analysisSourceTypeId": "<string>",
    "fileManagerFileId": "<string>",
    "analysisPeriodId": "<string>",
    "additionalDataColumnField": "<string>",
    "warningsIgnored": True,
    "applyDegrouper": True,
    "proposedColumnMappings": [
        {
            "columnPosition": 123,
            "virtualColumnIndex": 123,
            "mindbridgeField": "<string>",
            "additionalColumnName": "<string>"
        }
    ],
    "proposedVirtualColumns": [
        {
            "columnIndex": 123,
            "name": "<string>"
        }
    ],
    "proposedAmbiguousColumnResolutions": [
        {
            "position": 1,
            "selectedFormat": "<string>"
        }
    ],
    "presetHeaderRowIndex": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    engagementId: '<string>',
    analysisId: '<string>',
    analysisSourceTypeId: '<string>',
    fileManagerFileId: '<string>',
    analysisPeriodId: '<string>',
    additionalDataColumnField: '<string>',
    warningsIgnored: true,
    applyDegrouper: true,
    proposedColumnMappings: [
      {
        columnPosition: 123,
        virtualColumnIndex: 123,
        mindbridgeField: '<string>',
        additionalColumnName: '<string>'
      }
    ],
    proposedVirtualColumns: [{columnIndex: 123, name: '<string>'}],
    proposedAmbiguousColumnResolutions: [{position: 1, selectedFormat: '<string>'}],
    presetHeaderRowIndex: 1
  })
};

fetch('https://{tenant}.mindbridge.ai/api/v1/analysis-sources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

{
  "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>"
  },
  "entityId": "<string>",
  "error": "<string>",
  "errorMessage": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body