Get Contents List

Operation Name

Get Contents List

Function Overview

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

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

For details on using variables, refer to "Variables".

Basic Settings

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

Required Settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select Global Resources. For more details on global resource settings, refer to "Global resource properties". [Add]: Add a new global resource. [Edit list]: Allows you to edit the global resource settings in "Edit resource list".
Owner	Required	Available	Enter the email address that folder owners use to log in.
Folder Path	Required	Available	Enter a folder path for Box.	For more details on path format, refer to "Limitations".
Get recursively	Optional	Not available	For a specified folder, select whether to get the list recursively. [Checked]: If the specified folder contains folders, recursively get the contents information under the folder. [Not Checked]: (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) Apply the mass data processing settings of a script property to an adapter. [Disable]: Mass data processing is not 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 adapter. The description will be applied to the specifications.

Schema

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 for each of the acquired contents.	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	An ID is output.
	type	Output the type. "file": Files "folder": Folders
	box_content_path	Output a Box path.
	name	Output a name.
	extension	Output the Extension of the file.	If no value is present, null is output. In the case of a folder, null is always output.
	size	Output the size. The unit is bytes.
	created_at	Output the date and time when the contents were created on Box.
	modified_at	Output the date when the contents were last updated by Box.
	content_created_at	Output the date when the contents were first created by Box.
	content_modified_at	Outputs the date when the contents were last updated.
	created_by	Output the email address that the user who created the contents in Box uses to log in.
	modified_by	Output the email address that the user who last updated the contents in Box uses to log in.
	owned_by	Enter the email address that owners use to log in.
description	-	Output the description.	If no value is present, null is output.

Loading Schema on Mapper

The schema is loaded automatically.

For details, refer to "Edit Schema".

Mass Data Processing

Mass data processing is supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
Count	Stores the number of output items.	The default value is "0".
file_count	Stores the number of files in output items.	The default value is "0".
folder_count	Stores the number of folders in output items.	The default value is "0".
message_category	When an error occurs, the category of the message code corresponding to the occurred error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the occurred error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the occurred error is stored.	The default value is null.
error_type	When an error occurs, the type of an occurred error is stored.	The default value is null. The error type will be in the following format. Example: "java.io.FileNotFoundException" The contents to be stored may vary depending on the version of DataSpider Servista.
error_message	When an error occurs, the message of the occurred error is stored.	The default value is null. The contents to be stored may vary depending on the version of DataSpider Servista.
error_trace	When an error occurs, the trace information of the occurred error is stored.	The default value is null. The contents that will be stored may vary depending on the version and client applications of DataSpider Servista.

Specification Limits

The order of output is the ascending order of the Box path.

Major Exceptions

Exception Name	Cause	Solution
ResourceNotFoundException Resource definition is not found. Name:[]	[Destination] is not specified.	Specify a value for [Destination].
ResourceNotFoundException Resource definition is not found. Name:[<Name of global resources>]	Resource definition selected in [Destination] is not found.	Check the global resource specified in [Destination].
InvalidPropertyConfigurationException A forbidden value for Box was entered in the Owner field.	The user specified in [Owner] does not exist.	Specify an existing owner in Box for [Owner].
InvalidPropertyConfigurationException A forbidden value for Box was entered in the Folder path field.	The specified [Folder path] does not exist.	Specify an existing folder path in Box for [Folder path].
InvalidPropertyConfigurationException Enter the folder path in the Folder path field.	A file path is specified for [Folder path].	Specify a folder path for [Folder path].
BoxClientException	Box has returned an error.	For details on messages, refer to the document portal for Box developer (https://developer.box.com/).