Boomi MFT - File Sharing API Reference (1.16) - ServerTool
Download OpenAPI Specification: Download
For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.
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
Create ServerTool ViewerRequest
The call accepts ThruViewerRequest object and return shortID.
Authorizations:
Request Body schema: application/x-www-form-urlencodedrequired
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.
| ErrorReportingUrl required | string Error url |
| FilePublicId required | string File id |
| SessionId required | string Session ID for file viewing |
| SuccessUrl required | string Success url |
Responses
Request samples
- Payload
ErrorReportingUrl=http%3A%2F%2FerrorUrlHere.com&FilePublicId=286YJBJMIZ24V&SessionId=U6tTDWRFvEPFwkLeCu%E2%80%A6.%2FHtFh&SuccessUrl=http%3A%2F%2FsuccessUrlhere.com
Response samples
- 201
{- "ShortUrl": "4E2CH827YO6OUUQVMSM3"
}Create ServerTool UploaderRequest
The call accepts ThruUploaderRequest object and return shortID.
Authorizations:
Request Body schema: application/x-www-form-urlencodedrequired
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.
| ErrorReportingUrl required | string Error url |
| FileFilter required | string string for file filtering used in file open dialog. Defines allowed types. String format: |
| FileFilterExceptions required | string string for file filtering used in file open dialog. Defines restricted types. String format: |
| FolderPublicId required | string Folder ID where files will be uploaded |
| SessionId required | string Session ID for file upload |
| SuccessUrl required | string Success url |
Responses
Request samples
- Payload
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
Response samples
- 201
{- "ShortUrl": "4E2CH827YO6OUUQVMSM3"
}Create ServerTool DownloaderRequest
The call accepts ThruDownloaderRequest object and return shortID.
Authorizations:
Request Body schema: application/x-www-form-urlencodedrequired
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.
| ErrorReportingUrl required | string Error url |
| FilePublicIds required | string Array of file IDs. If multiple IDs included, files are downloaded as a zip |
| FolderPublicIds required | string Array of folders IDs which will be downloaded. Folders are downloaded as part of a zip archive |
| SessionId required | string Session ID for file download |
| SuccessUrl required | string Success url |
Responses
Request samples
- Payload
ErrorReportingUrl=http%3A%2F%2FerrorUrlHere.com&FilePublicIds=286YJBJMIZ24C&FolderPublicIds=286YJBJMIZ24V&SessionId=U6tTD%E2%80%A6.%2FHtFh&SuccessUrl=http%3A%2F%2FsuccessUrlhere.com
Response samples
- 201
{- "ShortUrl": "4E2CH827YO6OUUQVMSM3"
}