File Manager

Create File Manager File From Multipart File

This endpoint allows you to import a file and set the properties of the resulting File Manager File entity at the same time. The body of the request is an HTTP form with the Content-Type header set to multipart/form-data, containing 2 parts: fileManagerFile for the entity properties, and file for the file.

The fileManagerFile part must have the Content-Type header set to application/json and is similar to other entity types.

The file part contains the file to be uploaded and its Content-Type header must correspond to the file’s data type. For example, for a .csv file, the Content-Type header for the file part should be text/csv.

For reference, these are the content types associated with common file types:

File extension	Content type value
`.csv`	`text/csv`
`.xls`	`application/vnd.ms-excel`
`.xlsx`	`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
`.zip`	`application/zip`
`.gz`	`application/gzip`

Permissions

api.file-manager.write

POST

file-manager

import

Create File Manager File From Multipart File

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/file-manager/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'fileManagerFile={
  "originalName": "<string>",
  "extension": "<string>",
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "engagementId": "<string>",
  "parentFileManagerEntityId": "<string>",
  "name": "<string>",
  "status": [],
  "fileInfoId": "<string>"
}' \
  --form file='@example-file'

{
  "originalName": "<string>",
  "extension": "<string>",
  "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>",
  "parentFileManagerEntityId": "<string>",
  "name": "<string>",
  "status": [],
  "fileInfoId": "<string>"
}

Authorizations

Authorization

string

header

required

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

Headers

content-type

enum<string>

Available options:

multipart/form-data

Body

multipart/form-data

fileManagerFile

File Manager File · object

required

Show child attributes

file

required

Response

201 - application/json

Created

originalName

string

required

The name of the file as it appeared when first imported, including the extension.

Minimum string length: 1

extension

string

required

The suffix used at the end of the file.

Minimum string length: 1

string

The unique object identifier.

version

integer<int64>

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 whether the object is a DIRECTORY or a FILE.

Available options:

DIRECTORY,

FILE

engagementId

string

Identifies the associated engagement.

parentFileManagerEntityId

string

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

name

string

The current name of the file, excluding the extension.

status

enum<string>[]

The status of the file as it appears in MindBridge.

Available options:

MODIFIED,

ROLLED_FORWARD

fileInfoId

string

Identifies the associated file info.

Delete File Manager EntityDelete an existing **file manager entity**, identified by its ID. ### Permissions - `api.file-manager.delete`

⌘I

Create File Manager File From Multipart File

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/file-manager/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'fileManagerFile={
  "originalName": "<string>",
  "extension": "<string>",
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "engagementId": "<string>",
  "parentFileManagerEntityId": "<string>",
  "name": "<string>",
  "status": [],
  "fileInfoId": "<string>"
}' \
  --form file='@example-file'

{
  "originalName": "<string>",
  "extension": "<string>",
  "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>",
  "parentFileManagerEntityId": "<string>",
  "name": "<string>",
  "status": [],
  "fileInfoId": "<string>"
}