Fetches files from a Box Folder. Designed to be used in tandem with ListBoxFile.

Additional Details...


box, storage, fetch


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Box Client Servicebox-client-serviceController Service API:
Implementation: JsonConfigBasedBoxClientService
Controller Service used to obtain a Box API connection.
File IDbox-file-id${box.id}The ID of the File to fetch
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)


successA FlowFile will be routed here for each successfully fetched File.
failureA FlowFile will be routed here for each File for which fetch was attempted but failed.

Reads Attributes:

box.idThe id of the file

Writes Attributes:

box.idThe id of the file
filenameThe name of the file
pathThe folder path where the file is located
box.sizeThe size of the file
box.timestampThe last modified time of the file
error.codeThe error code returned by Box
error.messageThe error message returned by Box

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

ListBoxFile, PutBoxFile