Get Shared Link

Operation Name

Get Shared Link

Function Overview

In Box, get the shared link to the content (file or folder) specified in the input data.

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

https://developer.box.com/reference/put-files-id--add-shared-link/
https://developer.box.com/reference/put-folders-id--add-shared-link/

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.
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 Global Resources. For 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".

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, retrieves the information for all Box users who exist in the specified [Destination]. [By user]: Retrieves the information for each Box user specified in the input data.	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) Allows you to specify Box content with a path. [ID]: Allows you to specify Box content 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 adapter. The description will be applied to the specifications.

Schema

Input Schema

The number and names of attributes differ depending on the settings for [Specification method for Box content].

<?xml version="1.0" encoding="UTF-8">
<requests>
  <request login="" box_content_path="" box_content_id="" box_content_type=""/>
    : 
</requests>

Element name	Attribute name	Description	Required/Optional	Remarks
requests	-
request	-	Repeated for the amount of content for which to get shared links.
	login	Enter the email address that the user uses to log in.	Required
	box_content_path	Enter the path to the content for which to get a shared link.	Required	This item is available only when [Specification method for Box content] is [Path]. For more details on path format, refer to "Limitations".
	box_content_id	Enter the ID of the content for which to get a shared link.	Required	This item is available only when [Specification method for Box content] is [ID].
	box_content_type	Enter the type of the content (file or folder) for which to get a shared link. "file": Files "folder": Folders	Required	This item is available only when [Specification method for Box content] is [ID].

Output Schema

The number and names of attributes differ depending on the settings for [Specification method for Box content].

<?xml version="1.0" encoding="UTF-8">
<responses>
  <response result="" status_code="" error_code="" message="" request_id="">
    <request login="" box_content_path="" box_content_id="" box_content_type=""/>
    <sharedlink access="" download_url="" is_password_enable="" unshared_at="" url="">
       <permissions can_download=""/>
    </sharedlink>
  </response>
    : 
<responses>

Element name	Attribute name	Description	Remarks
responses	-
response	-	Repeated 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.
	box_content_path	box_content_path of the processed input item is output.	This item is available only when [Specification method for Box content] is [Path].
	box_content_id	box_content_id of the processed input item is output.	This item is available only when [Specification method for Box content] is [ID].
	box_content_type	box_content_type of the processed input item is output.	This item is available only when [Specification method for Box content] is [ID].
shared_link	-	Represents a shared link.	If result is a status other than "succeeded", null values are output for the elements and attributes associated with this element.
	access	The access level for the shared link is output. "open": All users who know the shared link can access the items. "company": Only users whose email addresses have the same domain as the link creator's account can access. "collaborators": Only invited users can access the content.
	download_url	The URL to download a file on Box is output.	For folders, null is output.
	is_password_enabled	Whether the password is required to access the shared link is output. "true": Password is required. "false": Password is not required.
	unshared_at	The date and time at which the shared link becomes unshared is output.
	url	The URL of the shared link is output.
permissions	can_download	Whether the shared link allows the content to be downloaded is output. "true": Download is allowed. "false": Download is not allowed.

Loading Schema on Mapper

The schema is loaded automatically.

For details, refer to "Edit Schema".

Mass Data Processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not 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 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 the 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 processing of input data is executed one line at a time. Therefore, even if an error occurs during processing, the data which has been processed is applied.

If an error occurs during processing, some of the input data and the error details are output in the results data, and then processing continues.

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].