Delete Collaboration

Operation Name

Function Overview

Delete the collaboration of Box 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/delete-collaborations-id/

Data Model

Data model of this type of component is table model 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 content_owner_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.
Output successfully processed items to results data	Optional	Not available	Select whether to output successfully processed items to results data in addition to failed items. [Checked]: Outputs successfully processed items to results data in addition to failed items. [Not Checked]: (default) Outputs only failed items to results data and does not output successfully processed items.

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 of columns and the contents differ depending on the settings for [Specification method for Box content].

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>content_owner_login</column>
    <column>box_content_path</column>
    <column>box_content_id</column>
    <column>box_content_type</column>
    <column>accessor_type</column>
    <column>accessor_login</column>
    <column>accessor_group</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Label	Description	Required/Optional	Remarks
row	-	Repeat the deletion of the collaboration for each row.
column	content_owner_login	Enter the email address that the owner uses to log in.	Required
	box_content_path	Enter the path of the collaboration target.	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 content ID of the collaboration target.	Required	This item is available only when [Specification method for Box content] is [ID].
	box_content_type	Enter the type of the collaboration target content (file or folder). "file": Files "folder": Folders	Required	This item is available only when [Specification method for Box content] is [ID].
	accessor_type	Enter the collaborator type.	Required	To enter a user, enter "user", and to enter a group, enter "group".
	accessor_login	Enter the email address of the collaborator.	Required	Enter this when the accessor_type is "user".
	accessor_group	Enter the group name of the collaborator.	Required	Enter this when the accessor_type is "group".

Output Schema

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

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>content_owner_login</column>
    <column>box_content_path</column>
    <column>box_content_id</column>
    <column>box_content_type</column>
    <column>accessor_type</column>
    <column>accessor_login</column>
    <column>accessor_group</column>
    <column>status_code</column>
    <column>error_code</column>
    <column>message</column>
    <column>request_id</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Label	Description	Remarks
row	-	Repeated for the number of processed input items.	When [Output successfully processed items to results data] is not selected, rows are repeated only for the number of input items that failed in the processing.
column	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.
	content_owner_login	content_owner_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].
	accessor_type	accessor_type of the processed input item is output.
	accessor_login	accessor_login of the processed input item is output.
	accessor_group	accessor_group of the processed input item 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.

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 times that input was successful in the processing is stored.	The default value is "0".
failed_count	The number of times that input failed in the processing is stored.	The default value is "0".
skipped_count	The number of times that input that was 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 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 processing of input data is executed one line at a time. Therefore, even if an error occurs during processing, the data which have been deleted are 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].