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

Toggle Pane

• Search Service
  • postFind All Files and Folders by Search Criteria
  • postFind All Folders by Search Criteria
  • postFind All Files by Search Criteria

API docs by Redocly

Download OpenAPI Specification: Download

Search Service

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.

Find All Files and Folders by Search Criteria

Retrieves a collection of folder and file structures based on the provided search criteria structure.

Remarks | 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” |

Invocation Scenarios

Search over all MFT FS files and folders available to the current authenticated user.

Remarks

NameCriteria, DescriptionCriteria, and KeywordCriteria are automatically wrapped by the ‘’ if not contains it as part of criteria. For example: “text” -> “*text”, but “tex*t” -> “tex*t”

Authorizations:

SessionAuth

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

required

Request body — Request type: ThruPublicSearchCriteria — Schema: ThruPublicSearchCriteria structure contains criteria for the search over MFT files and folders.

DescriptionCriteria required	string String representing the search criteria for the description of MFT file system object
DescriptionCriteriaMatchAll required	boolean Indicates whether all criteria passed in DescriptionCriteria field should be matched
FolderID required	integer <int32> Indicates the folder from which to start the search
KeywordCriteria required	string String representing the search criteria for the keywords of MFT file system object
KeywordCriteriaMatchAll required	boolean Indicates whether all criteria passed in KeywordCriteria field should be matched
NameCriteria required	string String representing the search criteria for the name of MFT file system object
NameCriteriaMatchAll required	boolean Indicates whether all criteria passed in NameCriteria field should be matched
Recursive required	boolean Enable/disable recursive search over folder tree
LastModifiedByUsers	Array of strings Collection of user unique identifiers
DateLastModifiedStart	string <date-time> Date and time when MFT file system object has been modified. Start of Range (UTC)
DateLastModifiedEnd	string <date-time> Date and time when MFT file system object has been modified. End of Range (UTC)

Responses

https://{MFTWebServer}/REST/{version}/Search/{skip}/{take}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

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

Response samples

• 201

Content type

application/json

{

• "Files": [

  • {

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

      • "string"

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

    }

  ],
• "Folders": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Find All Folders by Search Criteria

Retrieves a collection of folder structures based on provided search criteria structure.

Remarks | 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” |

Authorizations:

SessionAuth

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

required

Request body — Request type: ThruPublicSearchCriteria — Schema: ThruPublicSearchCriteria structure contains criteria for the search over MFT files and folders.

DescriptionCriteria required	string String representing the search criteria for the description of MFT file system object
DescriptionCriteriaMatchAll required	boolean Indicates whether all criteria passed in DescriptionCriteria field should be matched
FolderID required	integer <int32> Indicates the folder from which to start the search
KeywordCriteria required	string String representing the search criteria for the keywords of MFT file system object
KeywordCriteriaMatchAll required	boolean Indicates whether all criteria passed in KeywordCriteria field should be matched
NameCriteria required	string String representing the search criteria for the name of MFT file system object
NameCriteriaMatchAll required	boolean Indicates whether all criteria passed in NameCriteria field should be matched
Recursive required	boolean Enable/disable recursive search over folder tree
LastModifiedByUsers	Array of strings Collection of user unique identifiers
DateLastModifiedStart	string <date-time> Date and time when MFT file system object has been modified. Start of Range (UTC)
DateLastModifiedEnd	string <date-time> Date and time when MFT file system object has been modified. End of Range (UTC)

Responses

https://{MFTWebServer}/REST/{version}/Search/Folders/{skip}/{take}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

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

Response samples

• 201

Content type

application/json

{

• "Files": [

  • {

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

      • "string"

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

    }

  ],
• "Folders": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Find All Files by Search Criteria

Retrieves a collection of files based on the provided ThruPublicSearchCriteria object.

Authorizations:

SessionAuth

path Parameters

Skip required	integer >= 0 Number of items to skip (for paging).
Take required	integer >= 1 Number of items to take/return (page size).

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

required

Request body — Request type: ThruPublicSearchCriteria — Schema: ThruPublicSearchCriteria structure contains criteria for the search over MFT files and folders.

DescriptionCriteria required	string String representing the search criteria for the description of MFT file system object
DescriptionCriteriaMatchAll required	boolean Indicates whether all criteria passed in DescriptionCriteria field should be matched
FolderID required	integer <int32> Indicates the folder from which to start the search
KeywordCriteria required	string String representing the search criteria for the keywords of MFT file system object
KeywordCriteriaMatchAll required	boolean Indicates whether all criteria passed in KeywordCriteria field should be matched
NameCriteria required	string String representing the search criteria for the name of MFT file system object
NameCriteriaMatchAll required	boolean Indicates whether all criteria passed in NameCriteria field should be matched
Recursive required	boolean Enable/disable recursive search over folder tree
LastModifiedByUsers	Array of strings Collection of user unique identifiers
DateLastModifiedStart	string <date-time> Date and time when MFT file system object has been modified. Start of Range (UTC)
DateLastModifiedEnd	string <date-time> Date and time when MFT file system object has been modified. End of Range (UTC)

Responses

Response Schema: application/json

	Array of objects (ThruPublicFileInfo) Collection of file information structures
	Array of objects (ThruPublicFolderInfo) Collection of folder information structures

https://{MFTWebServer}/REST/{version}/Search/Files/{Skip}/{Take}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

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

Response samples

• 200

Content type

application/json

{

• "Files": [

  • {

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

      • "string"

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

    }

  ],
• "Folders": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}