Data Transformation

Create Merge File Job

Merge data from the first sheet of multiple file manager files, then generate a new file with all source data on a single sheet.

Preferred field (new): mappings — a list of objects, each with a fileManagerFileId and a columns array that defines how its columns map into the merged output positions.

Example (mappings):

{
  "mappings": [
    {"fileManagerFileId": "1234567890abcdef12345678", "columns": [0, 1, 2, 3, 4]},
    {"fileManagerFileId": "2345678901bcdefa23456789", "columns": [1, 0, 2, 4, 3]}
  ]
}

Deprecated (legacy) field: fileColumnMappings — a map from fileManagerFileId to its columns array. It is still accepted for backward compatibility but will be removed in a future version.

Example (fileColumnMappings):

{
  "fileColumnMappings": {
    "1234567890abcdef12345678": [0, 1, 2, 3, 4],
    "2345678901bcdefa23456789": [1, 0, 2, 4, 3]
  }
}

The first mapping entry (in either format) is the master/template file and its columns array defines the output column positions. Columns are numbered from left to right, with the leftmost in a file being position 0. Each subsequent entry defines, for each output column, which column index to use from that file, allowing flexible mapping and positioning in the merged result.

Permissions

api.file-manager.write

POST

file-manager

transform

merge

Create Merge File Job

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "engagementId": "<string>",
  "outputFileName": "<string>",
  "parentFileManagerEntityId": "<string>",
  "fileColumnMappings": {},
  "mappings": [
    {
      "fileManagerFileId": "<string>",
      "columns": [
        123
      ]
    }
  ]
}
'

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge"

payload = {
    "engagementId": "<string>",
    "outputFileName": "<string>",
    "parentFileManagerEntityId": "<string>",
    "fileColumnMappings": {},
    "mappings": [
        {
            "fileManagerFileId": "<string>",
            "columns": [123]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    engagementId: '<string>',
    outputFileName: '<string>',
    parentFileManagerEntityId: '<string>',
    fileColumnMappings: {},
    mappings: [{fileManagerFileId: '<string>', columns: [123]}]
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'engagementId' => '<string>',
    'outputFileName' => '<string>',
    'parentFileManagerEntityId' => '<string>',
    'fileColumnMappings' => [
        
    ],
    'mappings' => [
        [
                'fileManagerFileId' => '<string>',
                'columns' => [
                                123
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge"

	payload := strings.NewReader("{\n  \"engagementId\": \"<string>\",\n  \"outputFileName\": \"<string>\",\n  \"parentFileManagerEntityId\": \"<string>\",\n  \"fileColumnMappings\": {},\n  \"mappings\": [\n    {\n      \"fileManagerFileId\": \"<string>\",\n      \"columns\": [\n        123\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"engagementId\": \"<string>\",\n  \"outputFileName\": \"<string>\",\n  \"parentFileManagerEntityId\": \"<string>\",\n  \"fileColumnMappings\": {},\n  \"mappings\": [\n    {\n      \"fileManagerFileId\": \"<string>\",\n      \"columns\": [\n        123\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"engagementId\": \"<string>\",\n  \"outputFileName\": \"<string>\",\n  \"parentFileManagerEntityId\": \"<string>\",\n  \"fileColumnMappings\": {},\n  \"mappings\": [\n    {\n      \"fileManagerFileId\": \"<string>\",\n      \"columns\": [\n        123\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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

application/json

engagementId

string

required

Identifies the associated engagement.

outputFileName

string

required

The name of the file being generated in the requested merge operation.

Minimum string length: 1

parentFileManagerEntityId

string

Identifies the parent directory. If NULL, the directory is positioned at the root level.

fileColumnMappings

object

deprecated

Deprecated: use mappings instead. Reference to the files and the columns to include in the merge operation.

Show child attributes

mappings

File Merge Mapping · object[]

Ordered list of file/column selections to merge (each entry has fileManagerFileId and its column indexes).

Show child attributes

Response

201 - application/json

Created

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

type

enum<string>

Indicates the type of job being run.

Available options:

ANALYSIS_RUN,

ANALYSIS_SOURCE_INGESTION,

ADMIN_REPORT,

DATA_TABLE_EXPORT,

ANALYSIS_ROLL_FORWARD,

GDPDU_UNPACK_JOB,

ACCOUNT_GROUPING_EXPORT,

ACCOUNT_MAPPING_EXPORT,

DATA_TRANSFORMATION_JOB,

CONNECTION_TEST,

CONNECTION_TABLES,

DATA_TABLE

status

enum<string>

Indicates the current state of the job.

Available options:

IN_PROGRESS,

COMPLETE,

ERROR

entityId

string

Identifies the entity used in the job.

entityType

enum<string>

Identifies the entity type used in the job.

Available options:

ORGANIZATION,

ENGAGEMENT,

ANALYSIS,

ANALYSIS_RESULT,

ANALYSIS_SOURCE,

FILE_RESULT,

GDPDU_UNPACK_JOB,

ACCOUNT_GROUPING,

ENGAGEMENT_ACCOUNT_GROUPING,

FILE_MANAGER_FILE,

CONNECTION_TEST_RESULT,

CONNECTION_TABLES_RESULT,

DATA_TABLE

error

string

The reason why the async job failed.

errorMessage

string

Create Databricks AuthorizationCreate a new Databricks authorization. ### Permissions - `api.connections.write`

⌘I

Create Merge File Job

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "engagementId": "<string>",
  "outputFileName": "<string>",
  "parentFileManagerEntityId": "<string>",
  "fileColumnMappings": {},
  "mappings": [
    {
      "fileManagerFileId": "<string>",
      "columns": [
        123
      ]
    }
  ]
}
'

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge"

payload = {
    "engagementId": "<string>",
    "outputFileName": "<string>",
    "parentFileManagerEntityId": "<string>",
    "fileColumnMappings": {},
    "mappings": [
        {
            "fileManagerFileId": "<string>",
            "columns": [123]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    engagementId: '<string>',
    outputFileName: '<string>',
    parentFileManagerEntityId: '<string>',
    fileColumnMappings: {},
    mappings: [{fileManagerFileId: '<string>', columns: [123]}]
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'engagementId' => '<string>',
    'outputFileName' => '<string>',
    'parentFileManagerEntityId' => '<string>',
    'fileColumnMappings' => [
        
    ],
    'mappings' => [
        [
                'fileManagerFileId' => '<string>',
                'columns' => [
                                123
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge"

	payload := strings.NewReader("{\n  \"engagementId\": \"<string>\",\n  \"outputFileName\": \"<string>\",\n  \"parentFileManagerEntityId\": \"<string>\",\n  \"fileColumnMappings\": {},\n  \"mappings\": [\n    {\n      \"fileManagerFileId\": \"<string>\",\n      \"columns\": [\n        123\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"engagementId\": \"<string>\",\n  \"outputFileName\": \"<string>\",\n  \"parentFileManagerEntityId\": \"<string>\",\n  \"fileColumnMappings\": {},\n  \"mappings\": [\n    {\n      \"fileManagerFileId\": \"<string>\",\n      \"columns\": [\n        123\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/file-manager/transform/merge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"engagementId\": \"<string>\",\n  \"outputFileName\": \"<string>\",\n  \"parentFileManagerEntityId\": \"<string>\",\n  \"fileColumnMappings\": {},\n  \"mappings\": [\n    {\n      \"fileManagerFileId\": \"<string>\",\n      \"columns\": [\n        123\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
}