Copy File Request

Operation name

Copy File Request

Function overview

Copies a file request specified in the input data and applies it to another folder on 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/post-file-requests-id-copy/

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.
Input data	Required	Not available	Select a component 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.

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.

Advanced settings

Item name	Required/Optional	Use of variables	Description	Remarks
Retrieval method for user information	Required	Not available	Specify a method to retrieve information for a user specified for login in the input schema. All (Default) At the start of processing, the information for all Box users who exist in the specified Destination is retrieved. By user The information for each Box user specified in the input data is retrieved.	When there are many managed users on Box, if you specify All, it takes time to retrieve the user information. As a result, the processing time becomes longer. In this case, if the number of users specified in the input data is small, you can reduce the processing time by selecting By user.
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.

Item name

Required/Optional

Use of variables

Description

Remarks

Retrieval method for user information

Required

Not available

Specify a method to retrieve information for a user specified for login in the input schema.

All

(Default)

At the start of processing, the information for all Box users who exist in the specified Destination is retrieved.

By user

The information for each Box user specified in the input data is retrieved.

When there are many managed users on Box, if you specify All, it takes time to retrieve the user information. As a result, the processing time becomes longer.

In this case, if the number of users specified in the input data is small, you can reduce the processing time by selecting By user.

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.

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

Note

The attribute name differs depending on the settings for Specification method for Box content.

<?xml version="1.0" encoding="UTF-8"?>
<requests>
  <request login="" file_request_id="" to_box_folder_path="" to_box_folder_id="" expires_at="" is_email_required="" is_description_required="" status="" title="" >
    <description></description>
  </request>
    : 
</requests>

Element name	Label	Description	Required/Optional	Remarks
requests	-
request	-	Repeats for the number of file requests to copy.
	login	Enter the email address that the user uses to log in.	Required
	file_request_id	Enter the ID that uniquely distinguishes the file request to copy.	Required	You can find the ID of a file request in the URL for accessing the file request edit screen on Box. That corresponds to <ID> in "https://.box.com/filerequest/<ID>*".
	to_box_folder_path	Enter the path of the folder to which the copied file request is applied.	Required	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.
	to_box_folder_id	Enter the ID of the folder to which the copied file request is applied.	Required	Note This item is available only when Specification method for Box content is ID.
	expires_at	Enter the date and time when the file request will expire and no longer accept new submissions.	Optional	If you omit the setting, the value of the copy source is set.
	is_description_required	Enter whether a user is required to provide a description of the file in the file request.	Optional	Enter either "true" or "false". If you omit the setting, the value of the copy source is set.
	is_email_required	Enter whether a user is required to provide an email address in the file request.	Optional	Enter either "true" or "false". If you omit the setting, the value of the copy source is set.
	status	Enter the status of the file request. active The file request accepts new submissions. inactive The file request no longer accepts new submissions.	Optional	If you omit the setting, the value of the copy source is set.
	title	Enter a title for the file request.	Optional	If you omit the setting, the value of the copy source is set. If you enter a string with only single-byte spaces, it's considered as omitted.
description	-	Enter a description for the file request.	Optional	If you omit the setting, the value of the copy source is set. If you enter a string with only single-byte spaces, it's considered as omitted.

Output schema

The attribute name differs depending on the settings for Specification method for Box content.

<?xml version="1.0" encoding="UTF-8"?>
<responses>
  <response result="" status_code="" error_code="" request_id="" message="">
    <request login="" file_request_id="" to_box_folder_path="" to_box_folder_id=""/>
    <file_request is_description_required="" is_email_required="" status="" title="" url="">
        <description></description>
    </file_request>
  </response>
    : 
</responses>

Element name	Attribute name	Description	Remarks
responses	-
response	-	Repeats for the number of processed input items.
	result	When request execution succeeds, "succeeded" is output. When input is invalid, "skipped" is output. When request execution results in an error, "failed" is output.
	status_code	If the result is "failed", an HTTP status code is output from Box.
	error_code	If the result is "failed", an error code that identifies the error contents is output.
	message	If the result is "skipped" or "failed", an error message is output.
	request_id	If the result is "failed", the ID that uniquely distinguishes the request relative to Box is output.
request	-	Represents a processed input item.
	login	login of the processed input item is output.
	file_request_id	file_request_id of the processed input item is output.
	to_box_folder_path	to_box_folder_path of the processed input item is output.	Note This item is available only when Specification method for Box content is Path.
	to_box_folder_id	to_box_folder_id of the processed input item is output.	Note This item is available only when Specification method for Box content is ID.
file_request	-	Represents a file request.	If result is a status other than "succeeded", null values are output for the elements and attributes associated with this element.
	expires_at	The date and time when the file request will expire and no longer accept new submissions is output.
	is_description_required	Whether a user is required to provide a description of the file in the file request is output.
	is_email_required	Whether a user is required to provide an email address in the file request is output.
	status	The status of the file request is output.
	title	The title of the file request is output.
	url	The URL created for the file request is output.	For the domain of the url, the string entered in File request domain name in the connection resource is used.
description	-	The description of the file request is output.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
succeeded_count	The number of input items that were processed successfully is stored.	The default value is 0.
failed_count	The number of input items that failed in the processing is stored.	The default value is 0.
skipped_count	The number of input items that were skipped in the processing 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