{
"openapi": "3.0.3",
"info": {
"title": "Boomi Managed File Transfer - File Sharing (MFT - FS) APIs",
"version": "1.16",
"description": "Download OpenAPI Specification: Download \n\n",
"contact": {
"name": "Customer Support",
"url": "https://community.boomi.com/boomi_support",
"email": "support@boomi.com"
}
},
"servers": [
{
"url": "https://{MFTWebServer}/REST/{version}",
"variables": {
"MFTWebServer": {
"default": "https://example.boomi.com"
},
"version": {
"default": "v1"
}
}
}
],
"paths": {
"/Audit/Users/": {
"get": {
"tags": [
"Audit"
],
"operationId": "getAuditUsers",
"summary": "Retrieve User Audit",
"description": "Returns the records of the User audit. \n\n ### Invocation Scenarios \n\n Search **MFT User Audit** records for the current authenticated user. All query parameters are optional. \n\n ### Remarks \n\n REST version: 1.0
order=-1 : from latest by date to older
order=1 : from earliest by date to newer
DateTime should be in Unix epoch format, in milliseconds, example: /Date(1706922061000)/ , slashed included
Sample URL with datetime filtering:
`https://sitename.domain.ext/REST/1.0/Audit/Users?start=/Date(1704070861000)/&end=/Date(1706922061000)/`
Search value for `userSearchString` should not include the quotes, e.g. [userSearchString=email@domain.com](mailto:userSearchString=email@domain.com)",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicAuditUserAction — Schema: ThruPublicAuditUserAction structure contains the extended list of properties which can be filled for User Log Operations. Depending of operation type some of them will be equal to NULL.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicAuditUserAction"
}
}
}
}
},
"parameters": [
{
"name": "operation",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "applicationId",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userSearchString",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"description": "Unix epoch time in milliseconds."
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"description": "Unix epoch time in milliseconds."
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "order",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/Audit/UserGroups/": {
"get": {
"tags": [
"Audit"
],
"operationId": "getAuditUsergroups",
"summary": "Retrieve UserGroup Audit",
"description": "Returns the records of User Group audit.\n\n ### Invocation Scenarios \n\n Search **MFT UserGroup Audit** records for the current authenticated user. All query parameters are optional. \n\n ### Remarks \n\n REST version: 1.0
order=-1 : from latest by date to older
order=1 : from earliest by date to newer
DateTime should be in Unix epoch format, in milliseconds, example: /Date(1706922061000)/
Sample URL with datetime filtering:
`https://sitename.domain.ext/REST/1.0/Audit/ UserGroups?start=/Date(1704070861000)/&end=/Date(1706922061000)/`
Search value for `userSearchString` should not include the quotes, e.g. userSearchString=email@domain.com
Search value for `userGroupSearchString` should not include the quotes, e.g. userGroupSearchString=Test UserGroup API v1.",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicAuditUserGroupAction — Schema: ThruPublicAuditUserGroupAction structure contains the extended list of properties which can be filled for User Group Log Operations. Depending of operation type some of them will be equal to NULL.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicAuditUserGroupAction"
}
}
}
}
},
"parameters": [
{
"name": "operation",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userGroupId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userSearchString",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userGroupSearchString",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"description": "Unix epoch time in milliseconds."
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"description": "Unix epoch time in milliseconds."
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "order",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/Audit/FileSystem/": {
"get": {
"tags": [
"Audit"
],
"operationId": "getAuditFilesystem",
"summary": "Retrieve FileSystem Audit",
"description": "Get list of the FileSystem audit. \n\n ### Invocation Scenarios \n\n Search **MFT FileSystem Audit** records for the current authenticated user. All query parameters are optional. \n\n ### Remarks \n\n REST version: 1.0
order=-1 : from latest by date to older
order=1 : from earliest by date to newer
DateTime should be in Unix epoch format, in milliseconds, example: /Date(1706922061000)/
Sample URL with datetime filtering:
`https://sitename.domain.ext/REST/1.0/Audit/ FileSystem?start=/Date(1704070861000)/&end=/Date(1706922061000)/`",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicAuditFileSystemTransactionAction — Schema: ThruPublicAuditFileSystemTransactionAction structure contains the extended list of properties which can be filled for FileSystem Log Operations. Depending on operation type some values will be equal to NULL and will not be returned in the response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicAuditFileSystemTransactionAction"
}
}
}
}
},
"parameters": [
{
"name": "operation",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "applicationId",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "order",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/Favorites/Folder/{folderId}": {
"parameters": [
{
"$ref": "#/components/parameters/folderId"
}
],
"put": {
"tags": [
"Favorites"
],
"operationId": "putFavoritesFolderByFolderid",
"summary": "Add Folder to Favorites",
"description": "Add folder with the specified id to favorites.\n\n### Invocation Scenarios\nMark folder whose ID is specified in URL as favorite",
"responses": {
"200": {
"description": "None"
}
}
},
"delete": {
"tags": [
"Favorites"
],
"operationId": "deleteFavoritesFolderByFolderid",
"summary": "Delete Folder from Favorites",
"description": "Remove folder with the specified ID from favorites.\n\n",
"responses": {
"200": {
"description": "None"
}
}
}
},
"/Favorites/File/{fileId}": {
"parameters": [
{
"$ref": "#/components/parameters/fileId"
}
],
"put": {
"tags": [
"Favorites"
],
"operationId": "putFavoritesFileByFileid",
"summary": "Add File to Favorites",
"description": "Add file with the specified ID to favorites.\n\n",
"responses": {
"200": {
"description": "None"
}
}
},
"delete": {
"tags": [
"Favorites"
],
"operationId": "deleteFavoritesFileByFileid",
"summary": "Delete File from Favorites",
"description": "Remove file with the specified ID from favorites.\n\n",
"responses": {
"200": {
"description": "None"
}
}
}
},
"/Favorites/Content": {
"get": {
"tags": [
"Favorites"
],
"operationId": "getFavoritesContent",
"summary": "Retrieve All Content in Favorites",
"description": "Retrieves a collection of file and folder information structures marked as favorites. Result can be filtered by options.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/Favorites/Content/Files": {
"get": {
"tags": [
"Favorites"
],
"operationId": "getFavoritesContentFiles",
"summary": "Retrieve Files in Favorites",
"description": "Retrieves a collection of file information structures marked as favorites. Result can be filtered by options.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/Favorites/Content/Folders": {
"get": {
"tags": [
"Favorites"
],
"operationId": "getFavoritesContentFolders",
"summary": "Retrieve Folders in Favorites",
"description": "Retrieves a collection of folder information structures marked as favorites. Result can be filtered by options.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/FileSystem/File/{fileId}": {
"parameters": [
{
"$ref": "#/components/parameters/fileId"
}
],
"get": {
"tags": [
"File"
],
"operationId": "getFilesystemFileByFileid",
"summary": "Check Existing File Information",
"description": "Retrieves a file information based on the provided ID\n\n**Remarks**\n| All returned dates are in UTC. |",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicFileInfo — Schema: ThruPublicFileInfo structure contains information about file in MFT FS file system.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFileInfo"
}
}
}
}
}
},
"put": {
"tags": [
"File"
],
"operationId": "putFilesystemFileByFileid",
"summary": "Updated File Information",
"description": "Updates file information based on the provided information. Information should be passed in the body as a serialized representation of the
ThruPublicFileInfo DTO\n\n**Remarks**\n| Value of the FileID field in the posted \nThruPublicFileInfo DTO should reference to the existing, non-deleted, non-quarantined file. Otherwise, exception will be thrown\n\nNot all properties of \nThruPublicFileInfo can be modified:\n\nName \nParentFolderID \nDescription \nKeywords \nParentFolderID\n\nThe following properties should not be provided; if provided, their values will be ignored: \nSize \nDateCreated \nDateModified \nCreatedByUserID \nModifiedByUserID \nIsQuarantined\n\nModifiedByUserID field of the file will be updated if the statement succeeded\n\nAfter successful processing of the command updated \nThruPublicFileInfo object will be returned",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicFileInfo — Schema: ThruPublicFileInfo structure contains information about file in MFT FS file system.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFileInfo"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFileInfo"
},
"example": "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"
}
},
"description": "Request body — Request type: ThruPublicFileInfo — Schema: ThruPublicFileInfo structure contains information about file in MFT FS file system."
}
},
"delete": {
"tags": [
"File"
],
"operationId": "deleteFilesystemFileByFileid",
"summary": "Delete Existing File",
"description": "Deletes file based on the provided information. No additional data should be passed on the request body.\n\n**Remarks**\n| Possibly later this file can be restored by administrator based on the MFT server configuration |",
"responses": {
"200": {
"description": "None"
}
}
}
},
"/FileSystem/Folder": {
"post": {
"tags": [
"Folder"
],
"operationId": "postFilesystemFolder",
"summary": "Create New Folder Information",
"description": "Creates a new folder in MFT file system\n\n**Remarks**\n| Example request: Name=New+Folder&ParentFolderId=1UTXM50KW0ISP&
Description=Description&Tags%5B%5D=567&Tags%5B%5D=897 |\n\n### Invocation Scenarios\nCreate a new folder\n\n### Remarks\nExample request: Name=New+Folder&ParentFolderId=1UTXM50KW0ISP&\nDescription=Description&Tags%5B%5D=567&Tags%5B%5D=897",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
},
"example": "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"
}
},
"description": "Request body — Request type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system."
}
}
},
"/FileSystem/Folder/{folderId}": {
"parameters": [
{
"$ref": "#/components/parameters/folderId"
}
],
"get": {
"tags": [
"Folder"
],
"operationId": "getFilesystemFolderByFolderid",
"summary": "Retrieve Existing Folder Information",
"description": "Retrieves a folder information based on the provided ID\n\n**Remarks**\n| All returned dates are in UTC. |",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
}
}
}
}
}
},
"put": {
"tags": [
"Folder"
],
"operationId": "putFilesystemFolderByFolderid",
"summary": "Updated Folder Information",
"description": "Updates folder information based on the provided information.
Information should be passed in the body as a serialized representation of the ThruPublicFolderInfo DTO.\n\n**Remarks**\n| Value of the FolderID field in the posted \nThruPublicFileInfo DTO should reference to the existing and non-deleted folder. Otherwise, exception will be thrown. \nNot all properties of ThruPublicFolderInfo can be modified:",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
},
"example": "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"
}
},
"description": "Request body — Request type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system."
}
},
"delete": {
"tags": [
"Folder"
],
"operationId": "deleteFilesystemFolderByFolderid",
"summary": "Delete Existing Folder",
"description": "Deletes folder and its content based on the provided information. No additional data should be passed on the request body\n\n**Remarks**\n| The folder could be restored later by administrator based on the MFT server configuration |",
"responses": {
"200": {
"description": "None"
}
}
}
},
"/FileSystem/Folder/{folderId}/Content": {
"parameters": [
{
"$ref": "#/components/parameters/folderId"
}
],
"get": {
"tags": [
"Folder"
],
"operationId": "getFilesystemFolderByFolderidContent",
"summary": "Retrieve List of Files and Folders inside a Folder",
"description": "Retrieves a collection of file and folder information structures based on the provided parent folder ID.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/FileSystem/Folder/{folderId}/Content/Files": {
"parameters": [
{
"$ref": "#/components/parameters/folderId"
}
],
"get": {
"tags": [
"Folder"
],
"operationId": "getFilesystemFolderByFolderidContentFiles",
"summary": "Retrieve List of Files inside a Folder",
"description": "Retrieves a collection of file information structures based on the provided parent folder ID.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/FileSystem/Folder/{folderId}/Content/Folders": {
"parameters": [
{
"$ref": "#/components/parameters/folderId"
}
],
"get": {
"tags": [
"Folder"
],
"operationId": "getFilesystemFolderByFolderidContentFolders",
"summary": "Retrieve List of Folders inside a Folder",
"description": "Retrieves a collection of folder information structures based on the provided parent folder ID.\n\n**",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/FileSystem/Home": {
"get": {
"tags": [
"Home"
],
"operationId": "getFilesystemHome",
"summary": "Retrieve Home Folder Information",
"description": "Retrieves a home folder information of the authenticated user\n\n**Remarks**\n| All returned dates are in UTC. |",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
}
}
}
}
}
}
},
"/FileSystem/Home/Content": {
"get": {
"tags": [
"Home"
],
"operationId": "getFilesystemHomeContent",
"summary": "Retrieve List of Files and Folders inside a Home Folder",
"description": "Retrieves a collection of file and folder information structures based on the home folder information of the authenticated user.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult - Schema: ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/FileSystem/Home/Content/Files": {
"get": {
"tags": [
"Home"
],
"operationId": "getFilesystemHomeContentFiles",
"summary": "Retrieve List of Files inside a Home Folder",
"description": "Retrieves a collection of file information structures based on the home folder information of the authenticated user.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/FileSystem/Home/Content/Folders": {
"get": {
"tags": [
"Home"
],
"operationId": "getFilesystemHomeContentFolders",
"summary": "Retrieve List of Folders inside a Home Folder",
"description": "Retrieves a collection of folder information structures based on the home folder information of the authenticated user.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/FileSystem/Root": {
"get": {
"tags": [
"Root"
],
"operationId": "getFilesystemRoot",
"summary": "Retrieve Root Folder Information",
"description": "Retrieves a root folder information of the authenticated user\n\n**Remarks**\n| All returned dates are in UTC. |",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicFolderInfo — Schema: ThruPublicFolderInfo structure contains information about folder in MFT file system.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
}
}
}
}
}
}
},
"/FileSystem/Root/Content": {
"get": {
"tags": [
"Root"
],
"operationId": "getFilesystemRootContent",
"summary": "Retrieve List of Files and Folders inside a Root Folder",
"description": "Retrieves a collection of file and folder information structures based on the root folder information of the authenticated user.\n\n",
"responses": {
"200": {
"description": "None"
}
}
}
},
"/FileSystem/Root/Content/Files": {
"get": {
"tags": [
"Root"
],
"operationId": "getFilesystemRootContentFiles",
"summary": "Retrieve List of Files inside a Root Folder",
"description": "Retrieves a collection of file information structures based on the root folder information of the authenticated user.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/FileSystem/Root/Content/Folders": {
"get": {
"tags": [
"Root"
],
"operationId": "getFilesystemRootContentFolders",
"summary": "Retrieve List of Folders inside a Root Folder",
"description": "Retrieves a collection of folder information structures based on the root folder information of the authenticated user.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
}
}
},
"/ImmutableSession": {
"post": {
"tags": [
"ImmutableSession"
],
"operationId": "postImmutablesession",
"summary": "Create new Immutable Session object",
"description": "Verify user credentials and authenticate MFT user in the system with immutable session. Optionally passes external user information for audit purposes in UserString for the session opened. Device\\_UUID parameter is mandatory and can be set to any string.\n\n**Remarks**\n| Example request: UserName=admin&Password=password&
ClientVersion=1&ApplicationId=12&UserString=User |",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicSession — Schema: ThruPublicSession structure contains authorization information about user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSession"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruSessionRequest"
},
"example": "ApplicationId=12&ClientVersion=1&Device%5CUUID=Device1234&Password=Password&UserName=Test&UserString=Name+%2F+email%40domain.com"
}
},
"description": "Request body — Request type: ThruSessionRequest — Schema: ThruSessionRequest structure contains information required for the MFT user authentication."
},
"security": []
}
},
"/ImmutableSessionByTicket": {
"post": {
"tags": [
"ImmutableSessionByTicket"
],
"operationId": "postImmutablesessionbyticket",
"summary": "Create new Immutable Session object by Ticket",
"description": "Verify user credentials and authenticate MFT user in the system with immutable session\n\n**Remarks**\n| Example request: UserName=admin&Password=password&
ClientVersion=1&ApplicationId=12 |",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicSession — Schema: ThruPublicSession structure contains authorization information about user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSession"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruSessionRequest"
},
"example": "ApplicationId=12&ClientVersion=1&Device%5CUUID=Device1234&Password=Password&UserName=Test&UserString=Name+%2F+email%40domain.com"
}
},
"description": "Request body — Request type: ThruSessionRequest — Schema: ThruSessionRequest structure contains information required for the MFT user authentication."
},
"security": []
}
},
"/Message": {
"post": {
"tags": [
"Message"
],
"operationId": "postMessage",
"summary": "Create New Message",
"description": "Creates MFT message according to ThruPublicMessageInfo structure passed in HTTP request\n\n**Remarks**\nToRecipients, CcRecipients, BccRecipients fields in ThruPublicMessageInfo should be present in request as a string array. \nThese fields will bind to required structure on server side.\n\nDateExpired must be converted to UTC.\n\n### Invocation Scenarios\nSend one or more files and folders to recipients\nSend private message to recipients\n\n### Remarks\nAll returned dates are in UTC.",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
},
"example": "CollectedFlag=True&DateCreated=%2FDate%281337611985780%29%2F&DateExpired=%2FDate%281357070340000%29%2F&DateSent=%2FDate%281337611985780%29%2F&ExpireNow=False&IsExpired=False&MessageID=1HPHF1D8FF8S0&NotifyFlag=False&Priority=3&PrivateMessage=Private+text&PublicMessage=Public+text&RequestLogin=False&SendByClient=False&Subject=test&TrackingNo=T478-026-95732-36971&UserID=1Q1OBQWVHTROE&MsgHtmlTemplate=MsgHtmlTemplate&MsgTextTemplate=MsgTextTemplate&ToRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&CcRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&BccRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&FoldersAttached=%5B%7B%22CreatedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22DateCreated%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22DateModified%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22EffectivePermission%22%3A254%2C%22FolderID%22%3A%220QN8H2VKTGIWE%22%2C%22FolderType%22%3A0%2C%22InFavorite%22%3Afalse%2C%22ModifiedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22Name%22%3A%22Admin%22%2C%22ParentFolderID%22%3A%2211ETULS0966VI%22%2C%22Path%22%3A%22FOLDERS%2FHOME%2FAdmin%22%2C%22Size%22%3A2450294218%2C%22Description%22%3A%22Description%22%2C%22Tags%22%3A%5B%22Tags%22%5D%7D%5D&FilesAttached=%5B%7B%22CreatedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22DateCreated%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22DateModified%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22EffectivePermission%22%3A254%2C%22FolderID%22%3A%220QN8H2VKTGIWE%22%2C%22FolderType%22%3A0%2C%22InFavorite%22%3Afalse%2C%22ModifiedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22Name%22%3A%22Admin%22%2C%22ParentFolderID%22%3A%2211ETULS0966VI%22%2C%22Path%22%3A%22FOLDERS%2FHOME%2FAdmin%22%2C%22Size%22%3A2450294218%2C%22Description%22%3A%22Description%22%2C%22Tags%22%3A%5B%22Tags%22%5D%7D%5D"
}
},
"description": "Request body — Request type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message."
}
}
},
"/Message/{messageId}": {
"parameters": [
{
"$ref": "#/components/parameters/messageId"
}
],
"get": {
"tags": [
"Message"
],
"operationId": "getMessageByMessageid",
"summary": "Retrieve Existing Message",
"description": "Retrieves message information based on the provided ID.\n\n**Remarks**\n| All returned dates are in UTC. |",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
}
}
}
}
}
},
"delete": {
"tags": [
"Message"
],
"operationId": "deleteMessageByMessageid",
"summary": "Delete Existing Message",
"description": "Deletes message based on the provided information. No additional data should be passed on the request body.\n\n",
"responses": {
"200": {
"description": "None"
}
}
},
"put": {
"tags": [
"Message"
],
"operationId": "putMessageByMessageid",
"summary": "Update Message",
"description": "Updates message information based on the provided information.
Information should be passed in the body as a serialized representation of the ThruPublicMessageInfo DTO\n\n**Remarks**\n| Value of the MessageID field in the posted ThruPublicMessageInfo DTO should reference to the existing, non-deleted message. Otherwise, exception will be thrown.\n\nNot all properties of ThruPublicMessageInfo can be modified: \nDateExpired \nExpireNow \nToRecipients, CcRecipients, BccRecipients \nFoldersAttached, FilesAttached\n\nDateExpired must be converted to UTC.\n\nRecipients to delete must be provided in ToRecipients field. They will be deleted from To, Cc and Bcc lists.\n\nIf provided, the values of the following fields are ignored:\n\nSubject \nPriority \nPublicMessage \nPrivateMessage \nCollectedFlag \nRequestLogin \nSendByClient \nDateCreated \nDateSent\n\nAfter successful processing of the command updated \nThruPublicFileInfo object will be returned.",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
},
"example": "CollectedFlag=True&DateCreated=%2FDate%281337611985780%29%2F&DateExpired=%2FDate%281357070340000%29%2F&DateSent=%2FDate%281337611985780%29%2F&ExpireNow=False&IsExpired=False&MessageID=1HPHF1D8FF8S0&NotifyFlag=False&Priority=3&PrivateMessage=Private+text&PublicMessage=Public+text&RequestLogin=False&SendByClient=False&Subject=test&TrackingNo=T478-026-95732-36971&UserID=1Q1OBQWVHTROE&MsgHtmlTemplate=MsgHtmlTemplate&MsgTextTemplate=MsgTextTemplate&ToRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&CcRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&BccRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&FoldersAttached=%5B%7B%22CreatedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22DateCreated%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22DateModified%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22EffectivePermission%22%3A254%2C%22FolderID%22%3A%220QN8H2VKTGIWE%22%2C%22FolderType%22%3A0%2C%22InFavorite%22%3Afalse%2C%22ModifiedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22Name%22%3A%22Admin%22%2C%22ParentFolderID%22%3A%2211ETULS0966VI%22%2C%22Path%22%3A%22FOLDERS%2FHOME%2FAdmin%22%2C%22Size%22%3A2450294218%2C%22Description%22%3A%22Description%22%2C%22Tags%22%3A%5B%22Tags%22%5D%7D%5D&FilesAttached=%5B%7B%22CreatedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22DateCreated%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22DateModified%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22EffectivePermission%22%3A254%2C%22FolderID%22%3A%220QN8H2VKTGIWE%22%2C%22FolderType%22%3A0%2C%22InFavorite%22%3Afalse%2C%22ModifiedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22Name%22%3A%22Admin%22%2C%22ParentFolderID%22%3A%2211ETULS0966VI%22%2C%22Path%22%3A%22FOLDERS%2FHOME%2FAdmin%22%2C%22Size%22%3A2450294218%2C%22Description%22%3A%22Description%22%2C%22Tags%22%3A%5B%22Tags%22%5D%7D%5D"
}
},
"description": "Request body — Request type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message."
}
}
},
"/Message/Discard/{messageId}": {
"parameters": [
{
"$ref": "#/components/parameters/messageId"
}
],
"put": {
"tags": [
"Message"
],
"operationId": "putMessageDiscardByMessageid",
"summary": "Update Discard Message",
"description": "Discard message based on the provided information. No additional data should be passed on the request body.\n\n**Remarks**\n| This method can be called only after the method ‘New MFT message’ is called |",
"responses": {
"200": {
"description": "None"
}
}
}
},
"/Message/Complete/{messageId}": {
"parameters": [
{
"$ref": "#/components/parameters/messageId"
}
],
"put": {
"tags": [
"Message"
],
"operationId": "putMessageCompleteByMessageid",
"summary": "Update Complete Message",
"description": "Complete message based on the provided information. No additional data should be passed on the request body.\n\n**Remarks**\n| This method can be called only after the method ‘New MFT message’ is called |",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
}
}
}
}
}
}
},
"/Message/Content/{skip}/{take}": {
"parameters": [
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/take"
}
],
"get": {
"tags": [
"Message"
],
"operationId": "getMessageContentBySkipByTake",
"summary": "Retrieve SentThru List",
"description": "Get list of the sent messages. Attachments are not included in returned data object.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
}
}
}
}
}
}
},
"/Message/Storage/{type}": {
"parameters": [
{
"$ref": "#/components/parameters/type"
}
],
"post": {
"tags": [
"Message"
],
"operationId": "postMessageStorageByType",
"summary": "Retrieve Project Message Storage",
"description": "Retrieves a folder information of the message storage.\n\n",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
}
}
}
}
},
"requestBody": {
"required": true,
"description": "Request body — Request type: object",
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"Subject": {
"type": "string",
"description": "The subject text"
}
},
"required": [
"Subject"
]
},
"example": {
"Subject": "Test Subject"
}
}
}
}
}
},
"/Search/{skip}/{take}": {
"parameters": [
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/take"
}
],
"post": {
"tags": [
"Search"
],
"operationId": "postSearchBySkipByTake",
"summary": "Find All Files and Folders by Search Criteria",
"description": "Retrieves a collection of folder and file structures based on the provided search criteria structure.\n\n**Remarks**\n| NameCriteria, DescriptionCriteria, KeywordCriteria are automatically wrapped by the ‘**’**
**if not contains it as part of criteria. For example: “text” -> “\\*text**”, but “tex\\*t” -> “tex\\*t” |\n\n### Invocation Scenarios\nSearch over all MFT FS files and folders available to the current authenticated user.\n\n### Remarks\nNameCriteria, DescriptionCriteria, and KeywordCriteria are automatically wrapped by the ‘**’**\n**if not contains it as part of criteria. For example: “text” -> “\\*text**”, but “tex\\*t” -> “tex\\*t”",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSearchCriteria"
},
"example": "DescriptionCriteria=-&DescriptionCriteriaMatchAll=True&FolderID=0QN8H2VKTGIWE&KeywordCriteria=12%5C&KeywordCriteriaMatchAll=True&NameCriteria=-&NameCriteriaMatchAll=True&Recursive=True&LastModifiedByUsers=LastModifiedByUsers&DateLastModifiedStart=2025-01-01T00%3A00%3A00Z&DateLastModifiedEnd=2025-01-01T00%3A00%3A00Z"
}
},
"description": "Request body — Request type: ThruPublicSearchCriteria — Schema: ThruPublicSearchCriteria structure contains criteria for the search over MFT files and folders."
}
}
},
"/Search/Folders/{skip}/{take}": {
"parameters": [
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/take"
}
],
"post": {
"tags": [
"Search"
],
"operationId": "postSearchFoldersBySkipByTake",
"summary": "Find All Folders by Search Criteria",
"description": "Retrieves a collection of folder structures based on provided search criteria structure.\n\n**Remarks**\n| ThruPublicContentResult always contain null for ThruPublicFileInfo NameCriteria, DescriptionCriteria, KeywordCriteria
are automatically wrapped by the ‘**’ if not contains it as part of criteria. For ex: “text” -> “\\*text**”, but “tex\\*t” -> “tex\\*t” |",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSearchCriteria"
},
"example": "DescriptionCriteria=-&DescriptionCriteriaMatchAll=True&FolderID=0QN8H2VKTGIWE&KeywordCriteria=12%5C&KeywordCriteriaMatchAll=True&NameCriteria=-&NameCriteriaMatchAll=True&Recursive=True&LastModifiedByUsers=LastModifiedByUsers&DateLastModifiedStart=2025-01-01T00%3A00%3A00Z&DateLastModifiedEnd=2025-01-01T00%3A00%3A00Z"
}
},
"description": "Request body — Request type: ThruPublicSearchCriteria — Schema: ThruPublicSearchCriteria structure contains criteria for the search over MFT files and folders."
}
}
},
"/Search/Files/{Skip}/{Take}": {
"post": {
"tags": [
"Search"
],
"operationId": "searchFilesByCriteria",
"summary": "Find All Files by Search Criteria",
"description": "Retrieves a collection of files based on the provided `ThruPublicSearchCriteria` object.",
"parameters": [
{
"name": "Skip",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
},
"description": "Number of items to skip (for paging)."
},
{
"name": "Take",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Number of items to take/return (page size)."
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSearchCriteria"
},
"example": "DescriptionCriteria=-&DescriptionCriteriaMatchAll=True&FolderID=0QN8H2VKTGIWE&KeywordCriteria=12%5C&KeywordCriteriaMatchAll=True&NameCriteria=-&NameCriteriaMatchAll=True&Recursive=True&LastModifiedByUsers=LastModifiedByUsers&DateLastModifiedStart=2025-01-01T00%3A00%3A00Z&DateLastModifiedEnd=2025-01-01T00%3A00%3A00Z"
}
},
"description": "Request body — Request type: ThruPublicSearchCriteria — Schema: ThruPublicSearchCriteria structure contains criteria for the search over MFT files and folders."
},
"responses": {
"200": {
"description": "Successful search returning a collection of files. — Response type: ThruPublicContentResult — Schema: ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicContentResult"
}
}
}
},
"400": {
"description": "Invalid search criteria or paging parameters."
},
"401": {
"description": "Authentication required or failed."
},
"500": {
"description": "Server error."
}
}
}
},
"/Server/Info": {
"get": {
"tags": [
"Server"
],
"operationId": "getServerInfo",
"summary": "Retrieve Server Information",
"description": "Retrieves information about current server.\n\n### Invocation Scenarios\nGet file information in order to fulfill it.",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicServerInfo — Schema: ThruPublicServerInfo structure contains information about the configuration of server and its health status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicServerInfo"
}
}
}
}
}
}
},
"/Server/SyncPolicy": {
"get": {
"tags": [
"Server"
],
"operationId": "getServerSyncpolicy",
"summary": "Retrieve Server Sync Policy",
"description": "Server Sync Policy",
"responses": {
"200": {
"description": "OK — Response type: SyncPolicy — Schema: SyncPolicy structure contains information about the configuration of the server and its health status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncPolicy"
}
}
}
}
}
}
},
"/Server/AllowedBandwidth": {
"get": {
"tags": [
"Server"
],
"operationId": "getServerAllowedbandwidth",
"summary": "Retrieve Server Allowed Bandwidth",
"description": "Server Allowed Bandwidth",
"responses": {
"200": {
"description": "OK — Response type: ThruAllowedBandwidth — Schema: ThruAllowedBandwidth structure contains information about the configuration of the server and its health status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruAllowedBandwidth"
}
}
}
}
}
}
},
"/Server/AllowedBandwidth/Interval": {
"get": {
"tags": [
"Server"
],
"operationId": "getServerAllowedbandwidthInterval",
"summary": "Retrieve Server Allowed Bandwidth interval",
"description": "Server Allowed Bandwidth interval",
"responses": {
"200": {
"description": "OK — Response type: ThruAllowedBandwidthInterval — Schema: ThruAllowedBandwidthInterval structure contains information about the configuration of the server and its health status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruAllowedBandwidthInterval"
}
}
}
}
}
}
},
"/Server/MessageSettings": {
"get": {
"tags": [
"Server"
],
"operationId": "getServerMessagesettings",
"summary": "Retrieve Message Settings",
"description": "Retrieves information about message settings in the server.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruMessageSettings — Schema: ThruMessageSettings structure contains information about the configuration of MFT messages.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruMessageSettings"
}
}
}
}
}
}
},
"/Server/PasswordSettings": {
"get": {
"tags": [
"Server"
],
"operationId": "getServerPasswordsettings",
"summary": "Retrieve Password Settings",
"description": "Retrieves information about password settings in the server\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruPasswordSettings — Schema: ThruPasswordSettings structure contains information about the configuration of the password strength, expiration, and lockout policies.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPasswordSettings"
}
}
}
}
}
}
},
"/Server/UploadSettings": {
"get": {
"tags": [
"Server"
],
"operationId": "getServerUploadsettings",
"summary": "Retrieve Upload Settings",
"description": "Retrieves information about upload settings in the server.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruUploadSettings — Schema: ThruUploadSettings structure contains information on upload settings.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruUploadSettings"
}
}
}
}
}
}
},
"/Server/MobileSettings": {
"get": {
"tags": [
"Server"
],
"operationId": "getServerMobilesettings",
"summary": "Retrieve Mobile settings",
"description": "Retrieves information about mobile settings in the server.\n\n",
"responses": {
"200": {
"description": "OK — Response type: ThruMobileSettings — Schema: ThruMobileSettings structure contains information on mobile application settings.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruMobileSettings"
}
}
}
}
}
}
},
"/ServerTool/ViewerRequest": {
"post": {
"tags": [
"ServerTool"
],
"operationId": "postServertoolViewerrequest",
"summary": "Create ServerTool ViewerRequest",
"description": "The call accepts ThruViewerRequest object and return shortID.\n\n",
"responses": {
"201": {
"description": "OK — Response type: ThruShortUrl — Schema: ThruShortUrl contains a string with the Short Key which is returned by View/Upload/Download requests and is used to call View/Upload/Download URL tools.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruShortUrl"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruViewerRequest"
},
"example": "ErrorReportingUrl=http%3A%2F%2FerrorUrlHere.com&FilePublicId=286YJBJMIZ24V&SessionId=U6tTDWRFvEPFwkLeCu%E2%80%A6.%2FHtFh&SuccessUrl=http%3A%2F%2FsuccessUrlhere.com"
}
},
"description": "Request body — Request type: ThruViewerRequest — Schema: ThruViewerRequest structure contains the input fields required for web service call ViewerRequest which returns a Short Key for the View URL tool."
}
}
},
"/ServerTool/UploaderRequest": {
"post": {
"tags": [
"ServerTool"
],
"operationId": "postServertoolUploaderrequest",
"summary": "Create ServerTool UploaderRequest",
"description": "The call accepts ThruUploaderRequest object and return shortID.\n\n",
"responses": {
"201": {
"description": "OK — Response type: ThruShortUrl — Schema: ThruShortUrl contains a string with the Short Key which is returned by View/Upload/Download requests and is used to call View/Upload/Download URL tools.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruShortUrl"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruUploaderRequest"
},
"example": "ErrorReportingUrl=http%3A%2F%2FerrorUrlHere.com&FileFilter=Zip+files+%28%5C.zip%2C+%5C.7z%2C+%5C.tar%29%3A+zip%2C+7z%2C+tar&FileFilterExceptions=exe%2C+com%2C+bat&FolderPublicId=286YJBJMIZ24V&SessionId=U6tTDWR+%E2%80%A6+%2FHtFh&SuccessUrl=http%3A%2F%2FsuccessUrlhere.com"
}
},
"description": "Request body — Request type: ThruUploaderRequest — Schema: ThruUploaderRequest structure contains the input fields required for web service call UploaderRequest which returns a Short Key for the Upload URL tool."
}
}
},
"/ServerTool/DownloaderRequest": {
"post": {
"tags": [
"ServerTool"
],
"operationId": "postServertoolDownloaderrequest",
"summary": "Create ServerTool DownloaderRequest",
"description": "The call accepts ThruDownloaderRequest object and return shortID.\n\n",
"responses": {
"201": {
"description": "OK — Response type: ThruShortUrl — Schema: ThruShortUrl contains a string with the Short Key which is returned by View/Upload/Download requests and is used to call View/Upload/Download URL tools.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruShortUrl"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruDownloaderRequest"
},
"example": "ErrorReportingUrl=http%3A%2F%2FerrorUrlHere.com&FilePublicIds=286YJBJMIZ24C&FolderPublicIds=286YJBJMIZ24V&SessionId=U6tTD%E2%80%A6.%2FHtFh&SuccessUrl=http%3A%2F%2FsuccessUrlhere.com"
}
},
"description": "Request body — Request type: ThruDownloaderRequest — Schema: ThruDownloaderRequest structure contains the input fields required for web service call DownloaderRequest which returns a Short Key for the Download URL tool."
}
}
},
"/Session": {
"post": {
"tags": [
"Session"
],
"operationId": "postSession",
"summary": "Create New Session Object",
"description": "Verify user credentials and authenticate MFT user in the system. Optionally passes external user information for audit purposes in UserString for the session opened. Device\\_UUID parameter is mandatory and can be set to any string.\n\n**Remarks**\n| UserName=Test&Password=Password&ClientVersion=1&ApplicationId=12&Device\\_UUID=Device1234&UserString=User |\n\n### Invocation Scenarios\nVerify customer credentials\nAuthenticate customer\n\n### Remarks\nUserName=Test&Password=Password&ClientVersion=1&ApplicationId=12&Device\\_UUID=Device1234&UserString=User",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicSession — Schema: ThruPublicSession structure contains authorization information about user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSession"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruSessionRequest"
},
"example": "ApplicationId=12&ClientVersion=1&Device%5CUUID=Device1234&Password=Password&UserName=Test&UserString=Name+%2F+email%40domain.com"
}
},
"description": "Request body — Request type: ThruSessionRequest — Schema: ThruSessionRequest structure contains information required for the MFT user authentication."
},
"security": []
},
"delete": {
"tags": [
"Session"
],
"operationId": "deleteSession",
"summary": "Delete Existing Session Object",
"description": "Logs out MFT customer from the system.\n\n",
"responses": {
"200": {
"description": "None"
}
},
"security": []
},
"get": {
"tags": [
"Session"
],
"operationId": "getSession",
"summary": "Check Existing Session Object",
"description": "Check if customer is authenticated.\n\n",
"responses": {
"200": {
"description": "None"
}
},
"security": []
}
},
"/SessionByTicket": {
"post": {
"tags": [
"SessionByTicket"
],
"operationId": "postSessionbyticket",
"summary": "Create new Session object by Ticket",
"description": "Verify user credentials and authenticate MFT user in the system with regular session\n\n**Remarks**\n| Example request: UserName=admin&Password=password&
ClientVersion=1&ApplicationId=12 |",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicSession — Schema: ThruPublicSession structure contains authorization information about user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSession"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruSessionByTicketRequest"
}
}
},
"description": "Request body — Request type: ThruSessionByTicketRequest — Schema: ThruSessionByTicketRequest structure contains information required for the MFT user authentication"
},
"security": []
}
},
"/SystemLog/{operationId}": {
"parameters": [
{
"$ref": "#/components/parameters/operationId"
}
],
"post": {
"tags": [
"Systemlog"
],
"operationId": "postSystemlogByOperationid",
"summary": "Create System Log Operation",
"description": "Add new log operation based on the provided ThruPublicSystemLogOperation structure.\n\n### Invocation Scenarios\nAdd new system log data.",
"responses": {
"201": {
"description": "OK — Response type: ThruPublicSystemLogOperation — Schema: ThruPublicSystemLogOperation structure contains information operation that will be logged in MFT.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSystemLogOperation"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSystemLogOperation"
},
"example": "LogOperationId=1UEVYEHGF7GVW&OperationType=67108864&FolderId=0QN8H2VKTGIWE&FileId=30FZAAT6ULN30&MobileReceiverAppName=test"
}
},
"description": "Request body — Request type: ThruPublicSystemLogOperation — Schema: ThruPublicSystemLogOperation structure contains information operation that will be logged in MFT."
}
}
},
"/User/Info": {
"get": {
"tags": [
"User"
],
"operationId": "getUserInfo",
"summary": "Retrieve User Information",
"description": "Get information about currently logged user.\n\n### Invocation Scenarios\nGet information about user.",
"responses": {
"200": {
"description": "OK — Response type: ThruPublicUserInfo — Schema: ThruPublicUserInfo structure contains information about MFT user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicUserInfo"
}
}
}
}
}
}
},
"/User/Password": {
"put": {
"tags": [
"User"
],
"operationId": "putUserPassword",
"summary": "Update password for the User",
"description": "Set new password for the user.\n\n",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPasswordInfo"
},
"example": "ConfirmPassword=%5Cpassword1&NewPassword=%5Cpassword1&OldPassword=password"
}
},
"description": "Request body — Request type: ThruPasswordInfo — Schema: ThruPasswordInfo structure contains information that is required for password change."
},
"responses": {
"200": {
"description": "None"
}
}
}
},
"/UserGroups/{groupId}": {
"parameters": [
{
"$ref": "#/components/parameters/groupId"
}
],
"put": {
"tags": [
"UserGroups"
],
"operationId": "putUsergroupsByGroupid",
"summary": "Update UserGroup",
"description": "Update group data by a group ID. \n\n ### Remarks \n\n GroupID is required in 2 places: on the URL and in the object `ThruPublicGroupInfo`. \n\n `GroupID` value on URL is used, the value in `ThruPublicGroupInfo` is ignored.",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruPublicGroupInfo"
},
"example": "Description=Cust1+Group&Id=1Q1OBQWVHTROE&ModifyRole=4&Name=Group1&UserGroupType=16"
}
},
"description": "Request body — Request type: ThruPublicGroupInfo — Schema: ThruPublicGroupInfo structure contains information about MFT file sharing user account."
},
"responses": {
"200": {
"description": "None"
}
}
}
},
"/{MFTWebServer}/REST/ServerVersion": {
"parameters": [
{
"$ref": "#/components/parameters/MFTWebServer"
}
],
"get": {
"tags": [
"ServerVersion"
],
"operationId": "getByMftwebserverRestServerversion",
"summary": "Retrieve Information about Server Version",
"description": "Gets information about version of MFT server.\n\n**Remarks**\n| Example:
Server version 9.10.7.41914
Return:
Major: 9
Minor:10
Buildnumber: 7
Suffix: \"\"
Revision: 41914 |\n\n### Invocation Scenarios\nGet version.\n\n### Remarks\nExample:\nServer version 9.10.7.41914\nReturn:\nMajor: 9\nMinor:10\nBuildnumber: 7\nSuffix: \"\"\nRevision: 41914",
"responses": {
"200": {
"description": "OK — Response type: ThruServerVersion — Schema: ThruServerVersion structure contains information about version of ThruServer.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruServerVersion"
}
}
}
}
}
}
},
"/{MFTWebServer}/REST/ServiceVersions": {
"parameters": [
{
"$ref": "#/components/parameters/MFTWebServer"
}
],
"get": {
"tags": [
"ServiceVersions"
],
"operationId": "getByMftwebserverRestServiceversions",
"summary": "Information about Service Versions",
"description": "Gets information about versions of REST services in the ThruServer.\n\n### Invocation Scenarios\nGet list of services and their versions.",
"responses": {
"200": {
"description": "OK — Response type: ThruServiceVersionsResult — Schema: ThruServiceVersionsResult structure contains information about versions of REST services in the ThruServer.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruServiceVersionsResult"
}
}
}
}
}
}
},
"/{MFTWebServer}/REST/{version}/UserGroups": {
"parameters": [
{
"$ref": "#/components/parameters/version"
},
{
"$ref": "#/components/parameters/MFTWebServer"
}
],
"get": {
"tags": [
"UserGroups"
],
"operationId": "getUsergroups",
"summary": "List User Groups",
"description": "List all groups in the site",
"responses": {
"200": {
"description": "OK — Response type: ThruCollectionResult",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruCollectionResult"
}
}
}
}
}
}
},
"/UserGroups/{groupId}/Users": {
"parameters": [
{
"$ref": "#/components/parameters/groupId"
},
{
"$ref": "#/components/parameters/version"
},
{
"$ref": "#/components/parameters/MFTWebServer"
}
],
"get": {
"tags": [
"UserGroups"
],
"operationId": "getUsergroupsByGroupidUsers",
"summary": "List users in a User Group",
"description": "List users in a User Group by userGroupID",
"responses": {
"200": {
"description": "OK — Response type: ThruCollectionResult",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruCollectionResult"
}
}
}
}
}
}
},
"/UserGroups/{groupId}/Users/{userId}": {
"parameters": [
{
"$ref": "#/components/parameters/groupId"
},
{
"$ref": "#/components/parameters/version"
},
{
"$ref": "#/components/parameters/MFTWebServer"
},
{
"$ref": "#/components/parameters/userId"
}
],
"post": {
"tags": [
"UserGroups"
],
"operationId": "postUsergroupsByGroupidUsersByUserid",
"summary": "Add User to User Group",
"description": "Add User to UserGroup using UserID and UserGroupID",
"responses": {
"200": {
"description": "None"
}
}
},
"delete": {
"tags": [
"UserGroups"
],
"operationId": "deleteUsergroupsByGroupidUsersByUserid",
"summary": "Delete user from a User Group",
"description": "Delete user from a User Group using UserID and UserGroupID",
"responses": {
"200": {
"description": "None"
}
}
}
},
"/Users": {
"parameters": [
{
"$ref": "#/components/parameters/version"
},
{
"$ref": "#/components/parameters/MFTWebServer"
}
],
"get": {
"tags": [
"Users"
],
"operationId": "getUsers",
"summary": "List users",
"description": "List users in the site with filters in querystring. \n\n **Request Query Params:** \n\n `?name=&email=&company=&roles=&active=` \n\n ### Remarks \n\n API does not return deleted users.",
"responses": {
"200": {
"description": "OK — Response type: ThruCollectionResult",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruCollectionResult"
}
}
}
}
},
"parameters": [
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "company",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "roles",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/REST/1.0/FileSystem/Folder/{folderId}/Permissions": {
"get": {
"tags": [
"FolderPermissions"
],
"operationId": "FolderPermissionList",
"summary": "List folder permissions",
"description": "List folder permissions",
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Folder ID"
}
],
"responses": {
"200": {
"description": "Successful operation"
}
}
}
},
"/REST/1.0/FileSystem/Folder/{folderId}/Permission/User/{userId}": {
"post": {
"tags": [
"FolderPermissions"
],
"operationId": "UserFolderPermissionAdd",
"summary": "Add folder permission for a user",
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"Permission": {
"type": "string",
"description": "Permission level code"
}
},
"required": [
"Permission"
]
},
"example": {
"Permission": "8"
}
}
}
},
"responses": {
"200": {
"description": "Permission added"
}
}
}
},
"/REST/1.0/FileSystem/Folder/{folderId}/Permission/UserGroup/{userGroupId}": {
"post": {
"tags": [
"FolderPermissions"
],
"operationId": "UserGroupFolderPermissionAdd",
"summary": "Add folder permission for a user group",
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userGroupId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"Permission": {
"type": "string",
"description": "Permission level code"
}
},
"required": [
"Permission"
]
},
"example": {
"Permission": "8"
}
}
}
},
"responses": {
"200": {
"description": "Permission added"
}
}
}
},
"/REST/1.0/FileSystem/Folder/{folderId}/Permission/{permissionId}": {
"put": {
"tags": [
"FolderPermissions"
],
"operationId": "FolderPermissionUpdate",
"summary": "Update a folder permission",
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "permissionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"permission": {
"type": "string",
"description": "Permission level code"
}
},
"required": [
"permission"
]
},
"example": {
"permission": "8"
}
}
}
},
"responses": {
"200": {
"description": "Permission updated"
}
}
},
"delete": {
"tags": [
"FolderPermissions"
],
"operationId": "FolderPermissionDelete",
"summary": "Delete one or more folder permissions",
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "permissionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"additionalProperties": true,
"description": "Accepts a form-encoded set of Items[n][Permission], Items[n][UserID]/[UserGroupID], and Items[n][FolderID]"
},
"example": {
"Items[2][Permission]": "8",
"Items[2][UserID]": "0GTPV115Q5DEQ",
"Items[2][FolderID]": "2DRPJYLZC2Z3O",
"Items[1][Permission]": "254",
"Items[1][UserID]": "1UBRSWNZCJDCS",
"Items[1][FolderID]": "2DRPJYLZC2Z3O",
"Items[0][Permission]": "254",
"Items[0][UserGroupID]": "2VGV8HHIRVUT7",
"Items[0][FolderID]": "1BNZAOJZUQ5TI"
}
}
}
},
"responses": {
"200": {
"description": "Permission(s) deleted"
}
}
}
},
"/Upload/MarkGuid/": {
"post": {
"operationId": "postUploadMarkguid",
"summary": "Create Mark GUID",
"description": "Mark uploaded files or folders during session by unique identifier and return it.\nCreate and store unique GUID to apply automatically to all files and folders uploaded under SessionID after the web service is called (marking). Call returns unique GUID used to mark all uploaded files in one upload transaction using the API upload dialog tool. Marking of uploaded files will stop when the last file in the batch is uploaded by API upload dialog tool. \nFiles marked by the GUID can be retrieved by the call RetrieveUploadInfoCleanUp.",
"tags": [
"Upload"
],
"parameters": [],
"responses": {
"200": {
"description": "OK — Response type: MarkForRetrievalUploadInfo",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkForRetrievalUploadInfo"
}
}
}
}
}
}
},
"/Upload/MetadataStore/": {
"post": {
"operationId": "postUploadMetadatastore",
"summary": "Store metadata",
"description": "Store metadata to apply automatically to all files and folders uploaded under the current user session after the method is called. Metadata will be cleared when session is deleted, expires or by call the MetadataClear method. \n\n Example request:\n `metadataobjects[0].Key=key1&metadataobjects[0].Value=value1&metadataobjects[1].Key=key2&metadataobjects[1].Value=value2`",
"tags": [
"Upload"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/MetadataKeyValueCollection"
},
"example": "metadataobjects[0].Key=key1&metadataobjects[0].Value=value1&metadataobjects[1].Key=key2&metadataobjects[1].Value=value2"
}
},
"description": "Request body — Request type: MetadataKeyValueCollection — Schema: ThruPublicFileInfo structure contains information about file in MFT FS file system."
},
"responses": {
"200": {
"description": "OK — Response type: PublicStoreMetadataItemInfo",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicStoreMetadataItemInfo"
}
}
}
}
}
}
},
"/Upload/RetrieveUploadInfoCleanUp/{uploadedMetadataValue}": {
"get": {
"operationId": "getUploadRetrieveuploadinfocleanupByUploadedmetadatavalue",
"summary": "Retrieve upload info cleanup by uploaded metadata value",
"description": "The call returns an array of file metadata structures for each uploaded, see ThruPublicUploadInfo structure description for details. Parameter uploadedMetadataValue can be set to GUID returned by MarkGuid call or other metadata set by MetadataStore call to retrieve files marked by the metadata. The call method removes marker metadata from the system (TBL_FILE_METADATA table). \n\n ### Invocation scenario \n Return an array of file metadata structures for each uploaded file and folder, and remove marker metadata from the file system.",
"tags": [
"Upload"
],
"parameters": [],
"responses": {
"200": {
"description": "OK — Response type: ThruPublicUploadInfo",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicUploadInfo"
}
}
}
}
}
}
},
"/Upload/MetadataClear/": {
"delete": {
"operationId": "deleteUploadMetadataclear",
"summary": "Clear metadata",
"description": "Clear metadata that was set by the method MetadataStore and applies to all uploaded files and folders. After the method is called, metadata is no longer applied to files and folders.",
"tags": [
"Upload"
],
"parameters": [],
"responses": {
"200": {
"description": "None"
}
}
}
},
"/ImmutableImpersonateSession": {
"post": {
"summary": "Create Impersonated Session",
"operationId": "createImpersonatedSession",
"description": "Creates an immutable session impersonating the specified user.",
"tags": [
"ImmutableImpersonateSession"
],
"parameters": [
{
"name": "X-Thru-SessionId",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Session ID of the administrator making the request. "
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ThruSessionImpersonateRequest"
},
"example": "UserID={encryptedUserId}&ApplicationID=25674"
}
}
},
"responses": {
"200": {
"description": "Successfully created impersonated session.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThruPublicSession"
}
}
}
},
"400": {
"description": "Invalid Application ID.",
"content": {
"application/json": {
"example": {
"ErrorCode": 177,
"Message": "Application does not exist."
}
}
}
},
"403": {
"description": "Non-Administrator Session.",
"content": {
"application/json": {
"example": {
"ErrorCode": 90000,
"Message": "Administrator's session ID must belong to a user with an administrator role."
}
}
}
}
}
}
}
},
"components": {
"callbacks": {},
"examples": {},
"headers": {},
"links": {},
"parameters": {
"fileId": {
"name": "fileId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"folderId": {
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"groupId": {
"name": "groupId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"messageId": {
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"operationId": {
"name": "operationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"skip": {
"name": "skip",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"take": {
"name": "take",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"MFTWebServer": {
"name": "MFTWebServer",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"type": {
"name": "type",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"userId": {
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"version": {
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
},
"pathItems": {},
"requestBodies": {},
"responses": {},
"schemas": {
"Subject": {
"type": "object",
"description": "DUMMY schema for Subject. Replace with real fields."
},
"SyncPolicy": {
"type": "object",
"description": "SyncPolicy structure contains information about the configuration of the server and its health status",
"properties": {
"DeleteSynchedLocalFilesOnAccountDisabled": {
"type": "boolean",
"description": "Settings for Sync client: indicate client to delete local files if user account is disabled on server",
"example": true
},
"DeleteSynchedLocalFilesOnAccountDeletion": {
"type": "boolean",
"description": "Settings for Sync client: indicate client to delete local files if user account is deleted on server",
"example": true
},
"SavePasswordLocal": {
"type": "boolean",
"description": "Settings for Sync client: indicate client to store user password for MFT server on local machine",
"example": true
},
"FullSyncIntervalMinutes": {
"type": "boolean",
"description": "Settings for Sync client: interval between calls for full sync",
"example": true
}
},
"required": [
"DeleteSynchedLocalFilesOnAccountDeletion",
"DeleteSynchedLocalFilesOnAccountDisabled",
"FullSyncIntervalMinutes",
"SavePasswordLocal"
]
},
"ThruAllowedBandwidth": {
"type": "object",
"description": "ThruAllowedBandwidth structure contains information about the configuration of the server and its health status",
"properties": {
"MaxAllowedBandwidthKBps": {
"type": "string",
"description": "Max allowed bandwidth for client in Kbits/s",
"example": "1024"
}
},
"required": [
"MaxAllowedBandwidthKBps"
]
},
"ThruAllowedBandwidthInterval": {
"type": "object",
"description": "ThruAllowedBandwidthInterval structure contains information about the configuration of the server and its health status",
"properties": {
"AllowedBandwidthRequestIntervalMB": {
"type": "string",
"description": "Interval in MB between calls to retrieve actual value of ThruAllowedBandwidth",
"example": "100"
}
},
"required": [
"AllowedBandwidthRequestIntervalMB"
]
},
"ThruCollectionResult": {
"type": "object",
"properties": {
"Count": {
"type": "integer",
"format": "int32",
"description": "Number of Items in collection",
"example": 4
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicUserInfo"
},
"description": "Collection"
}
},
"required": [
"Count",
"Items"
]
},
"ThruDownloaderRequest": {
"type": "object",
"description": "ThruDownloaderRequest structure contains the input fields required for web service call DownloaderRequest which returns a Short Key for the Download URL tool.",
"properties": {
"SessionId": {
"type": "string",
"description": "Session ID for file download",
"example": "U6tTD…./HtFh"
},
"FolderPublicIds": {
"type": "string",
"description": "Array of folders IDs which will be downloaded. Folders are downloaded as part of a zip archive",
"example": "286YJBJMIZ24V"
},
"FilePublicIds": {
"type": "string",
"description": "Array of file IDs. If multiple IDs included, files are downloaded as a zip",
"example": "286YJBJMIZ24C"
},
"SuccessUrl": {
"type": "string",
"description": "Success url",
"example": "http://successUrlhere.com"
},
"ErrorReportingUrl": {
"type": "string",
"description": "Error url",
"example": "http://errorUrlHere.com"
}
},
"required": [
"ErrorReportingUrl",
"FilePublicIds",
"FolderPublicIds",
"SessionId",
"SuccessUrl"
]
},
"ThruMessageSettings": {
"type": "object",
"description": "ThruMessageSettings structure contains information about the configuration of MFT messages.",
"properties": {
"SeparateEmailsLimit": {
"type": "integer",
"format": "int32",
"description": "For tracking purposes, the system creates separate emails per recipient if the message requires a link to MFT server and request login is turned off. This parameter prevents massive email generation.",
"example": 1000
},
"SmtpServerRecipientLimit": {
"type": "integer",
"format": "int32",
"description": "If your SMTP server has a limit, and the limit is entered here, MFT server will block messages which exceed the limit. If the limit is NOT entered here, and a message exceeds recipient limit, SMTP server will send the message with a partial recipient list and the user will get an error message.",
"example": 0
},
"MsgRequestLoginType": {
"type": "integer",
"format": "int32",
"description": "1 – Never (No registration for external download) 2 – Always (external download always requires registration) 3 – User Choice (request login is turned off by default but the user can turn it on when sending a message)",
"example": 3
},
"MsgRequestloginUserChoiceDefault": {
"type": "boolean",
"description": "If request recipient login is ‘User Choice’ – turn on request login as default value for a new message.",
"example": false
},
"ExpiredMsgNotificationEnabled": {
"type": "boolean",
"description": "Enable expired message notification",
"example": true
},
"WebUseMsgPwdInsteadOfRequestLogin": {
"type": "boolean",
"description": "On the web interface, use message password instead of recipient login. This option only allowed if Request recipient login’ is ‘Never’.",
"example": false
},
"DefaultExpirationIntervalDays": {
"type": "integer",
"format": "int32",
"description": "Default expiration interval in Days",
"example": 10
},
"AllowSetAfterDefaultExpirationInterval": {
"type": "boolean",
"description": "Allow to specify the message expiration interval larger than default",
"example": false
}
},
"required": [
"AllowSetAfterDefaultExpirationInterval",
"DefaultExpirationIntervalDays",
"ExpiredMsgNotificationEnabled",
"MsgRequestLoginType",
"MsgRequestloginUserChoiceDefault",
"SeparateEmailsLimit",
"SmtpServerRecipientLimit",
"WebUseMsgPwdInsteadOfRequestLogin"
]
},
"ThruMobileSettings": {
"type": "object",
"description": "ThruMobileSettings structure contains information on mobile application settings.",
"properties": {
"SessionRecheckIntervalSeconds": {
"type": "integer",
"format": "int32",
"example": 60
},
"EnableOpenInAnotherApplication": {
"type": "boolean",
"example": true
},
"LocalSessionOfflineLifetimeSeconds": {
"type": "integer",
"format": "int32",
"example": 180
},
"MobilePolicyUpdateIntervalSeconds": {
"type": "integer",
"format": "int32",
"example": 300
}
},
"required": [
"EnableOpenInAnotherApplication",
"LocalSessionOfflineLifetimeSeconds",
"MobilePolicyUpdateIntervalSeconds",
"SessionRecheckIntervalSeconds"
]
},
"ThruPasswordInfo": {
"type": "object",
"description": "ThruPasswordInfo structure contains information that is required for password change.",
"properties": {
"OldPassword": {
"type": "string",
"description": "Current user password",
"example": "password"
},
"NewPassword": {
"type": "string",
"description": "New password that is required to set",
"example": "\\password1"
},
"ConfirmPassword": {
"type": "string",
"description": "Confirmation of the New password field",
"example": "\\password1"
}
},
"required": [
"ConfirmPassword",
"NewPassword",
"OldPassword"
]
},
"ThruPasswordSettings": {
"type": "object",
"description": "ThruPasswordSettings structure contains information about the configuration of the password strength, expiration, and lockout policies.",
"properties": {
"AutomaticExpiration": {
"type": "boolean",
"description": "Enable/Disable automatic password expiration",
"example": true
},
"ExpirationDays": {
"type": "integer",
"format": "int32",
"description": "Expiration days",
"example": 10
},
"ExpirationWarningNotificationDays": {
"type": "integer",
"format": "int32",
"description": "Send expiration warning notification – warning days",
"example": 0
},
"AutomaticLoginLockout": {
"type": "boolean",
"description": "Enable/Disable automatic login lockout",
"example": true
},
"MaxLoginAttempts": {
"type": "integer",
"format": "int32",
"description": "Max login attempts",
"example": 5
},
"LockoutDurationSeconds": {
"type": "integer",
"format": "int32",
"description": "Lockout duration seconds",
"example": 20
},
"BlockPreviousPasswords": {
"type": "boolean",
"description": "Do not allow reuse of previous passwords",
"example": false
},
"PreviousPasswordCount": {
"type": "integer",
"format": "int32",
"description": "Number of previous passwords to check",
"example": 3
},
"MinimumPasswordLength": {
"type": "integer",
"format": "int32",
"description": "Minimum password length",
"example": 6
},
"RequireSpecialCharacter": {
"type": "boolean",
"description": "At least one special character required",
"example": false
},
"RequireLetter": {
"type": "boolean",
"description": "At least one letter required",
"example": false
},
"RequireDigit": {
"type": "boolean",
"description": "At least one digit required",
"example": false
},
"RequireUppercaseLetter": {
"type": "boolean",
"description": "At least one uppercase letter required",
"example": false
},
"RequireLowercaseLetter": {
"type": "boolean",
"description": "At least one lowercase letter required",
"example": false
}
},
"required": [
"AutomaticExpiration",
"AutomaticLoginLockout",
"BlockPreviousPasswords",
"ExpirationDays",
"ExpirationWarningNotificationDays",
"LockoutDurationSeconds",
"MaxLoginAttempts",
"MinimumPasswordLength",
"PreviousPasswordCount",
"RequireDigit",
"RequireLetter",
"RequireLowercaseLetter",
"RequireSpecialCharacter",
"RequireUppercaseLetter"
]
},
"ThruPublicAuditFileSystemTransactionAction": {
"type": "object",
"description": "ThruPublicAuditFileSystemTransactionAction structure contains the extended list of properties which can be filled for FileSystem Log Operations. Depending on operation type some values will be equal to NULL and will not be returned in the response.",
"properties": {
"FileSystemLogOpId": {
"type": "string",
"description": "Identifier of Log Operation",
"example": "1Q1OBQWVHTROE"
},
"FileSystemLogId": {
"type": "string",
"description": "Identifier of Log Item",
"example": "1Q1OBQWVHTROM"
},
"UserID": {
"type": "string",
"description": "Identifier of User",
"example": "1Q1TUBQWVHJGD"
},
"UserFullName": {
"type": "string",
"description": "User’s first name",
"example": "Ad"
},
"UserEmail": {
"type": "string",
"description": "User’s last name",
"example": "Test"
},
"Operation": {
"type": "string",
"description": "Operation Id",
"example": "int"
},
"OperationName": {
"type": "string",
"description": "Operation Name",
"example": "Internal Upload"
},
"ClientIPAddress": {
"type": "string",
"description": "User’s client IP address"
},
"OperationDateCreated": {
"type": "string",
"format": "date-time",
"description": "Log Operation’s date create (UTC) in Unix epoch format including slashes",
"example": "/Date(1337174868567)/"
},
"Note": {
"type": "string",
"description": "Operation’s note"
},
"ApplicationName": {
"type": "string",
"description": "Application name for the log operation",
"example": "Web"
},
"ApplicationShortName": {
"type": "string",
"description": "Application short name for the log operation",
"example": "Web"
},
"IsTop": {
"type": "boolean",
"description": "Log item hierarchy placement.",
"example": true
},
"LogDateCreated": {
"type": "string",
"format": "date-time",
"description": "Log Item’s date create (UTC) in Unix epoch format including slashes",
"example": "/Date(1343838136630)/"
},
"Status": {
"type": "boolean",
"description": "Indicates success/failure status of log item",
"example": true
},
"Name": {
"type": "string",
"description": "Log Item name, e.g. file name or folder name",
"example": "Test.jpg"
},
"NextName": {
"type": "string",
"description": "New name for the log item’s name",
"example": "NewTest.jpg"
},
"PreviousName": {
"type": "string",
"description": "Previous name for the log item’s name",
"example": "Test.jpg"
},
"Path": {
"type": "string",
"description": "Path to the item",
"example": "/FODLERS/COMMON/Test.jpg"
},
"NextPath": {
"type": "string",
"description": "New path to the item",
"example": "/FODLERS/COMMON/New Folder/"
},
"PreviousPath": {
"type": "string",
"description": "Old path to the item",
"example": "/FODLERS/COMMON//Test.jpg"
},
"Description": {
"type": "string",
"description": "Item’s description",
"example": "New description"
},
"PreviousDescription": {
"type": "string",
"description": "Item’s previous description",
"example": "description"
},
"FolderPermission": {
"type": "string",
"description": "None \\= 0x00, // 0 Show \\= 0x01, // 1 Read \\= 0x02, // 2 Create \\= 0x04, // 4 Download \\= 0x08, // 8 Distribute \\= 0x010, // 16 Manage \\= 0x020, // 32 Modify \\= 0x040, // 64 Delete \\= 0x080, // 128 FullControl = Read \\",
"example": "7"
},
"PreviousFolderPermission": {
"type": "string",
"description": "Previous permission for the item",
"example": "3"
},
"RelatedUserEmail": {
"type": "string",
"description": "Related user's email for the operation",
"example": "Testuser@abc.com"
},
"RelatedUserName": {
"type": "string",
"description": "Related user's name for the operation",
"example": "User A"
},
"RelatedUserId": {
"type": "string",
"description": "Identifier of Related User",
"example": "1Q1TUBQWVHJFF"
},
"Size": {
"type": "integer",
"format": "int64",
"description": "Item size in bites",
"example": 100
},
"FileId": {
"type": "string",
"description": "File ID",
"example": "331TUBQWVHJFF"
},
"FolderId": {
"type": "string",
"description": "Folder ID",
"example": "131TUBQWVHJFF"
},
"PartialUpload": {
"type": "boolean",
"description": "Indicates incomplete upload for an item",
"example": false
},
"ExternalUserEmail": {
"type": "string",
"description": "Email of external user which belong to the operation",
"example": "Extuser@abc.com"
},
"Priority": {
"type": "string",
"description": "Only for Secure Message High Normal Low",
"example": "High"
},
"DateDeleted": {
"type": "string",
"format": "date-time",
"description": "Only for Secure Message Message delete date in Unix epoch format including slashes",
"example": "/Date(1343838136630)/"
},
"DateExpire": {
"type": "string",
"format": "date-time",
"description": "Only for Secure Message Message expire date in Unix epoch format including slashes",
"example": "/Date(1343838136630)/"
},
"DateSent": {
"type": "string",
"format": "date-time",
"description": "Only for Secure Message Message sent date in Unix epoch format including slashes",
"example": "/Date(1343838136630)/"
},
"IsExpired": {
"type": "boolean",
"description": "Only for Secure Message Is message expired",
"example": false
},
"NotifyFlag": {
"type": "boolean",
"description": "Only for Secure Message Notification required flag",
"example": false
},
"Subject": {
"type": "string",
"description": "Only for Secure Message Message Subject",
"example": "Test"
},
"TrackingNo": {
"type": "string",
"description": "Only for Secure Message Message Tracking Id",
"example": "T478-014-93928-94469"
},
"AgreementID": {
"type": "string",
"description": "Only for Secure Message Reference to Agreement Id used for the message",
"example": "1214"
},
"IsProtected": {
"type": "boolean",
"description": "Only for Secure Message Indicates if message protected or not",
"example": true
},
"RequestRecipientLogin": {
"type": "boolean",
"description": "Only for Secure Message Indicates if message requires recipient login",
"example": true
}
},
"required": [
"AgreementID",
"ApplicationName",
"ApplicationShortName",
"DateDeleted",
"DateExpire",
"DateSent",
"Description",
"ExternalUserEmail",
"FileId",
"FileSystemLogId",
"FileSystemLogOpId",
"FolderId",
"FolderPermission",
"IsExpired",
"IsProtected",
"IsTop",
"LogDateCreated",
"Name",
"NextName",
"NextPath",
"NotifyFlag",
"Operation",
"OperationDateCreated",
"OperationName",
"PartialUpload",
"Path",
"PreviousDescription",
"PreviousFolderPermission",
"PreviousName",
"PreviousPath",
"Priority",
"RelatedUserEmail",
"RelatedUserId",
"RelatedUserName",
"RequestRecipientLogin",
"Size",
"Status",
"Subject",
"TrackingNo",
"UserEmail",
"UserFullName",
"UserID"
]
},
"ThruPublicAuditUserAction": {
"type": "object",
"title": "ThruPublicAuditUserAction",
"description": "ThruPublicAuditUserAction structure contains the extended list of properties which can be filled for User Log Operations. Depending of operation type some of them will be equal to NULL.",
"properties": {
"UserLogID": {
"type": "string",
"description": "Identifier of Log Operation",
"example": "1Q1OBQWVHTROE"
},
"UserID": {
"type": "string",
"description": "Identifier of User",
"example": "1Q1TUBQWVHJGD"
},
"UserFullName": {
"type": "string",
"description": "User’s full name",
"example": "A B"
},
"UserEmail": {
"type": "string",
"description": "User’s last name",
"example": "Test"
},
"OperationId": {
"type": "string",
"description": "Operation Id",
"example": "1"
},
"OperationName": {
"type": "string",
"description": "Operation Name",
"example": "Authenticate User"
},
"ClientIPAddress": {
"type": "string",
"description": "User’s client IP address"
},
"ClientVersion": {
"type": "string"
},
"DeviceUID": {
"type": "string"
},
"ApplicationID": {
"type": "string",
"example": "1"
},
"ApplicationName": {
"type": "string",
"example": "Web Edition"
},
"SSOFlag": {
"type": "boolean",
"example": true
},
"IsApproved": {
"type": "boolean",
"example": true
},
"AgreementID": {
"type": "string"
},
"AuthStatus": {
"type": "string",
"example": "Approved"
},
"DateCreated": {
"type": "string",
"format": "date-time",
"description": "Log Operation’s date create (UTC) in Unix epoch format including slashes",
"example": "/Date(1337174868567)/"
},
"PerformedByUserID": {
"type": "string",
"description": "Identifier of User who performed the operation",
"example": "1Q1TUBQWVHJGD"
},
"PerformedByUserFullName": {
"type": "string",
"description": "User’s full name who performed the operation",
"example": "T C"
},
"PerformedByUserEmail": {
"type": "string",
"description": "User’s email who performed the operation",
"example": "TC@abc.com"
},
"Note": {
"type": "string",
"description": "Operation Note"
}
},
"required": [
"ApplicationID",
"ApplicationName",
"AuthStatus",
"DateCreated",
"IsApproved",
"OperationId",
"OperationName",
"PerformedByUserEmail",
"PerformedByUserFullName",
"PerformedByUserID",
"SSOFlag",
"UserEmail",
"UserFullName",
"UserID",
"UserLogID"
]
},
"ThruPublicAuditUserGroupAction": {
"type": "object",
"description": "ThruPublicAuditUserGroupAction structure contains the extended list of properties which can be filled for User Group Log Operations. Depending of operation type some of them will be equal to NULL.",
"properties": {
"UserGroupLogID": {
"type": "string",
"description": "Identifier of Log Operation",
"example": "1Q1OBQWVHTROE"
},
"UserID": {
"type": "string",
"description": "Identifier of User",
"example": "1Q1TUBQWVHJGD"
},
"UserGroupID": {
"type": "string",
"description": "Identifier of User Group",
"example": "1Q1TUBQWVHJGD"
},
"UserFullName": {
"type": "string",
"description": "User’s full name",
"example": "A B"
},
"UserEmail": {
"type": "string",
"description": "User’s last name",
"example": "Test"
},
"Operation": {
"type": "string",
"description": "Operation Id",
"example": "int"
},
"OperationName": {
"type": "string",
"description": "Operation Name",
"example": "Internal Upload"
},
"ClientIPAddress": {
"type": "string",
"description": "User’s client IP address"
},
"DateCreated": {
"type": "string",
"format": "date-time",
"description": "Log Operation’s date create (UTC)",
"example": "/Date(1337174868567)/"
},
"PerformedByUserID": {
"type": "string",
"description": "Identifier of User who performed the operation",
"example": "1Q1TUBQWVHJGD"
},
"PerformedByUserFullName": {
"type": "string",
"description": "User’s full name who performed the operation",
"example": "T C"
},
"PerformedByUserEmail": {
"type": "string",
"description": "User’s email who performed the operation",
"example": "TC@abc.com"
},
"PreviousGroupName": {
"type": "string",
"description": "Group name before rename",
"example": "Group1"
},
"GroupModifierRole": {
"type": "string",
"description": "User’s role who can modify the group",
"example": "Administrator"
},
"GroupName": {
"type": "string",
"description": "Group name",
"example": "Group2"
},
"PreviousGroupModifierRole": {
"type": "string",
"description": "Previous user’s role who can modify the group",
"example": "Test.jpg"
}
},
"required": [
"DateCreated",
"GroupModifierRole",
"GroupName",
"Operation",
"OperationName",
"PerformedByUserEmail",
"PerformedByUserFullName",
"PerformedByUserID",
"PreviousGroupModifierRole",
"PreviousGroupName",
"UserEmail",
"UserFullName",
"UserGroupID",
"UserGroupLogID",
"UserID"
]
},
"ThruPublicContentResult": {
"type": "object",
"description": "ThruPublicContentResult structure contains information about the content of the MFT FSfolder.",
"properties": {
"Files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicFileInfo"
},
"description": "Collection of file information structures"
},
"Folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
},
"description": "Collection of folder information structures"
}
}
},
"ThruPublicFileInfo": {
"type": "object",
"description": "ThruPublicFileInfo structure contains information about file in MFT FS file system.",
"properties": {
"FileID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number for the file in MFT FS file system",
"example": "2OMFYXLA6BP9D"
},
"ParentFolderID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the parent folder for the file in MFT FS file system",
"example": "1UTXM50KW0ISP"
},
"Name": {
"type": "string",
"description": "Name of the file",
"example": "2.html"
},
"Description": {
"type": "string",
"description": "Description of the file"
},
"Path": {
"type": "string",
"description": "Path to the file in folder tree",
"example": "FOLDERS/HOME/Admin/My Documents/2.html"
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of keywords associated with the current folder"
},
"Size": {
"type": "integer",
"format": "int64",
"description": "Size of the file",
"example": 198
},
"EffectivePermission": {
"type": "integer",
"format": "int32",
"description": "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",
"example": 254
},
"DateCreated": {
"type": "string",
"format": "date-time",
"description": "Date and time when file has been created in MFT file system (UTC)",
"example": "/Date(1346072694480)/"
},
"DateModified": {
"type": "string",
"format": "date-time",
"description": "Date and time when file last has been updated (UTC)",
"example": "/Date(1346072694480)/"
},
"CreatedByUserID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the user that has added file to MFT file system",
"example": "1Q1OBQWVHTROE"
},
"ModifiedByUserID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the user that last accessed the file",
"example": "1Q1OBQWVHTROE"
},
"IsQuarantined": {
"type": "boolean",
"description": "Indicates is file has been quarantined",
"example": false
},
"InFavorite": {
"type": "boolean",
"description": "Indicates is file marked as favorite",
"example": false
},
"IsPartiallyUploaded": {
"type": "boolean",
"description": "Indicates if the file is partially uploaded",
"example": false
}
},
"required": [
"CreatedByUserID",
"DateCreated",
"DateModified",
"EffectivePermission",
"FileID",
"InFavorite",
"IsPartiallyUploaded",
"IsQuarantined",
"ModifiedByUserID",
"Name",
"ParentFolderID",
"Path",
"Size"
]
},
"ThruPublicFolderInfo": {
"type": "object",
"description": "ThruPublicFolderInfo structure contains information about folder in MFT file system.",
"properties": {
"FolderID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number for the folder in MFT file system",
"example": "0QN8H2VKTGIWE"
},
"ParentFolderID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the parent folder for the file in MFT file system. Root folder contains NULL as a value of ParentFolderID field",
"example": "11ETULS0966VI"
},
"Name": {
"type": "string",
"description": "Name of the folder",
"example": "Admin"
},
"Path": {
"type": "string",
"description": "Path to the folder in folder tree",
"example": "FOLDERS/HOME/Admin"
},
"Description": {
"type": "string",
"description": "Description of the folder"
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of keywords associated with the current folder"
},
"Size": {
"type": "integer",
"format": "int64",
"description": "Size of the folder",
"example": 2450294218
},
"EffectivePermission": {
"type": "integer",
"format": "int32",
"description": "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",
"example": 254
},
"DateCreated": {
"type": "string",
"format": "date-time",
"description": "Date and time when file has been created in MFT file system (UTC)",
"example": "/Date(1337174868623)/"
},
"DateModified": {
"type": "string",
"format": "date-time",
"description": "Date and time when file last has been updated (UTC)",
"example": "/Date(1337174868623)/"
},
"CreatedByUserID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the user that has added file to MFT file system",
"example": "1Q1OBQWVHTROE"
},
"ModifiedByUserID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the user that last accessed the file",
"example": "1Q1OBQWVHTROE"
},
"InFavorite": {
"type": "boolean",
"description": "Indicates is folder marked as favorite",
"example": false
},
"FolderType": {
"type": "integer",
"format": "int32",
"description": "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",
"example": 0
}
},
"required": [
"CreatedByUserID",
"DateCreated",
"DateModified",
"EffectivePermission",
"FolderID",
"FolderType",
"InFavorite",
"ModifiedByUserID",
"Name",
"ParentFolderID",
"Path",
"Size"
]
},
"ThruPublicGroupInfo": {
"type": "object",
"description": "ThruPublicGroupInfo structure contains information about MFT file sharing user account.",
"properties": {
"Id": {
"type": "string",
"description": "Identifier of a group in Thru",
"example": "1Q1OBQWVHTROE"
},
"Name": {
"type": "string",
"description": "Group Name",
"example": "Group1"
},
"Description": {
"type": "string",
"description": "Group Description",
"example": "Cust1 Group"
},
"UserGroupType": {
"type": "string",
"description": "1 – 17: built-in security groups 0: user defined groups",
"example": "16"
},
"ModifyRole": {
"type": "string",
"description": "Manager = 4, or Administrator = 5",
"example": "4"
}
},
"required": [
"Description",
"Id",
"ModifyRole",
"Name",
"UserGroupType"
]
},
"ThruPublicMessageInfo": {
"type": "object",
"description": "ThruPublicMessageInfo structure contains information about MFT message.",
"properties": {
"MessageID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the message",
"example": "1HPHF1D8FF8S0"
},
"UserID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the user that is creator of message",
"example": "1Q1OBQWVHTROE"
},
"Subject": {
"type": "string",
"description": "Subject of the message",
"example": "Test Subject"
},
"DateCreated": {
"type": "string",
"format": "date-time",
"description": "Date and time when the message has been created (UTC)",
"example": "/Date(1337611985780)/"
},
"DateSent": {
"type": "string",
"format": "date-time",
"description": "Date and time when the message has been sent (UTC)",
"example": "/Date(1337611985780)/"
},
"DateExpired": {
"type": "string",
"format": "date-time",
"description": "Date and time after which message is concerned as expired (UTC)",
"example": "/Date(1357070340000)/"
},
"CollectedFlag": {
"type": "boolean",
"description": "Indicates does message were read at least by one of recipients",
"example": true
},
"PublicMessage": {
"type": "string",
"description": "Text of the private part of the message",
"example": "Public text"
},
"PrivateMessage": {
"type": "string",
"description": "Text of the public part of the message",
"example": "Private text"
},
"TrackingNo": {
"type": "string",
"description": "Number over the message is registered in Thru",
"example": "T478-026-95732-36971"
},
"RequestLogin": {
"type": "boolean",
"description": "Flag that indicate is the message request login for access by recipient",
"example": false
},
"SendByClient": {
"type": "boolean",
"description": "Flag that indicate is the message was sent through the MFT Site or application.",
"example": false
},
"NotifyFlag": {
"type": "boolean",
"description": "Flag that indicate is the notifications must be sent.",
"example": false
},
"Priority": {
"type": "integer",
"format": "int32",
"description": "1 – High 2 – Low 3 – Normal",
"example": 3
},
"IsExpired": {
"type": "boolean",
"description": "Flag indicate is the message is expired",
"example": false
},
"ExpireNow": {
"type": "boolean",
"example": false
},
"MsgHtmlTemplate": {
"type": "string",
"description": "Html template over a message will be created"
},
"MsgTextTemplate": {
"type": "string",
"description": "Text template over a message will be created"
},
"ToRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicMessageRecipientInfo"
},
"description": "List of recipient email addresses"
},
"CcRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicMessageRecipientInfo"
},
"description": "List of Cc recipients"
},
"BccRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicMessageRecipientInfo"
},
"description": "List of Bcc recipients"
},
"FoldersAttached": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
},
"description": "Collection of Folder identifiers"
},
"FilesAttached": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicFolderInfo"
},
"description": "Collection of File identifiers"
}
},
"required": [
"CollectedFlag",
"DateCreated",
"DateExpired",
"DateSent",
"ExpireNow",
"IsExpired",
"MessageID",
"NotifyFlag",
"Priority",
"PrivateMessage",
"PublicMessage",
"RequestLogin",
"SendByClient",
"Subject",
"TrackingNo",
"UserID"
]
},
"ThruPublicMessageRecipientInfo": {
"type": "object",
"properties": {
"MsgId": {
"type": "string",
"description": "Unique identification number of the MFT message",
"example": "1R6NE5OZ8QHXA"
},
"RecipientId": {
"type": "string",
"description": "Unique identification number of Recipient",
"example": "2MIMZFR1K0471"
},
"RecipientEmail": {
"type": "string",
"description": "Recipient e-mail",
"example": "test.test@test.com"
},
"Collected": {
"type": "boolean",
"description": "Indicates does message were read by recipient",
"example": true
},
"MsgRecipientLevelPublicID": {
"type": "string",
"description": "Unique identification number of recipient level"
}
},
"description": "ThruPublicMessageRecipientInfo structure contains information about the recipient of MFT message.",
"required": [
"Collected",
"MsgId",
"RecipientEmail",
"RecipientId"
]
},
"ThruPublicMessagesListResult": {
"type": "object",
"properties": {
"Messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruPublicMessageInfo"
},
"description": "Collection of Messages"
}
},
"description": "ThruPublicMessagesListResult structure contains collection of MFT messages."
},
"ThruPublicSearchCriteria": {
"type": "object",
"description": "ThruPublicSearchCriteria structure contains criteria for the search over MFT files and folders.",
"properties": {
"FolderID": {
"type": "integer",
"format": "int32",
"description": "Indicates the folder from which to start the search",
"example": "0QN8H2VKTGIWE"
},
"NameCriteria": {
"type": "string",
"description": "String representing the search criteria for the name of MFT file system object",
"example": "-"
},
"NameCriteriaMatchAll": {
"type": "boolean",
"description": "Indicates whether all criteria passed in NameCriteria field should be matched",
"example": true
},
"DescriptionCriteria": {
"type": "string",
"description": "String representing the search criteria for the description of MFT file system object",
"example": "-"
},
"DescriptionCriteriaMatchAll": {
"type": "boolean",
"description": "Indicates whether all criteria passed in DescriptionCriteria field should be matched",
"example": true
},
"KeywordCriteria": {
"type": "string",
"description": "String representing the search criteria for the keywords of MFT file system object",
"example": "12\\"
},
"KeywordCriteriaMatchAll": {
"type": "boolean",
"description": "Indicates whether all criteria passed in KeywordCriteria field should be matched",
"example": true
},
"LastModifiedByUsers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of user unique identifiers"
},
"DateLastModifiedStart": {
"type": "string",
"format": "date-time",
"description": "Date and time when MFT file system object has been modified. Start of Range (UTC)"
},
"DateLastModifiedEnd": {
"type": "string",
"format": "date-time",
"description": "Date and time when MFT file system object has been modified. End of Range (UTC)"
},
"Recursive": {
"type": "boolean",
"description": "Enable/disable recursive search over folder tree",
"example": true
}
},
"required": [
"DescriptionCriteria",
"DescriptionCriteriaMatchAll",
"FolderID",
"KeywordCriteria",
"KeywordCriteriaMatchAll",
"NameCriteria",
"NameCriteriaMatchAll",
"Recursive"
]
},
"ThruPublicServerInfo": {
"type": "object",
"description": "ThruPublicServerInfo structure contains information about the configuration of server and its health status.",
"properties": {
"SiteID": {
"type": "integer",
"format": "int32",
"description": "Identifier of the current site",
"example": "14RD6GNEUV4ZV"
},
"Name": {
"type": "string",
"description": "Pretty name of the current site",
"example": "test.example.com"
},
"Title": {
"type": "string",
"description": "Title of the site",
"example": "MFT Site name"
},
"Welcome": {
"type": "string",
"description": "‘Welcome’ text of the site",
"example": "Welcome"
},
"Enabled": {
"type": "boolean",
"description": "Indicate is the site enabled",
"example": true
}
},
"required": [
"Enabled",
"Name",
"SiteID",
"Title",
"Welcome"
]
},
"ThruPublicSession": {
"type": "object",
"description": "ThruPublicSession structure contains authorization information about user.",
"properties": {
"SessionID": {
"type": "string",
"description": "Unique identification value required for user authorization",
"example": "TOjoy3c1LyReUsXqXX/7u3+0qv FYXGArgsZ1k0OEGhIfwB2cd365+SCM8Rs5 JOLPMD/IJJSd2Jy7IXLl5t685kgRJo0Tr bup/VDN+25Lkenh387d4pXJzObepqO qusnnsA4de+5r4PHfdN0 9niJtsoSOjWZ6XlEN"
},
"UserID": {
"type": "integer",
"format": "int32",
"description": "Unique identification number of the user associated with SessionID value",
"example": "315KQM487N2EV"
},
"SessionId": {
"type": "string",
"description": "Encrypted session identifier for the impersonated user."
},
"UserId": {
"type": "string",
"description": "Encrypted user identifier of the impersonated user."
}
},
"required": [
"SessionID",
"UserID"
]
},
"ThruPublicSystemLogOperation": {
"type": "object",
"description": "ThruPublicSystemLogOperation structure contains information operation that will be logged in MFT.",
"properties": {
"LogOperationId": {
"type": "string",
"description": "Operation Id that is assigned for request operation",
"example": "1UEVYEHGF7GVW"
},
"OperationType": {
"type": "integer",
"format": "int32",
"description": "MobileOpenFileInExternalApplication = 0×4000000",
"example": "67108864"
},
"FolderId": {
"type": "string",
"description": "Identifier of the folder in MFT file system",
"example": "0QN8H2VKTGIWE"
},
"FileId": {
"type": "string",
"description": "Identifier of the file in MFT file system",
"example": "30FZAAT6ULN30"
},
"MobileReceiverAppName": {
"type": "string",
"description": "Mobile application name",
"example": "test"
}
}
},
"ThruPublicUserInfo": {
"type": "object",
"description": "ThruPublicUserInfo structure contains information about MFT user.",
"properties": {
"UserId": {
"type": "string",
"description": "Identifier of user in Thru",
"example": "1Q1OBQWVHTROE"
},
"Name": {
"type": "string",
"description": "User name that is used for sign-in in Thru",
"example": "admin"
},
"DomainUsername": {
"type": "string",
"description": "If user is in domain, this field represent it domain name"
},
"FirstName": {
"type": "string",
"description": "User’s first name",
"example": "Ad"
},
"LastName": {
"type": "string",
"description": "User’s last name",
"example": "Test"
},
"FullName": {
"type": "string",
"description": "User’s full name",
"example": "Ad Test"
},
"Email": {
"type": "string",
"description": "User’s e-mail address",
"example": "devnull@test.com"
},
"Phone": {
"type": "string",
"description": "User’s phone number"
},
"CompanyName": {
"type": "string",
"description": "Company name"
},
"Role": {
"type": "integer",
"format": "int32",
"description": "User’s role on Thru: None = 0, Guest = 1, Recipient = 2, Member = 3, Manager = 4, Administrator = 5, System = 6",
"example": 5
},
"DateCreated": {
"type": "string",
"format": "date-time",
"description": "User’s date create (UTC)",
"example": "/Date(1337174868567)/"
},
"DateModified": {
"type": "string",
"format": "date-time",
"description": "User’s last date modify (UTC)",
"example": "/Date(1351871161613)/"
},
"CreatedByUserId": {
"type": "string",
"description": "Identifier of the user that is create the specified user"
},
"ModifiedByUserId": {
"type": "string",
"description": "Identifier of the user that is modify the specified user",
"example": "2T5LRH8F1R2QK"
},
"DateLastPasswordChanged": {
"type": "string",
"format": "date-time",
"description": "The date of the last password modification",
"example": "/Date(1343838136630)/"
},
"PasswordNeverExpires": {
"type": "boolean",
"description": "Flag indicate is the user password is never expires",
"example": true
}
},
"required": [
"DateCreated",
"DateLastPasswordChanged",
"DateModified",
"Email",
"FirstName",
"FullName",
"LastName",
"ModifiedByUserId",
"Name",
"PasswordNeverExpires",
"Role",
"UserId"
]
},
"ThruServerVersion": {
"type": "object",
"description": "ThruServerVersion structure contains information about version of ThruServer.",
"properties": {
"Major": {
"type": "integer",
"format": "int32",
"description": "Major version",
"example": 7
},
"Minor": {
"type": "integer",
"format": "int32",
"description": "Minor version",
"example": 8
},
"Buildnumber": {
"type": "integer",
"format": "int32",
"description": "Build number",
"example": 23
},
"Suffix": {
"type": "string",
"description": "Suffix, addition version identificator. This field can be empty.",
"example": "1.1.2"
},
"Revision": {
"type": "integer",
"format": "int32",
"description": "Revision number",
"example": 11234
}
},
"required": [
"Buildnumber",
"Major",
"Minor",
"Revision",
"Suffix"
]
},
"ThruServiceVersion": {
"type": "object",
"properties": {
"ServiceName": {
"type": "string",
"description": "Service name",
"example": "FileSystem"
},
"SupportedVersions": {
"type": "string",
"description": "Service version",
"example": "1.0"
}
},
"description": "ThruServiceVersion structure contains information about versions of specific REST service in the ThruServer.",
"required": [
"ServiceName",
"SupportedVersions"
]
},
"ThruServiceVersionsResult": {
"type": "object",
"properties": {
"ServiceVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThruServiceVersion"
},
"description": "REST Services"
}
},
"description": "ThruServiceVersionsResult structure contains information about versions of REST services in the ThruServer."
},
"ThruSessionByTicketRequest": {
"type": "object",
"description": "ThruSessionByTicketRequest structure contains information required for the MFT user authentication",
"properties": {
"Ticket": {
"type": "string",
"description": "Ticket for authentication"
},
"ApplicationId": {
"type": "string",
"description": "Application ID used by connecting application",
"example": "12"
},
"ClientVersion": {
"type": "string",
"description": "Version of the client application",
"example": "1"
},
"Device\\UUID": {
"type": "string",
"description": "Limited by 17 characters",
"example": "Device-1234"
}
},
"required": [
"ApplicationId",
"ClientVersion",
"Device\\UUID"
]
},
"ThruSessionRequest": {
"type": "object",
"description": "ThruSessionRequest structure contains information required for the MFT user authentication.",
"properties": {
"UserName": {
"type": "string",
"description": "Username of the user in the system",
"example": "Test"
},
"Password": {
"type": "string",
"description": "Password of the user",
"example": "Password"
},
"ApplicationId": {
"type": "string",
"description": "Application ID used by connecting application",
"example": "12"
},
"ClientVersion": {
"type": "string",
"description": "Version of the client application",
"example": "1"
},
"Device\\UUID": {
"type": "string",
"description": "Limited by 17 characters",
"example": "Device1234"
},
"UserString": {
"type": "string",
"description": "Optional. External user information associated with the login session. Will be recorded in MFT Audit on each upload/download/delete API call. Limit 256 characters",
"example": "Name / email@domain.com"
}
},
"required": [
"ApplicationId",
"ClientVersion",
"Device\\UUID",
"Password",
"UserName"
]
},
"ThruShortUrl": {
"type": "object",
"description": "ThruShortUrl contains a string with the Short Key which is returned by View/Upload/Download requests and is used to call View/Upload/Download URL tools.",
"properties": {
"ShortUrl": {
"type": "string",
"description": "String that represents passed query string",
"example": "4E2CH827YO6OUUQVMSM3"
}
},
"required": [
"ShortUrl"
]
},
"ThruTicketInfo": {
"type": "object",
"description": "ThruTicketInfo structure contains email fields",
"properties": {
"Subject": {
"type": "string",
"description": "Subject text",
"example": "Subject"
},
"Body": {
"type": "string",
"description": "Body text",
"example": "Message"
}
},
"required": [
"Body",
"Subject"
]
},
"ThruUploadSettings": {
"type": "object",
"description": "ThruUploadSettings structure contains information on upload settings.",
"properties": {
"UploadAppletBatchMaxCount": {
"type": "integer",
"format": "int32",
"description": "The maximum number of files uploaded in batch by the applet to the server in a single HTTP request. To indicate that there is no limit, use the value 0.",
"example": 0
},
"UploadAppletChunkCount": {
"type": "integer",
"format": "int32",
"description": "The maximum number of chunks to divide a file to be uploaded by the applet, before we start increasing the chunk size from the minimum size.",
"example": 20
},
"UploadAppletChunkMaxSizeMb": {
"type": "integer",
"format": "int32",
"description": "The maximum size (in Megabytes) of a file chunk uploaded by the applet to the server.",
"example": 100
},
"UploadAppletChunkMinSizeMb": {
"type": "integer",
"format": "int32",
"description": "The minimum size (in Megabytes) of a file chunk uploaded by the applet to the server.",
"example": 60
},
"UploadAppletDeleteOnCancelDefault": {
"type": "boolean",
"description": "Indicates whether the default behavior for the applet on an upload cancellation is to delete partially uploaded files.",
"example": false
},
"UploadAppletDeleteOnCancelEnabled": {
"type": "boolean",
"description": "Indicates whether the user can opt on the behavior for the applet on an upload cancellation. If true, user can opt; false, otherwise.",
"example": true
},
"UploadAppletZippingEnabled": {
"type": "boolean",
"example": false
},
"UploadAppletZippingMinFileSizeKb": {
"type": "integer",
"format": "int32",
"example": 10
}
},
"required": [
"UploadAppletBatchMaxCount",
"UploadAppletChunkCount",
"UploadAppletChunkMaxSizeMb",
"UploadAppletChunkMinSizeMb",
"UploadAppletDeleteOnCancelDefault",
"UploadAppletDeleteOnCancelEnabled",
"UploadAppletZippingEnabled",
"UploadAppletZippingMinFileSizeKb"
]
},
"ThruUploaderRequest": {
"type": "object",
"description": "ThruUploaderRequest structure contains the input fields required for web service call UploaderRequest which returns a Short Key for the Upload URL tool.",
"properties": {
"SessionId": {
"type": "string",
"description": "Session ID for file upload",
"example": "U6tTDWR … /HtFh"
},
"FolderPublicId": {
"type": "string",
"description": "Folder ID where files will be uploaded",
"example": "286YJBJMIZ24V"
},
"FileFilter": {
"type": "string",
"description": "string for file filtering used in file open dialog. Defines allowed types. String format: : , … . If parameter is not passed all files are shown.",
"example": "Zip files (\\.zip, \\.7z, \\.tar): zip, 7z, tar"
},
"FileFilterExceptions": {
"type": "string",
"description": "string for file filtering used in file open dialog. Defines restricted types. String format: , …. Can be used with FileFilter or standalone. In case used with FileFilter, result filter will contain only allowed types not included in the FileFilterExceptions",
"example": "exe, com, bat"
},
"SuccessUrl": {
"type": "string",
"description": "Success url",
"example": "http://successUrlhere.com"
},
"ErrorReportingUrl": {
"type": "string",
"description": "Error url",
"example": "http://errorUrlHere.com"
}
},
"required": [
"ErrorReportingUrl",
"FileFilter",
"FileFilterExceptions",
"FolderPublicId",
"SessionId",
"SuccessUrl"
]
},
"ThruViewerRequest": {
"type": "object",
"description": "ThruViewerRequest structure contains the input fields required for web service call ViewerRequest which returns a Short Key for the View URL tool.",
"properties": {
"SessionId": {
"type": "string",
"description": "Session ID for file viewing",
"example": "U6tTDWRFvEPFwkLeCu…./HtFh"
},
"FilePublicId": {
"type": "string",
"description": "File id",
"example": "286YJBJMIZ24V"
},
"SuccessUrl": {
"type": "string",
"description": "Success url",
"example": "http://successUrlhere.com"
},
"ErrorReportingUrl": {
"type": "string",
"description": "Error url",
"example": "http://errorUrlHere.com"
}
},
"required": [
"ErrorReportingUrl",
"FilePublicId",
"SessionId",
"SuccessUrl"
]
},
"PublicStoreMetadataItemInfo": {
"type": "object",
"description": "Contains data from actions performed on file and folder metadata.",
"properties": {
"MetadataID": {
"type": "string",
"example": "11XIJDBFMXPEO",
"description": "ID of a metadata item."
},
"Name": {
"type": "string",
"example": "DocumentType",
"description": "Name of the metadata item."
},
"DataType": {
"type": "integer",
"example": 3,
"description": "Metadata type. Only 3 (arrays of strings) are supported."
},
"Data": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Accounting"
],
"description": "Metadata value represented as an array of one or more strings."
}
}
},
"MetadataKeyValueCollection": {
"type": "object",
"description": "Contains an array of key-value data from metadata.",
"properties": {
"MetadataObjects": {
"type": "array",
"description": "Array of metadata key-value information.",
"items": {
"$ref": "#/components/schemas/MetadataKeyValue"
}
}
}
},
"MetadataKeyValue": {
"type": "object",
"description": "Represents a single metadata key-value pair.",
"properties": {
"Key": {
"type": "string",
"example": "DocumentType",
"description": "The metadata key."
},
"Value": {
"type": "string",
"example": "Invoice",
"description": "The metadata value associated with the key."
}
}
},
"MarkForRetrievalUploadInfo": {
"type": "object",
"description": "Represents a response object containing the unique GUID generated to mark uploaded files for retrieval.",
"properties": {
"MarkForRetrieval": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (GUID) associated with the marked upload batch.",
"example": "898fa874-1fca-4381-a7c7-edeec48036db"
}
},
"required": [
"MarkForRetrieval"
]
},
"ThruPublicUploadInfo": {
"type": "object",
"description": "Represents a collection of uploaded files returned by the API.",
"properties": {
"Files": {
"type": "array",
"description": "List of uploaded file information objects.",
"items": {
"$ref": "#/components/schemas/PublicFileUploadInfo"
}
}
},
"required": [
"Files"
]
},
"PublicFileUploadInfo": {
"type": "object",
"properties": {
"FileData": {
"$ref": "#/components/schemas/PublicFileData"
},
"AccessId": {
"type": "string",
"description": "Unique identifier for accessing the uploaded file in Download API with security token.",
"example": "3P84C7DRWIX05"
},
"BaseFileId": {
"type": "string",
"description": "File identifier (FileID) of the first version of the file, since files can have multiple versions.",
"example": "2SPOQZBZI60WJ"
}
},
"required": [
"FileData",
"AccessId",
"BaseFileId"
],
"description": "Metadata for a single uploaded file, including access identifiers and file data."
},
"PublicFileData": {
"type": "object",
"description": "Metadata retrieved by the call, describing the uploaded file.",
"properties": {
"FileID": {
"type": "string",
"example": "3P572PVKX3ROQ",
"description": "Unique identifier for the file."
},
"ParentFolderID": {
"type": "string",
"example": "0V768UDFE6WPP",
"description": "Identifier of the folder that contains this file."
},
"Name": {
"type": "string",
"example": "boomi-382C12AAF1.zip",
"description": "Name of the file."
},
"Size": {
"type": "integer",
"example": 574,
"description": "Size of the file in bytes."
},
"EffectivePermission": {
"type": "integer",
"example": 254,
"description": "Numeric representation of the file’s effective permission."
},
"DateCreated": {
"type": "string",
"format": "date-time",
"example": "2025-10-21T10:31:48.793",
"description": "Timestamp when the file was created."
},
"DateModified": {
"type": "string",
"format": "date-time",
"example": "2025-10-21T10:31:48.793",
"description": "Timestamp when the file was last modified."
},
"CreatedByUserID": {
"type": "string",
"example": "39RLXBHYVYGYB",
"description": "User ID of the file creator."
},
"ModifiedByUserID": {
"type": "string",
"example": "39RLXBHYVYGYB",
"description": "User ID of the user who last modified the file."
},
"Version": {
"type": "integer",
"example": 1,
"description": "Version number of the file."
},
"IsDeleted": {
"type": "boolean",
"example": false,
"description": "Indicates whether the file is deleted."
},
"IsQuarantined": {
"type": "boolean",
"example": false,
"description": "Indicates whether the file is quarantined."
},
"IsPublished": {
"type": "boolean",
"example": false,
"description": "Indicates whether the file is published."
}
}
},
"ThruSessionImpersonateRequest": {
"type": "object",
"required": [
"UserID",
"ApplicationID"
],
"properties": {
"UserID": {
"type": "string",
"description": "Encrypted ID of the user to impersonate."
},
"ApplicationID": {
"type": "integer",
"description": "Application ID used by connecting application."
}
}
}
},
"securitySchemes": {
"SessionAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Pass the session identifier issued by the [Authentication service](/docs/api/filesharingapi/Session) in the Authorization header. Example: `Authorization: SessionID `. All authenticated requests must use HTTPS."
}
}
},
"tags": [
{
"name": "Audit",
"x-displayName": "Audit Service",
"description": "The Audit REST Web Services provide endpoints for retrieving audit records across system components. These services provide programmatic access to audit data, enabling monitoring, compliance, and integration with external analytics or security tools."
},
{
"name": "Favorites",
"x-displayName": "Favorites Service",
"description": "The Favorites REST Web Services provide endpoints for managing and retrieving user-designated favorite items within the file system. These APIs enable the addition or removal of specific files or folders from the favorites list by their unique identifiers, as well as the retrieval of collections of favorite files, folders, or both, with optional filtering parameters."
},
{
"name": "File",
"description": "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."
},
{
"name": "Folder",
"description": "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."
},
{
"name": "FolderPermissions",
"x-displayName": "Folder Permissions",
"description": "The Folder Permissions REST Web Services provide endpoints for managing access control on folders within the file system. These APIs enable listing existing user and group permissions, adding new permissions for individual users or groups, updating existing permission entries, and deleting one or more permissions as needed."
},
{
"name": "Home",
"description": "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."
},
{
"name": "ImmutableImpersonateSession",
"description": "The Immutable Impersonate Session Authentication REST Web Service creates an immutable session impersonating the specified user."
},
{
"name": "ImmutableSession",
"description": "The Immutable Session Authentication REST Web Service verifies user credentials and authenticates an MFT user, returning an immutable session token that allows multiple concurrent sessions for the same account. It also supports passing external user information through the UserString parameter for audit and tracking purposes."
},
{
"name": "ImmutableSessionByTicket",
"description": "The Immutable Session Ticket Authentication REST Web Service authenticates an MFT user by validating a provided authentication ticket and returns an immutable session token, allowing multiple concurrent sessions for the same user account."
},
{
"name": "Message",
"x-displayName": "Message Service",
"description": "The Message REST Web Services provide endpoints for managing email messages within the system. These APIs enable the creation of new messages with specified parameters, the retrieval or updating of message details by ID, and the performance of message lifecycle operations, such as discarding or completing messages."
},
{
"name": "Root",
"description": "The Root Folder REST Web Services provide endpoints for retrieving information about the root directory assigned to the authenticated user. These APIs return detailed metadata for the user's root folder and allow listing collections of files, folders, or combined file and folder structures within it"
},
{
"name": "Search",
"x-displayName": "Search Service",
"description": "The Search REST Web Services provide endpoints for querying folder and file structures within the system based on flexible search criteria. These APIs enable the retrieval of collections of both files and folders, or exclusively folders or files, that match the specified search parameters."
},
{
"name": "Server",
"x-displayName": "Server Service",
"description": "The Server Configuration REST Web Services provide endpoints for retrieving detailed information about the current server and its operational settings. These APIs return server metadata, allowed bandwidth and bandwidth interval parameters, and configuration details for key subsystems, including message, password, upload, and mobile settings."
},
{
"name": "ServerVersion",
"x-displayName": "Server Version Service",
"description": "The Version REST Web Services provide an endpoint for retrieving detailed version information of the MFT Server, including major, minor, and revision numbers."
},
{
"name": "ServiceVersions",
"x-displayName": "Service Versions Service",
"description": "The REST Services Version Web Services provide an endpoint for retrieving version information of all REST services available in the MFT Server. This includes a list of individual service components along with their respective version details."
},
{
"name": "ServerTool",
"x-displayName": "Short Key Request Services",
"description": "The Embedded Widget Configuration REST Web Services provide endpoints that accept multiple input parameters required to configure embedded widgets for file upload, download, or viewing, and return a short key string representing the configuration. This key can be used in place of detailed parameters"
},
{
"name": "Session",
"description": "The Regular Session Authentication REST Web Service verifies user credentials and authenticates an MFT user, returning a regular session token that terminates any previous sessions for the same account."
},
{
"name": "SessionByTicket",
"description": "The Regular Session Authentication REST Web Service verifies user credentials and authenticates an MFT user by validating a provided authentication ticket, returning a regular session token that terminates any previous sessions for the same account."
},
{
"name": "Systemlog",
"x-displayName": "System Log Service",
"description": "The System Log REST Web Services provide endpoints for recording operational and system log entries within the MFT Server. These APIs enable the addition of new log records based on specified file, folder, and operation identifiers."
},
{
"name": "Ticket",
"x-displayName": "Ticket Service",
"description": "The Ticket REST Web Service provides an endpoint for sending tickets based on the supplied information."
},
{
"name": "User",
"x-displayName": "User Service",
"description": "The User Account REST Web Services provide endpoints for managing information and credentials of the currently authenticated user."
},
{
"name": "UserGroups",
"x-displayName": "Manage Users in Groups",
"description": "The User Group Management REST Web Services provide endpoints for administering user groups within the system. These APIs enable updating group information by group ID, listing all groups in the site, retrieving users within a specific group, and managing group membership by adding or removing users through their respective identifiers."
},
{
"name": "Users",
"x-displayName": "List Users Service",
"description": "The User Management REST Web Service provides an endpoint for retrieving a list of users on the site, with support for applying filters through querystring parameters."
},
{
"name": "Upload",
"description": ""
}
],
"x-tagGroups": [
{
"name": "Web Services",
"tags": [
"User",
"ServerTool",
"Message",
"Audit",
"Search",
"Server",
"Favorites",
"ServiceVersions",
"Systemlog",
"Ticket",
"ServerVersion",
"FolderPermissions",
"UserGroups",
"Users",
"Upload"
]
},
{
"name": "Authentication Service",
"tags": [
"Session",
"ImmutableSession",
"SessionByTicket",
"ImmutableSessionByTicket",
"ImmutableImpersonateSession"
]
},
{
"name": "File System Service",
"tags": [
"Folder",
"Home",
"Root",
"File"
]
}
],
"security": [
{
"SessionAuth": []
}
]
}