Waiting for engine...
Skip to main content

Boomi MFT - AFT Content API Reference (v1) - FileList

Toggle Pane

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

FileList

Discovery of the files staged against a flow endpoint. Returns a filtered, paged view of the file metadata a caller's tenant owns, so a client can decide what to download before fetching any content.

List the files staged against a flow endpoint

Returns a filtered view of the files held for the given flow endpoint. Filters are supplied as query-string parameters: maxFiles (page cap), fileId, status and actionType (each a repeated key for multiple values), and createdAfter/createdBefore (inclusive ISO-8601 UTC bounds on creation time). Multiple values are expressed by repeating a key — comma-joined lists are not parsed — and any unknown query key is rejected with a 400. Results are scoped to the caller's tenant, which must own the flow endpoint; requires the FileDownload permission.

Required privilege: File Download.

Authorizations:
ApiKeyOAuth2BearerAuth
path Parameters
flowEndpointId
required
integer <int32>

Identifier of the flow endpoint whose files are listed. Must be a positive integer.

query Parameters
maxFiles
Array of strings

Maximum number of files to return (default 100, max 1000).

fileId
Array of strings

File id filter; repeat the key for multiple values (max 100).

status
Array of strings

File status filter; repeat the key for multiple values (max 10).

actionType
Array of strings

Action type filter; repeat the key for multiple values (max 10).

createdAfter
Array of strings

Inclusive lower bound on file creation time (ISO-8601, UTC).

createdBefore
Array of strings

Inclusive upper bound on file creation time (ISO-8601, UTC).

Responses

Response Schema: application/json
flowEndpointId
integer <int32>

Identifier of the flow endpoint that was listed.

Array of objects or null (FileListItem)

The matching files, newest first, capped at maxFiles.

returnedCount
integer <int32>

Number of files in files.

truncated
boolean

True when the result hit maxFiles; the caller should narrow filters or page.

object (FileListContext)

Cross-system context shared by every file at a flow endpoint, emitted once per LIST response (D29, option C). All files under one flowEndpointId share the same flow/endpoint/org/tenant/customer ids, so the server sends the block once and the connector copies it onto each emitted document — traceability without repeating six fields per file.

Response samples

Content type
application/json
{
  • "flowEndpointId": 7781,
  • "files": [
    • {
      }
    ],
  • "returnedCount": 2,
  • "truncated": false,
  • "context": {
    • "flowEndpointId": 7781,
    • "flowId": 912,
    • "endpointId": 2043,
    • "organizationId": 118,
    • "tenantId": 57,
    • "customerId": 31
    }
}