Box - Get file metadata

The Box - Get file metadata action A tool for building the processes, logic, and direction within workflows. retrieves and stores values for the metadata attributes you select from the specified file in Box.

For more information about the Box connector, go to Box.

Before you begin: 

Jump to:

Configure the Box - Get file metadata action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add, rename, and copy actions.

  2. Select a Connection. If you do not have a connection, see Add a connection.
  3. In Select a Source type, select how you want to specify the source file.
  4. Specify the File path or File ID:

    1. File path: The Path to the file you want to retrieve metadata from. You can also browse the folder structure using the browse icon ()

    1. File ID: The ID of the file to retrieve metadata from.

Maintain path integrity

Caution: If a file/folder that's used in a workflow is moved, renamed, or deleted, any workflows that use that file/folder will not start or will fail. Make sure you keep the paths in your workflow configurations up to date.

Box - Get file metadata action fields, buttons, and settings

Section

Field

Description

Variable types

(unlabeled)

Connection Credentials and other settings required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

The Box connection to use for retrieving file metadata.

(n/a)

Source

Select a source type

Select how the action finds the file in Box:

  • Path: location in Box directory.
  • File ID: unique file identifier number.

(n/a)

 

File path

Displays when you select the Path as the source type.

Full file path to file for retrieving metadata. Accepts any combination of typed text, text added through navigation (), and inserted variables.

Boolean, DateTime, Decimal, Integer, Text

 

File ID

Displays when you select the File ID source type.

The unique identifier number the action uses to access the file in Box.

Text

Select metadata template

The metadata template to use for retrieving attribute values. The drop-down list is limited to templates that are associated with the specified file.

Note: Metadata templates and custom metadata require Box Enterprise.

(n/a)

Custom metadata

Name

Name of custom attribute. Click Add attribute to add a field for your custom attribute so you can store the value.

Note: Metadata templates and custom metadata require Box Enterprise.

(n/a)
Output Output

Object variable to store the following retrieved metadata.

  • File ID: (Text) The new file ID of the file.

  • File name: (Text) The name of the file from which metadata was retrieved.

  • File path: (Text) The full file path of the file from which metadata was retrieved.

  • Created date: (DateTime) The creation date for the file from which metadata was retrieved.

  • Created by (display name): (Text) The display name of the person who created the file from which metadata was retrieved.

  • Created by (email): (Text) The email of the person who created the file from which metadata was retrieved.

  • Modified date: (DateTime) The modified date for the file from which metadata was retrieved.

  • Modified by (display name): (Text) The display name of the person who modified the file.

  • Modified by (email): (Text) The display name of the person who modified the file.

  • File size (bytes): (Integer) The size, in bytes, of the file from which metadata was retrieved.

 Object