Get Contents List

Operation name

Get Contents List

Function overview

Acquires an information list of contents (files or folders) specified in input data from Box.

= Remarks =

For details on API specifications used by this component, refer to the Box API reference at the following URL:

https://developer.box.com/reference/get-folders-id-items/

Data model

The data model of this component is XML type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Owner	Required	Available	Enter the email address that folder owners use to log in.
Specification method for Box content	Required	Not available	Select a method to specify Box content. Path (Default) Box content is specified with a path. ID Box content is specified with an ID.
Folder Path	Required	Available	Enter a folder path for Box.	Note This item is available only when Specification method for Box content is Path. For more details on path format, refer to Limitations of BOX category.
Folder ID	Required	Available	Enter a folder ID for Box.	Note This item is available only when Specification method for Box content is ID.
Get recursively	Optional	Not available	For a specified folder, select whether to get the list recursively or not. Selected If the specified folder contains folders, recursively get the contents information under the folder. Not selected (Default) Acquire only the contents information under the specified folder.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

<?xml version="1.0"?>
<contents>
  <content id="" type="" box_content_path="" name="" extension="" size="" created_at="" modified_at="" content_created_at="" content_modified_at="" created_by="" modified_by="" owned_by="">
    <description></description>
  </content>
    :
</contents>

Element name	Attribute name	Description	Remarks
contents	-
content	-	Appears once for each of the acquired content.	For more details on each attribute, refer to the following pages in Box API reference: File (https://developer.box.com/reference/resources/file/) Folder (https://developer.box.com/reference/resources/folder/)
	id	The ID is output.
	type	The type is output. file File folder Folder
	box_content_path	The path on Box is output.
	name	The name is output.
	extension	The Extension of the file is output.	If no value is present, null is output. For folders, null is output.
	size	The size is output. The unit is byte.
	created_at	The date and time when the specified content was created on Box is output.
	modified_at	The date and time when the specified content was last modified on Box is output.
	content_created_at	The date and time when the content was created is output.	The output date and time may be earlier than the time when the content was uploaded to Box.
	content_modified_at	The date and time when the content was last modified is output.	The output date and time may be earlier than the time when the content was uploaded to Box.
	created_by	The email address that the user who created the content in Box uses to log in is output.
	modified_by	The email address that the user who last updated the content in Box uses to log in is output.
	owned_by	The email address that owners use to log in is output.
description	-	The description is output.	If no value is present, null is output.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of output items is stored.	The default value is 0.
file_count	The number of files in output items is stored.	The default value is 0.
folder_count	The number of folders in output items is stored.	The default value is 0.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Box connector