Waiting for engine...
Skip to main content

Boomi MFT - File Sharing API Reference (1.16) - Home

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Home

The Home Folder REST Web Services provide endpoints for accessing the home directory and its contents for the authenticated user. These APIs allow retrieving detailed information about the user's home folder, as well as collections of files, folders, or combined file and folder structures contained within it.

Retrieve Home Folder Information

Retrieves a home folder information of the authenticated user

Remarks | All returned dates are in UTC. |

Authorizations:
SessionAuth

Responses

Response Schema: application/json
CreatedByUserID
required
integer <int32>

Unique identification number of the user that has added file to MFT file system

DateCreated
required
string <date-time>

Date and time when file has been created in MFT file system (UTC)

DateModified
required
string <date-time>

Date and time when file last has been updated (UTC)

EffectivePermission
required
integer <int32>

Permissions that describe the rights of the current authenticated user over the folder. Each right is linked with the corresponding bit of the EffectivePermission field value in a binary code: None = 0×00 Show = 0×01 Read = 0×02 Create = 0×04 Download = 0×08 Distribute = 0×010 Manage = 0×020 Modify = 0×040 Delete = 0×080 For example, full control over a folder is equal to the EffectivePermission value of 0×00FF

FolderID
required
integer <int32>

Unique identification number for the folder in MFT file system

FolderType
required
integer <int32>

0 – a regular folder 1 – root folder 2 – home folder 3 – a user’s “My Documents” folder 4 – a user’s drop box folder 5 – root folder for common folders/files 6 – root folder for home folders

InFavorite
required
boolean

Indicates is folder marked as favorite

ModifiedByUserID
required
integer <int32>

Unique identification number of the user that last accessed the file

Name
required
string

Name of the folder

ParentFolderID
required
integer <int32>

Unique identification number of the parent folder for the file in MFT file system. Root folder contains NULL as a value of ParentFolderID field

Path
required
string

Path to the folder in folder tree

Size
required
integer <int64>

Size of the folder

Description
string

Description of the folder

Tags
Array of strings

Collection of keywords associated with the current folder

Response samples

Content type
application/json
{
  • "FolderID": "0QN8H2VKTGIWE",
  • "ParentFolderID": "11ETULS0966VI",
  • "Name": "Admin",
  • "Path": "FOLDERS/HOME/Admin",
  • "Description": "string",
  • "Tags": [
    • "string"
    ],
  • "Size": 2450294218,
  • "EffectivePermission": 254,
  • "DateCreated": "/Date(1337174868623)/",
  • "DateModified": "/Date(1337174868623)/",
  • "CreatedByUserID": "1Q1OBQWVHTROE",
  • "ModifiedByUserID": "1Q1OBQWVHTROE",
  • "InFavorite": false,
  • "FolderType": 0
}

Retrieve List of Files and Folders inside a Home Folder

Retrieves a collection of file and folder information structures based on the home folder information of the authenticated user.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
Array of objects (ThruPublicFileInfo)

Collection of file information structures

Array of objects (ThruPublicFolderInfo)

Collection of folder information structures

Response samples

Content type
application/json
{
  • "Files": [
    • {
      }
    ],
  • "Folders": [
    • {
      }
    ]
}

Retrieve List of Files inside a Home Folder

Retrieves a collection of file information structures based on the home folder information of the authenticated user.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
Array of objects (ThruPublicFileInfo)

Collection of file information structures

Array of objects (ThruPublicFolderInfo)

Collection of folder information structures

Response samples

Content type
application/json
{
  • "Files": [
    • {
      }
    ],
  • "Folders": [
    • {
      }
    ]
}

Retrieve List of Folders inside a Home Folder

Retrieves a collection of folder information structures based on the home folder information of the authenticated user.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
Array of objects (ThruPublicFileInfo)

Collection of file information structures

Array of objects (ThruPublicFolderInfo)

Collection of folder information structures

Response samples

Content type
application/json
{
  • "Files": [
    • {
      }
    ],
  • "Folders": [
    • {
      }
    ]
}