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

Toggle Pane

• File
  • getCheck Existing File Information
  • putUpdated File Information
  • delDelete Existing File

API docs by Redocly

Download OpenAPI Specification: Download

File

The File Management REST Web Services provide endpoints for accessing and managing file metadata and lifecycle operations. These APIs allow retrieving file information by ID, updating file details based on supplied data, and deleting files using minimal request input.

Check Existing File Information

Retrieves a file 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 file. 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
FileID required	integer <int32> Unique identification number for the file in MFT FS file system
InFavorite required	boolean Indicates is file marked as favorite
IsPartiallyUploaded required	boolean Indicates if the file is partially uploaded
IsQuarantined required	boolean Indicates is file has been quarantined
ModifiedByUserID required	integer <int32> Unique identification number of the user that last accessed the file
Name required	string Name of the file
ParentFolderID required	integer <int32> Unique identification number of the parent folder for the file in MFT FS file system
Path required	string Path to the file in folder tree
Size required	integer <int64> Size of the file
Description	string Description of the file
Tags	Array of strings Collection of keywords associated with the current folder

https://{MFTWebServer}/REST/{version}/FileSystem/File/{fileId}

Response samples

• 200

Content type

application/json

{

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

}

Updated File Information

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

Remarks | Value of the FileID field in the posted
ThruPublicFileInfo DTO should reference to the existing, non-deleted, non-quarantined file. Otherwise, exception will be thrown

Not all properties of
ThruPublicFileInfo can be modified:

Name
ParentFolderID
Description
Keywords
ParentFolderID

The following properties should not be provided; if provided, their values will be ignored:
Size
DateCreated
DateModified
CreatedByUserID
ModifiedByUserID
IsQuarantined

ModifiedByUserID field of the file will be updated if the statement succeeded

After successful processing of the command updated
ThruPublicFileInfo object will be returned

Authorizations:

SessionAuth

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

required

Request body — Request type: ThruPublicFileInfo — Schema: ThruPublicFileInfo structure contains information about file in MFT FS 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 file. 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
FileID required	integer <int32> Unique identification number for the file in MFT FS file system
InFavorite required	boolean Indicates is file marked as favorite
IsPartiallyUploaded required	boolean Indicates if the file is partially uploaded
IsQuarantined required	boolean Indicates is file has been quarantined
ModifiedByUserID required	integer <int32> Unique identification number of the user that last accessed the file
Name required	string Name of the file
ParentFolderID required	integer <int32> Unique identification number of the parent folder for the file in MFT FS file system
Path required	string Path to the file in folder tree
Size required	integer <int64> Size of the file
Description	string Description of the file
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 file. 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
FileID required	integer <int32> Unique identification number for the file in MFT FS file system
InFavorite required	boolean Indicates is file marked as favorite
IsPartiallyUploaded required	boolean Indicates if the file is partially uploaded
IsQuarantined required	boolean Indicates is file has been quarantined
ModifiedByUserID required	integer <int32> Unique identification number of the user that last accessed the file
Name required	string Name of the file
ParentFolderID required	integer <int32> Unique identification number of the parent folder for the file in MFT FS file system
Path required	string Path to the file in folder tree
Size required	integer <int64> Size of the file
Description	string Description of the file
Tags	Array of strings Collection of keywords associated with the current folder

https://{MFTWebServer}/REST/{version}/FileSystem/File/{fileId}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

CreatedByUserID=1Q1OBQWVHTROE&DateCreated=%2FDate%281346072694480%29%2F&DateModified=%2FDate%281346072694480%29%2F&EffectivePermission=254&FileID=2OMFYXLA6BP9D&InFavorite=False&IsPartiallyUploaded=False&IsQuarantined=False&ModifiedByUserID=1Q1OBQWVHTROE&Name=2.html&ParentFolderID=1UTXM50KW0ISP&Path=FOLDERS%2FHOME%2FAdmin%2FMy+Documents%2F2.html&Size=198&Description=Description&Tags=Tags

Response samples

• 200

Content type

application/json

{

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

}

Delete Existing File

Deletes file based on the provided information. No additional data should be passed on the request body.

Remarks | Possibly later this file can be restored by administrator based on the MFT server configuration |

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/FileSystem/File/{fileId}