Waiting for engine...
Skip to main content

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

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Upload

The Upload REST Web Services provide endpoints for managing the file upload workflow through metadata marking and retrieval. These services enable clients to tag files during upload operations, associate custom metadata with upload sessions, and retrieve uploaded file information after completion.

The marking mechanism allows for tracking multiple files uploaded as part of a single operation, while the cleanup functionality ensures metadata is properly managed throughout the upload lifecycle. This service is particularly useful for implementing upload widgets, batch file operations, and integration with external applications that require tracking of uploaded content with custom metadata.

Create Mark GUID

Mark uploaded files or folders during session by unique identifier and return it. Create 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.
Files marked by the GUID can be retrieved by the call RetrieveUploadInfoCleanUp.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
MarkForRetrieval
required
string <uuid>

Unique identifier (GUID) associated with the marked upload batch.

Response samples

Content type
application/json
{
  • "MarkForRetrieval": "898fa874-1fca-4381-a7c7-edeec48036db"
}

Store metadata

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.

Example request: metadataobjects[0].Key=key1&metadataobjects[0].Value=value1&metadataobjects[1].Key=key2&metadataobjects[1].Value=value2

Authorizations:
SessionAuth
Request Body schema: application/x-www-form-urlencoded
required

Request body — Request type: MetadataKeyValueCollection — Schema: ThruPublicFileInfo structure contains information about file in MFT FS file system.

Array of objects (MetadataKeyValue)

Array of metadata key-value information.

Array
Key
string

The metadata key.

Value
string

The metadata value associated with the key.

Responses

Response Schema: application/json
MetadataID
string

ID of a metadata item.

Name
string

Name of the metadata item.

DataType
integer

Metadata type. Only 3 (arrays of strings) are supported.

Data
Array of strings

Metadata value represented as an array of one or more strings.

Request samples

Content type
application/x-www-form-urlencoded
metadataobjects[0].Key=key1&metadataobjects[0].Value=value1&metadataobjects[1].Key=key2&metadataobjects[1].Value=value2

Response samples

Content type
application/json
{
  • "MetadataID": "11XIJDBFMXPEO",
  • "Name": "DocumentType",
  • "DataType": 3,
  • "Data": [
    • "Accounting"
    ]
}

Retrieve upload info cleanup by uploaded metadata value

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).

Invocation scenario

Return an array of file metadata structures for each uploaded file and folder, and remove marker metadata from the file system.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
required
Array of objects (PublicFileUploadInfo)

List of uploaded file information objects.

Array
required
object (PublicFileData)

Metadata retrieved by the call, describing the uploaded file.

AccessId
required
string

Unique identifier for accessing the uploaded file in Download API with security token.

BaseFileId
required
string

File identifier (FileID) of the first version of the file, since files can have multiple versions.

Response samples

Content type
application/json
{
  • "Files": [
    • {
      }
    ]
}

Clear metadata

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.

Authorizations:
SessionAuth

Responses