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

Toggle Pane

• Folder
  • postCreate New Folder Information
  • getRetrieve Existing Folder Information
  • putUpdated Folder Information
  • delDelete Existing Folder
  • getRetrieve List of Files and Folders inside a Folder
  • getRetrieve List of Files inside a Folder
  • getRetrieve List of Folders inside a Folder

API docs by Redocly

Download OpenAPI Specification: Download

Folder

The Folder Management REST Web Services provide endpoints for creating, retrieving, updating, and deleting folders within the MFT file system. These APIs support creating new folders, obtaining folder details by ID, updating folder metadata, and deleting folders along with their contents. Additional endpoints allow retrieving collections of files, folders, or both contained within a specified parent folder.

Create New Folder Information

Creates a new folder in MFT file system

Remarks | Example request: Name=New+Folder&ParentFolderId=1UTXM50KW0ISP&
Description=Description&Tags%5B%5D=567&Tags%5B%5D=897 |

Invocation Scenarios

Create a new folder

Remarks

Example request: Name=New+Folder&ParentFolderId=1UTXM50KW0ISP& Description=Description&Tags%5B%5D=567&Tags%5B%5D=897

Authorizations:

SessionAuth

Request Body schema: application/x-www-form-urlencoded

required

Request body — Request type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system.

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

Responses

https://{MFTWebServer}/REST/{version}/FileSystem/Folder

Request samples

• Payload

Content type

application/x-www-form-urlencoded

CreatedByUserID=1Q1OBQWVHTROE&DateCreated=%2FDate%281337174868623%29%2F&DateModified=%2FDate%281337174868623%29%2F&EffectivePermission=254&FolderID=0QN8H2VKTGIWE&FolderType=0&InFavorite=False&ModifiedByUserID=1Q1OBQWVHTROE&Name=Admin&ParentFolderID=11ETULS0966VI&Path=FOLDERS%2FHOME%2FAdmin&Size=2450294218&Description=Description&Tags=Tags

Response samples

• 201

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 Existing Folder Information

Retrieves a folder information based on the provided ID

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

https://{MFTWebServer}/REST/{version}/FileSystem/Folder/{folderId}

Response samples

• 200

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

}

Updated Folder Information

Updates folder information based on the provided information.
Information should be passed in the body as a serialized representation of the ThruPublicFolderInfo DTO.

Remarks | Value of the FolderID field in the posted
ThruPublicFileInfo DTO should reference to the existing and non-deleted folder. Otherwise, exception will be thrown.
Not all properties of ThruPublicFolderInfo can be modified:

Authorizations:

SessionAuth

Request Body schema: application/x-www-form-urlencoded

required

Request body — Request type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system.

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

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

https://{MFTWebServer}/REST/{version}/FileSystem/Folder/{folderId}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

CreatedByUserID=1Q1OBQWVHTROE&DateCreated=%2FDate%281337174868623%29%2F&DateModified=%2FDate%281337174868623%29%2F&EffectivePermission=254&FolderID=0QN8H2VKTGIWE&FolderType=0&InFavorite=False&ModifiedByUserID=1Q1OBQWVHTROE&Name=Admin&ParentFolderID=11ETULS0966VI&Path=FOLDERS%2FHOME%2FAdmin&Size=2450294218&Description=Description&Tags=Tags

Response samples

• 200

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

}

Delete Existing Folder

Deletes folder and its content based on the provided information. No additional data should be passed on the request body

Remarks | The folder could be restored later by administrator based on the MFT server configuration |

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/FileSystem/Folder/{folderId}

Retrieve List of Files and Folders inside a Folder

Retrieves a collection of file and folder information structures based on the provided parent folder ID.

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

https://{MFTWebServer}/REST/{version}/FileSystem/Folder/{folderId}/Content

Response samples

• 200

Content type

application/json

{

• "Files": [

  • {

    • "FileID": "2OMFYXLA6BP9D",
    • "ParentFolderID": "1UTXM50KW0ISP",
    • "Name": "2.html",
    • "Description": "string",
    • "Path": "FOLDERS/HOME/Admin/My Documents/2.html",
    • "Tags": [

      • "string"

      ],
    • "Size": 198,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1346072694480)/",
    • "DateModified": "/Date(1346072694480)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "IsQuarantined": false,
    • "InFavorite": false,
    • "IsPartiallyUploaded": false

    }

  ],
• "Folders": [

  • {

    • "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 inside a Folder

Retrieves a collection of file information structures based on the provided parent folder ID.

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

https://{MFTWebServer}/REST/{version}/FileSystem/Folder/{folderId}/Content/Files

Response samples

• 200

Content type

application/json

{

• "Files": [

  • {

    • "FileID": "2OMFYXLA6BP9D",
    • "ParentFolderID": "1UTXM50KW0ISP",
    • "Name": "2.html",
    • "Description": "string",
    • "Path": "FOLDERS/HOME/Admin/My Documents/2.html",
    • "Tags": [

      • "string"

      ],
    • "Size": 198,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1346072694480)/",
    • "DateModified": "/Date(1346072694480)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "IsQuarantined": false,
    • "InFavorite": false,
    • "IsPartiallyUploaded": false

    }

  ],
• "Folders": [

  • {

    • "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 Folders inside a Folder

Retrieves a collection of folder information structures based on the provided parent folder ID.

**

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

https://{MFTWebServer}/REST/{version}/FileSystem/Folder/{folderId}/Content/Folders

Response samples

• 200

Content type

application/json

{

• "Files": [

  • {

    • "FileID": "2OMFYXLA6BP9D",
    • "ParentFolderID": "1UTXM50KW0ISP",
    • "Name": "2.html",
    • "Description": "string",
    • "Path": "FOLDERS/HOME/Admin/My Documents/2.html",
    • "Tags": [

      • "string"

      ],
    • "Size": 198,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1346072694480)/",
    • "DateModified": "/Date(1346072694480)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "IsQuarantined": false,
    • "InFavorite": false,
    • "IsPartiallyUploaded": false

    }

  ],
• "Folders": [

  • {

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

    }

  ]

}