Official |[Box] Add Membership

Operation name

Add Membership

Function overview

Based on the input data, adds the user to Box as a member of the group.

= 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-group-memberships/

Data model

The data model of this component is table model 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" ?>
<table>
  <row>
    <column>login</column>
    <column>group_name</column>
    <column>as_group_admin</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Label	Description	Required/Optional	Remarks
row	-	Repeats for the number of memberships to add.
column	login	Enter the email address that the user uses to log in.	Required
	group_name	Enter the name of the group to add the user to.	Required
	as_group_admin	Enter whether the user is a group administrator.	Optional	Enter either "true" or "false". If omitted, "false" is set.

Output schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>login</column>
    <column>group_name</column>
    <column>status_code</column>
    <column>error_code</column>
    <column>message</column>
    <column>request_id</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Label	Description
row	-	Repeats for the number of input items that failed in the processing.
column	result	When input is invalid, "skipped" is output. When request execution results in an error, "failed" is output.
	login	login of the input item that failed in the processing is output.
	group_name	group_name of the input item that failed in the processing 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	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 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