Skip to main content

FetchBoxFile

Description

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

Tags

box, fetch, storage

Properties

In the list below required Properties are shown with an asterisk (*). Other properties 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 Service *box-client-serviceController Service:
BoxClientService

Implementations:
JsonConfigBasedBoxClientService
Controller Service used to obtain a Box API connection.
File ID *box-file-id${box.id}The ID of the File to fetch

Supports Expression Language, using FlowFile attributes and Environment variables.

Dynamic Properties

This component does not support dynamic properties.

Relationships

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

Reads Attributes

NameDescription
box.idThe id of the file

Writes Attributes

NameDescription
box.idThe id of the file
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
filenameThe name of the file
pathThe folder path where the file is located

State Management

This component does not store state.

Restricted

This component is not restricted.

Input Requirement

This component requires an incoming relationship.

System Resource Considerations

This component does not specify system resource considerations.

See Also

ListBoxFile, PutBoxFile