Get Content Attributes

Operation name

Function overview

In Box, gets the attribute information of the content (file or folder) by using the content ID specified in the input data.

= Remarks =

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

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

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.

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

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

Element name	Attribute name	Description	Required/Optional	Remarks
requests	-
request	-	Repeats for the amount of content to get.
	login	Enter the email address that the user uses to log in.	Required
	box_content_id	Enter the ID of the content for which to get the attribute information.	Required	The content ID corresponds to <ID> in the URL "https://.app.box.com/file/<ID>" or "https://.app.box.com/folder/<ID>" that is used to open the content on Box from a browser.
	box_content_type	Enter the type of content (file or folder) for which to get the attribute information. file File folder Folder	Required

Output schema

<?xml version="1.0" encoding="UTF-8" ?>
<responses>
  <response result="" status_code="" error_code="" message="" request_id="">
    <request login="" box_content_id="" box_content_type=""/>
    <content box_content_path="" content_created_at="" content_modified_at="" created_at="" modified_at="" name="" version_number="">
      <shared_link access="" download_url="" is_password_enabled="" unshared_at="" url="">
        <permissions can_download=""/>
      </shared_link>
    </content>
  </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 "failed" or "skipped", 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_id	box_content_id of the processed input item is output.
	box_content_type	box_content_type of the processed input item is output.
content	-	Represents attributes of a content.	If result is a status other than "succeeded", null values are output for the elements and attributes associated with this element.
	box_content_path	The path 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_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.
	name	The name of the content is output.
	version_number	The version number of the file is output.	For folders, null is output.
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 a password is required to access the shared link is output. true A password is required. false A password isn't 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 isn't allowed.

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