You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2017/01/04 21:18:41 UTC
svn commit: r1004159 - in /websites/production/camel/content: box.html
cache/main.pageCache
Author: buildbot
Date: Wed Jan 4 21:18:40 2017
New Revision: 1004159
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/box.html
websites/production/camel/content/cache/main.pageCache
Modified: websites/production/camel/content/box.html
==============================================================================
--- websites/production/camel/content/box.html (original)
+++ websites/production/camel/content/box.html Wed Jan 4 21:18:40 2017
@@ -40,6 +40,7 @@
<link href='//camel.apache.org/styles/highlighter/styles/shThemeCamel.css' rel='stylesheet' type='text/css' />
<script src='//camel.apache.org/styles/highlighter/scripts/shCore.js' type='text/javascript'></script>
<script src='//camel.apache.org/styles/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='//camel.apache.org/styles/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
<script type="text/javascript">
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -84,52 +85,52 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="Box-BoxComponent">Box Component</h2><p><strong>Available as of Camel 2.14</strong></p><p>The Box component provides access to all of the Box.com APIs accessible using <a shape="rect" class="external-link" href="https://github.com/box/box-java-sdk-v2/" rel="nofollow">box-java-sdk-v2</a>. It allows producing messages to upload and download files, create, edit, and manage folders, etc. It also supports APIs that allow polling for updates to user accounts and even changes to enterprise accounts, etc.</p><p>Box.com requires the use of OAuth2.0 for all client application authentication. In order to use camel-box with your account, you'll need to create a new application within Box.com at <a shape="rect" class="external-link" href="https://app.box.com/developers/services/edit/" rel="nofollow">https://app.box.com/developers/services/edit/</a>. The Box application's client id and secret will allow access to Box APIs which require a current user.
A user access token is generated and managed by the API for an end user. Alternatively the Camel application can register an implementation of <span style="color: rgb(0,0,0);">com.box.boxjavalibv2.authorization.IAuthSecureStorage to provide an com.box.boxjavalibv2.dao.IAuthData OAuth token</span>.</p><p>Maven users will need to add the following dependency to their pom.xml for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ <dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-box</artifactId>
- <version>${camel-version}</version>
- </dependency>
+<div class="wiki-content maincontent"><h2 id="Box-BoxComponent">Box Component</h2><p><strong>Available as of Camel 2.14</strong></p><p>The Box component provides access to all of the Box.com APIs accessible using <a shape="rect" class="external-link" href="https://github.com/box/box-java-sdk-v2/" rel="nofollow">box-java-sdk-v2</a>. It allows producing messages to upload and download files, create, edit, and manage folders, etc. It also supports APIs that allow polling for updates to user accounts and even changes to enterprise accounts, etc.</p><p>Box.com requires the use of OAuth2.0 for all client application authentication. In order to use camel-box with your account, you'll need to create a new application within Box.com at <a shape="rect" class="external-link" href="https://app.box.com/developers/services/edit/" rel="nofollow">https://app.box.com/developers/services/edit/</a>. The Box application's client id and secret will allow access to Box APIs which require a current user.
A user access token is generated and managed by the API for an end user. Alternatively the Camel application can register an implementation of <span style="color: rgb(0,0,0);"><strong><code>com.box.boxjavalibv2.authorization.IAuthSecureStorage</code></strong> to provide an <strong><code>com.box.boxjavalibv2.dao.IAuthData</code></strong> OAuth token</span>.</p><p>Maven users will need to add the following dependency to their <strong><code>pom.xml</code></strong> for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-box</artifactId>
+ <version>${camel-version}</version>
+</dependency>
]]></script>
-</div></div><h3 id="Box-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://endpoint-prefix/endpoint?[options]
+</div></div><h3 id="Box-URIFormat">URI Format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[box://endpoint-prefix/endpoint?[options]
]]></script>
-</div></div><p>Endpoint prefix can be one of:</p><ul><li>collaborations</li><li>comments</li><li>events</li><li>files</li><li>folders</li><li>groups</li><li>poll-events</li><li>search</li><li>shared-comments</li><li>shared-files</li><li>shared-folders</li><li>shared-items</li><li>users</li></ul><h3 id="Box-BoxComponent.1">BoxComponent</h3><p>The Box Component can be configured with the options below. These options can be provided using the component's bean property <strong><code>configuration</code></strong> of type <strong><code>org.apache.camel.component.box.BoxConfiguration</code></strong>. These options can also be specified in the endpoint URI. </p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Option</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">authSecu
reStorage</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.authorization.IAuthSecureStorage</td><td colspan="1" rowspan="1" class="confluenceTd">OAuth Secure Storage callback, can be used to provide and or save OAuth tokens. The callback may return null on first call to allow the component to login and authorize application and obtain an OAuth token, which can then be saved in the secure storage. For the component to be able to create a token automatically a user password must be provided.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">boxConfig</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.IBoxConfig</td><td colspan="1" rowspan="1" class="confluenceTd">Custom Box SDK configuration, not required normally</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clientId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Box application client ID</td><
/tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clientSecret</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Box application client secret</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">connectionManagerBuilder</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.BoxConnectionManagerBuilder</td><td colspan="1" rowspan="1" class="confluenceTd">Custom Box connection manager builder, used to override default settings like max connections for underlying HttpClient.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">httpParams</td><td colspan="1" rowspan="1" class="confluenceTd">java.util.Map</td><td colspan="1" rowspan="1" class="confluenceTd">Custom HTTP params for settings like proxy host</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">loginTimeout</td><td colspan="1" rowspan="1" class="confluenceTd">int</td><td colspan="1" rowspan="1" class="confluenc
eTd">amount of time the component will wait for a response from Box.com, default is 30 seconds</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">refreshListener</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.authorization.OAuthRefreshListener</td><td colspan="1" rowspan="1" class="confluenceTd">OAuth listener for token updates, if the Camel application needs to use the access token outside the route</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">revokeOnShutdown</td><td colspan="1" rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1" class="confluenceTd">Flag to revoke OAuth refresh token on route shutdown, default false. Will require a fresh refresh token on restart using either a custom IAuthSecureStorage or automatic component login by providing a user password</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">sharedLink</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan
="1" rowspan="1" class="confluenceTd">Box shared link for shared-* endpoints, can be a link for a shared comment, file or folder</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">sharedPassword</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Password associated with the shared link, MUST be provided with sharedLink</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userName</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Box user name, MUST be provided</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userPassword</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call</td></tr></tbody></table></div><h3 id="Box-ProducerEndpoints:">Producer Endpoints:</h3><p>Producer e
ndpoints can use endpoint prefixes followed by endpoint names and associated options described next. A shorthand alias can be used for some endpoints. The endpoint URI MUST contain a prefix.</p><p>Endpoint options that are not mandatory are denoted by <strong>[]</strong>. When there are no mandatory options for an endpoint, one of the set of <strong>[]</strong> options MUST be provided. Producer endpoints can also use a special option <strong><code>inBody</code></strong> that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In message.</p><p>Any of the endpoint options can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format <strong><code>CamelBox.<option></code></strong>. Note that the <strong><code>inBody</code></strong> option overrides message header, i.e. the endpoint option <strong><code>inBody=option</code></strong>
 would override a <strong><code>CamelBox.option</code></strong> header.</p><p>If a value is not provided for the option <strong>defaultRequest</strong> either in the endpoint URI or in a message header, it will be assumed to be <code>null</code>. Note that the <code>null</code> value will only be used if other options do not satisfy matching endpoints.</p><p>In case of Box API errors the endpoint will throw a RuntimeCamelException with a <strong>com.box.restclientv2.exceptions.BoxSDKException</strong> derived exception cause.</p><h4 id="Box-EndpointPrefixcollaborations">Endpoint Prefix <em>collaborations</em></h4><p>For more information on Box collaborations see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#collaborations" rel="nofollow">https://developers.box.com/docs/#collaborations</a>. The following endpoints can be invoked with the prefix <strong><code>collaborations</code></strong> as follows
:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://collaborations/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createCollaboration</td><td colspan="1" rowspan="1" class="confluenceTd">create</td><td colspan="1" rowspan="1" class="confluenceTd">collabRequest, folderId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollaboration</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">deleteCollaboration</td><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd">collabId, defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getAl
lCollaborations</td><td colspan="1" rowspan="1" class="confluenceTd">allCollaborations</td><td colspan="1" rowspan="1" class="confluenceTd">getAllCollabsRequest</td><td colspan="1" rowspan="1" class="confluenceTd">java.util.List</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getCollaboration</td><td colspan="1" rowspan="1" class="confluenceTd">collaboration</td><td colspan="1" rowspan="1" class="confluenceTd">collabId, defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollaboration</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">updateCollaboration</td><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd">collabId, collabRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollaboration</td></tr></tbody></table></div><h5 id="Box-URIOptionsforcollaborations">URI Options for <em>collaborations</em></h5><div class="ta
ble-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">collabId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">collabRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxCollabRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">folderId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getAllCollabsRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxGe
tAllCollabsRequestObject</td></tr></tbody></table></div><h4 id="Box-EndpointPrefixevents">Endpoint Prefix <em>events</em></h4><p>For more information on Box events see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#events" rel="nofollow">https://developers.box.com/docs/#events</a>. Although this endpoint can be used by producers, Box events are better used as a consumer endpoint using the <strong>poll-events</strong> endpoint prefix. The following endpoints can be invoked with the prefix <strong><code>events</code></strong> as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://events/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getEventOptions</td><td colspan="1" rowspan="1" class="confluenceTd">eventOptions</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollection</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getEvents</td><td colspan="1" rowspan="1" class="confluenceTd">events</td><td colspan="1" rowspan="1" class="confluenceTd">eventRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxEventCollection</td></tr></tbody></table></div><h5 id="Box-URIOptionsforevents
">URI Options for <em>events</em></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">eventRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxEventRequestObject</td></tr></tbody></table></div><h4 id="Box-EndpointPrefixgroups">Endpoint Prefix <em>groups</em></h4><p>For more information on Box groups see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#groups" rel="nofollow">https://developers.box.com/docs/#groups</a>. The following endpoints can be invoked with the prefix <strong><code>groups</code></strong>
0;as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://groups/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createGroup</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">[groupRequest], [name]</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxGroup</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createMembership</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">[groupId, role, userId], [groupMembershipRequest]</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxGroupMembership</td></tr><tr><td colspan=
"1" rowspan="1" class="confluenceTd">deleteGroup</td><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, groupId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">deleteMembership</td><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, membershipId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getAllCollaborations</td><td colspan="1" rowspan="1" class="confluenceTd">allCollaborations</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, groupId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollection</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getAllGroups</td><td colspan="1" rowspan="1" class="confluenceTd">allGroups</td><td c
olspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollection</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getMembership</td><td colspan="1" rowspan="1" class="confluenceTd">membership</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, membershipId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxGroupMembership</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getMemberships</td><td colspan="1" rowspan="1" class="confluenceTd">memberships</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, groupId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollection</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">updateGroup</td><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd">groupId, groupRequest</td><td
colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxGroup</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">updateMembership</td><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd">[groupMembershipRequest], [role], membershipId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxGroupMembership</td></tr></tbody></table></div><h5 id="Box-URIOptionsforgroups">URI Options for <em>groups</em></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">groupId</td><td colspan="1" rowspan="1" class="c
onfluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">groupMembershipRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxGroupMembershipRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">groupRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxGroupRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">membershipId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">name</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">role</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h4 id="Box-Endpoi
ntPrefixsearch"><span style="font-size: 16.0px;line-height: 1.5625;">Endpoint Prefix </span><em style="font-size: 16.0px;line-height: 1.5625;">search</em></h4><p>For more information on Box search API see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#search" rel="nofollow">https://developers.box.com/docs/#search</a>. The following endpoints can be invoked with the prefix <strong><code>search</code></strong> as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://search/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">search</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, searchQuery</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollection</td></tr></tbody></table></div><h5 id="Box-URIOptionsforsearch">URI Options for <em>search</em></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest
</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">searchQuery</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h4 id="Box-EndpointPrefixcommentsandshared-comments">Endpoint Prefix <em>comments</em> and <em>shared-comments</em></h4><p>For more information on Box comments see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#comments" rel="nofollow">https://developers.box.com/docs/#comments</a>. The following endpoints can be invoked with the prefix <span><strong>comments</strong> or </span><strong><code>shared-comments</code></strong> as follows. The <span><strong>shared-comments</strong> prefix requires <strong>sharedLink</strong> and <strong>sharedPassword</strong> properties. </span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeCont
ent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://comments/endpoint?[options]
- box://shared-comments/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">addComment</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">[commentRequest], [commentedItemId, commentedItemType, message]</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxComment</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">deleteComment</td><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd">commentId, defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class=
"confluenceTd">getComment</td><td colspan="1" rowspan="1" class="confluenceTd">comment</td><td colspan="1" rowspan="1" class="confluenceTd">commentId, defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxComment</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">updateComment</td><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd">commentId, commentRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxComment</td></tr></tbody></table></div><h5 id="Box-URIOptionsforcommentsandshared-comments">URI Options for <em>comments</em> and <em>shared-comments</em></h5><div class="table-wrap"><table class="confluenceTable" style="line-height: 1.4285715;"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">commentId<
/td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">commentRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxCommentRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">commentedItemId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">commentedItemType</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.IBoxType</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">message</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h4 id="Box-EndpointPrefixfilesandshared-files">Endpoint Prefix <em>files</em>
and <em>shared-files</em></h4><p>For more information on Box files see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#files" rel="nofollow">https://developers.box.com/docs/#files</a>. The following endpoints can be invoked with the prefix <strong><code>files</code></strong> or <strong><code>shared-files</code></strong> as follows. The <strong><code>shared-files </code></strong>prefix requires <strong>sharedLink</strong> and <strong>sharedPassword</strong> properties. </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://files/endpoint?[options]
- box://shared-files/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">copyFile</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">fileId, itemCopyRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFile</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createSharedLink</td><td colspan="1" rowspan="1" class="confluenceTd">create</td><td colspan="1" rowspan="1" class="confluenceTd">fileId, sharedLinkRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFile</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">d
eleteFile</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, fileId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">downloadFile</td><td colspan="1" rowspan="1" class="confluenceTd">download</td><td colspan="1" rowspan="1" class="confluenceTd">[destination, listener], [listener, outputStreams], defaultRequest, fileId</td><td colspan="1" rowspan="1" class="confluenceTd">java.io.InputStream</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">downloadThumbnail</td><td colspan="1" rowspan="1" class="confluenceTd">download</td><td colspan="1" rowspan="1" class="confluenceTd">extension, fileId, imageRequest</td><td colspan="1" rowspan="1" class="confluenceTd">java.io.InputStream</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getFile</td><td colspan="1" rowspan="1" class="confluenceTd">file</td><td colspan="1" rowsp
an="1" class="confluenceTd">defaultRequest, fileId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFile</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getFileComments</td><td colspan="1" rowspan="1" class="confluenceTd">fileComments</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, fileId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollection</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getFileVersions</td><td colspan="1" rowspan="1" class="confluenceTd">fileVersions</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, fileId</td><td colspan="1" rowspan="1" class="confluenceTd">java.util.List</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getPreview</td><td colspan="1" rowspan="1" class="confluenceTd">preview</td><td colspan="1" rowspan="1" class="confluenceTd">extension, fileId, imageRequest</td><td colspan="1" rowspan="1" class="co
nfluenceTd">com.box.boxjavalibv2.dao.BoxPreview</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getThumbnail</td><td colspan="1" rowspan="1" class="confluenceTd">thumbnail</td><td colspan="1" rowspan="1" class="confluenceTd">extension, fileId, imageRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxThumbnail</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">updateFileInfo</td><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd">fileId, fileRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFile</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">uploadFile</td><td colspan="1" rowspan="1" class="confluenceTd">upload</td><td colspan="1" rowspan="1" class="confluenceTd">fileUploadRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFile</td></tr><tr><td colspan="1" rowspan="1" class="c
onfluenceTd">uploadNewVersion</td><td colspan="1" rowspan="1" class="confluenceTd">upload</td><td colspan="1" rowspan="1" class="confluenceTd">fileId, fileUploadRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFile</td></tr></tbody></table></div><h5 id="Box-URIOptionsforfilesandshared-files">URI Options for <em>files</em> and <em>shared-files</em></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">destination</td><td colspan="1" rowspan="1" class="confluenceTd">java.io.File</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">extension</td><td colspan="1"
rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">fileId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">fileRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxFileRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">fileUploadRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxFileUploadRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">imageRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxImageRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">itemCopyRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxItemCopyRequestObject</td></tr><tr><td colspan="1" rowspan="1" clas
s="confluenceTd">listener</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.filetransfer.IFileTransferListener</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">outputStreams</td><td colspan="1" rowspan="1" class="confluenceTd">java.io.OutputStream[]</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">sharedLinkRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxSharedLinkRequestObject</td></tr></tbody></table></div><h4 id="Box-EndpointPrefixfoldersandshared-folders">Endpoint Prefix <em>folders</em> and <em>shared-folders</em></h4><p>For more information on Box folders see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#folders" rel="nofollow">https://developers.box.com/docs/#folders</a>. The following endpoints can be invoked with the prefix <strong><code>folders</code></strong> or <strong><code>shared-folders</code></strong> as fol
lows. The prefix <strong>shared-folders</strong> requires <strong>sharedLink</strong> and <strong>sharedPassword</strong> properties. </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://folders/endpoint?[options]
- box://shared-folders/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">copyFolder</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">folderId, itemCopyRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFolder</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createFolder</td><td colspan="1" rowspan="1" class="confluenceTd">create</td><td colspan="1" rowspan="1" class="confluenceTd">folderRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFolder</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createSha
redLink</td><td colspan="1" rowspan="1" class="confluenceTd">create</td><td colspan="1" rowspan="1" class="confluenceTd">folderId, sharedLinkRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFolder</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">deleteFolder</td><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd">folderDeleteRequest, folderId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getFolder</td><td colspan="1" rowspan="1" class="confluenceTd">folder</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, folderId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFolder</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getFolderCollaborations</td><td colspan="1" rowspan="1" class="confluenceTd">folderCollaborations</td><td colspan="1" rows
pan="1" class="confluenceTd">defaultRequest, folderId</td><td colspan="1" rowspan="1" class="confluenceTd">java.util.List</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getFolderItems</td><td colspan="1" rowspan="1" class="confluenceTd">folderItems</td><td colspan="1" rowspan="1" class="confluenceTd">folderId, pagingRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxCollection</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">updateFolderInfo</td><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd">folderId, folderRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFolder</td></tr></tbody></table></div><h5 id="Box-URIOptionsforfoldersorshared-folders">URI Options for <em>folders</em> or <em>shared-folders</em></h5><p> </p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" cla
ss="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">folderDeleteRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxFolderDeleteRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">folderId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">folderRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxFolderRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">itemCopyRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxItemCopyRequ
estObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">pagingRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxPagingRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">sharedLinkRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxSharedLinkRequestObject</td></tr></tbody></table></div><h4 id="Box-EndpointPrefixshared-items">Endpoint Prefix <em>shared-items</em></h4><p>For more information on Box shared items see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#shared-items" rel="nofollow">https://developers.box.com/docs/#shared-items</a>. The following endpoints can be invoked with the prefix <strong><code>shared-items</code></strong> as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://shared-items/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getSharedItem</td><td colspan="1" rowspan="1" class="confluenceTd">sharedItem</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxItem</td></tr></tbody></table></div><h5 id="Box-URIOptionsforshared-items">URI Options for <em>shared-items</em></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultReq
uest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr></tbody></table></div><h4 id="Box-EndpointPrefixusers">Endpoint Prefix <em>users</em></h4><p>For information on Box users see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#users" rel="nofollow">https://developers.box.com/docs/#users</a>. The following endpoints can be invoked with the prefix <strong><code>users</code></strong> as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://users/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">addEmailAlias</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">emailAliasRequest, userId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxEmailAlias</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createEnterpriseUser</td><td colspan="1" rowspan="1" class="confluenceTd">create</td><td colspan="1" rowspan="1" class="confluenceTd">userRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxUser</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd
">deleteEmailAlias</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, emailId, userId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">deleteEnterpriseUser</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">userDeleteRequest, userId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getAllEnterpriseUser</td><td colspan="1" rowspan="1" class="confluenceTd">allEnterpriseUser</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, filterTerm</td><td colspan="1" rowspan="1" class="confluenceTd">java.util.List</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getCurrentUser</td><td colspan="1" rowspan="1" class="confluenceTd">currentUser</td><td colspan="1" rowspan="1" class="confluen
ceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxUser</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getEmailAliases</td><td colspan="1" rowspan="1" class="confluenceTd">emailAliases</td><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest, userId</td><td colspan="1" rowspan="1" class="confluenceTd">java.util.List</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">moveFolderToAnotherUser</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">folderId, simpleUserRequest, userId</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxFolder</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">updateUserInformaiton</td><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd">userId, userRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.b
oxjavalibv2.dao.BoxUser</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">updateUserPrimaryLogin</td><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd">userId, userUpdateLoginRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.dao.BoxUser</td></tr></tbody></table></div><h5 id="Box-URIOptionsforusers">URI Options for <em>users</em></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.restclientv2.requestsbase.BoxDefaultRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">emailAliasRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxEmailAli
asRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">emailId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">filterTerm</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">folderId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">simpleUserRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxSimpleUserRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userDeleteRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxUserDeleteRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="
confluenceTd">userRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxUserRequestObject</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userUpdateLoginRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.box.boxjavalibv2.requests.requestobjects.BoxUserUpdateLoginRequestObject</td></tr></tbody></table></div><h3 id="Box-ConsumerEndpoints:">Consumer Endpoints:</h3><p>For more information on Box events see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#events" rel="nofollow">https://developers.box.com/docs/#events</a> and for long polling see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#events-long-polling" rel="nofollow">https://developers.box.com/docs/#events-long-polling</a>. Consumer endpoints can only use the endpoint prefix <strong>poll-events</strong> as shown in the example next. <span style="line-height: 1.4285715;">By d
efault the consumer will split the </span><span style="line-height: 1.4285715;">com.box.boxjavalibv2.dao.BoxEventCollection from every long poll and create an exchange for every com.box.boxjavalibv2.dao.BoxEvent</span><span style="line-height: 1.4285715;">. To make the consumer return the entire <span>collection in a single exchange, use the URI option <strong>consumer.splitResult=false</strong></span></span><span style="line-height: 1.4285715;">.</span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ box://poll-events/endpoint?[options]]]></script>
-</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">poll</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">limit, streamPosition, streamType</td><td colspan="1" rowspan="1" class="confluenceTd"> <span>com.box.boxjavalibv2.dao.BoxEvent by default, or <span>com.box.boxjavalibv2.dao.BoxEventCollection when consumer.splitResult=false</span></span></td></tr></tbody></table></div><h5 id="Box-URIOptionsforpoll-events">URI Options for <em>poll-events</em></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</t
h><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">limit</td><td colspan="1" rowspan="1" class="confluenceTd">Integer</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">streamPosition</td><td colspan="1" rowspan="1" class="confluenceTd">Long</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">streamType</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">splitResult</td><td colspan="1" rowspan="1" class="confluenceTd">boolean</td></tr></tbody></table></div><h3 id="Box-Messageheader">Message header</h3><p>Any of the options can be provided in a message header for producer endpoints with <strong>CamelBox.</strong> prefix.</p><h3 id="Box-Messagebody">Message body</h3><p>All result message bodies utilize objects provided by the Box Java SDK. Producer endpoints can specify the option name for incoming message body in the <stron
g>inBody</strong> endpoint parameter.</p><h3 id="Box-TypeConverter">Type Converter</h3><p>The Box component also provides a Camel type converter to convert <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/file/GenericFile.html">GenericFile</a> objects from <a shape="rect" class="external-link" href="http://camel.apache.org/file2.html">File</a> component to a <strong>com.box.restclientv2.requestsbase.BoxFileUploadRequestObject</strong> to upload files to Box.com. The target <strong>folderId</strong> for the upload can be specified in the exchange property <strong>CamelBox.folderId</strong>. If the exchange property is not specified the value defaults to <strong>"</strong><strong>0"</strong> for the root folder ID. </p><h3 id="Box-Usecases"><span style="font-size: 16.0px;line-height: 1.5625;">Use cases</span></h3><p>The following route uploads new files to the user's root folder:</p><div clas
s="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ from("file:...")
- .to("box://files/upload/inBody=fileUploadRequest");
+</div></div><p>Where the <strong><code>endpoint-prefix</code></strong> can be one of:</p><ul><li><strong><code>collaborations</code></strong></li><li><strong><code>comments</code></strong></li><li><strong><code>events</code></strong></li><li><strong><code>files</code></strong></li><li><strong><code>folders</code></strong></li><li><strong><code>groups</code></strong></li><li><strong><code>poll-events</code></strong></li><li><strong><code>search</code></strong></li><li><strong><code>shared-comments</code></strong></li><li><strong><code>shared-files</code></strong></li><li><strong><code>shared-folders</code></strong></li><li><strong><code>shared-items</code></strong></li><li><strong><code>users</code></strong></li></ul><h3 id="Box-BoxComponent.1">BoxComponent</h3><p>The Box Component can be configured with the options below. These options can be provided using the component's bean property <strong><code>configuration</code></strong> of type <strong><code>org.apache.
camel.component.box.BoxConfiguration</code></strong>. These options can also be specified in the endpoint URI. </p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authSecureStorage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.authorization.IAuthSecureStorage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>OAuth Secure Storage callback, can be used to provide and or save OAuth tokens. The callback may return <strong><code>null</code></strong> on first call to allow the component to login and authorize application and obtain an OAuth token, which can then be saved in the secure storage. For the component to be able to create
a token automatically a user password must be provided.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boxConfig</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.IBoxConfig</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Custom Box SDK configuration, not required normally.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>clientId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Box application client ID.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>clientSecret</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Box application client secret.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectionManagerBuilder</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.BoxConnectionManagerBuilder</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Custom Box connection manager builder, used to override default settings like max connections for underlying <strong><code>HttpClient</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpParams</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>java.util.Map</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Custom HTTP params for settings like proxy host.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>loginTimeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Amount of time the component will wait for a response from Box.com. Default is 30 seconds.</p></td></tr><tr><td colspan="1" rowspan="1" class=
"confluenceTd"><p><code>refreshListener</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.authorization.OAuthRefreshListener</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>OAuth listener for token updates, if the Camel application needs to use the access token outside the route.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>revokeOnShutdown</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Flag to revoke OAuth refresh token on route shutdown, default false. Will require a fresh refresh token on restart using either a custom <strong><code>IAuthSecureStorage</code></strong> or automatic component login by providing a user password.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sharedLink</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Stri
ng</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Box shared link for <strong><code>shared-*</code></strong> endpoints, can be a link for a shared comment, file or folder.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sharedPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password associated with the shared link, MUST be provided with <strong><code>sharedLink</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>userName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Box user name, MUST be provided.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>userPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspa
n="1" rowspan="1" class="confluenceTd"><p>Box user password, MUST be provided if <strong><code>authSecureStorage</code></strong> is not set, or returns <strong><code>null</code></strong> on first call.</p></td></tr></tbody></table></div><h3 id="Box-ProducerEndpoints">Producer Endpoints</h3><p>Producer endpoints can use endpoint prefixes followed by endpoint names and associated options described next. A shorthand alias can be used for some endpoints. The endpoint URI <strong><em>MUST</em></strong> contain a prefix.</p><p>Endpoint options that are not mandatory are denoted by <strong><code>[]</code></strong>. When there are no mandatory options for an endpoint, one of the set of <strong><code>[]</code></strong> options <em><strong>MUST</strong></em> be provided. Producer endpoints can also use a special option <strong><code>inBody</code></strong> that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In
message.</p><p>Any of the endpoint options can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format <strong><code>CamelBox.<option></code></strong>. Note that the <strong><code>inBody</code></strong> option overrides message header, i.e. the endpoint option <strong><code>inBody=option</code></strong> would override a <strong><code>CamelBox.option</code></strong> header.</p><p>If a value is not provided for the option <strong><code>defaultRequest</code></strong> either in the endpoint URI or in a message header, it will be assumed to be <strong><code>null</code></strong>. Note that the <strong><code>null</code></strong> value will only be used if other options do not satisfy matching endpoints.</p><p>In case of Box API errors the endpoint will throw a <strong><code>RuntimeCamelException</code></strong> with a <strong><code>com.box.restclientv2.e
xceptions.BoxSDKException</code></strong> derived exception cause.</p><h4 id="Box-EndpointPrefix-collaborations">Endpoint Prefix - <code>collaborations</code></h4><p>For more information on Box collaborations see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#collaborations" rel="nofollow">https://developers.box.com/docs/#collaborations</a>. The following endpoints can be invoked with the prefix <strong><code>collaborations</code></strong> as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[box://collaborations/endpoint?[options]]]></script>
+</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Shorthand Alias</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Options</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Result Body Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>createCollaboration</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>create</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>collabRequest</code>, <code>folderId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxCollaboration</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>deleteCollaboration</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delete</code></p></td><td colspan="1" rowspan="1" class="
confluenceTd"><p><code>collabId</code>, <code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getAllCollaborations</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>allCollaborations</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getAllCollabsRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>java.util.List</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getCollaboration</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>collaboration</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>collabId</code>, <code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxCollaboration</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><c
ode>updateCollaboration</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>update</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>collabId</code>, <code>collabRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxCollaboration</code></p></td></tr></tbody></table></div><h5 id="Box-URIOptionsforcollaborations">URI Options for <code>collaborations</code></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>collabId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>collabRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.bo
x.boxjavalibv2.requests.requestobjects.BoxCollabRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.restclientv2.requestsbase.BoxDefaultRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>folderId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getAllCollabsRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.requests.requestobjects.BoxGetAllCollabsRequestObject</code></p></td></tr></tbody></table></div><h4 id="Box-EndpointPrefix-events">Endpoint Prefix - <code>events</code></h4><p>For more information on Box events see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#events" rel="nofollow">https://developers.box.c
om/docs/#events</a>. Although this endpoint can be used by producers, Box events are better used as a consumer endpoint using the <strong><code>poll-events</code></strong> endpoint prefix. The following endpoints can be invoked with the prefix <strong><code>events</code></strong> as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[box://events/endpoint?[options]]]></script>
+</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Shorthand Alias</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Options</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Result Body Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getEventOptions</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>eventOptions</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxCollection</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getEvents</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>events</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>eventRequest</c
ode></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxEventCollection</code></p></td></tr></tbody></table></div><h5 id="Box-URIOptionsforevents">URI Options for <code>events</code></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.restclientv2.requestsbase.BoxDefaultRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>eventRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.requests.requestobjects.BoxEventRequestObject</code></p></td></tr></tbody></table></div><h4 id="Box-EndpointPrefix-groups">Endpoint Prefix - <code>groups</code></h4
><p>For more information on Box groups see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#groups" rel="nofollow">https://developers.box.com/docs/#groups</a>. The following endpoints can be invoked with the prefix <strong><code>groups</code></strong> as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[box://groups/endpoint?[options]]]></script>
+</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Shorthand Alias</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Options</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Result Body Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>createGroup</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>[groupRequest]</code>, <code>[name]</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxGroup</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>createMembership</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>[groupId, role, userId]</code>, 
<code>[groupMembershipRequest]</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxGroupMembership</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>deleteGroup</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delete</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code>, <code>groupId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>deleteMembership</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delete</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code>, <code>membershipId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getAllCollaborations</code></p></td><td colspan="1" rowspan
="1" class="confluenceTd"><p><code>allCollaborations</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code>, <code>groupId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxCollection</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getAllGroups</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>allGroups</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxCollection</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getMembership</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>membership</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code>, <code>membershipId</code></p></td><td colspan="1" rowspan="1" c
lass="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxGroupMembership</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getMemberships</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>memberships</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code>, <code>groupId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxCollection</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>updateGroup</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>update</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>groupId</code>, <code>groupRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxGroup</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>updateMembership</code></p></td><td colspan="1" r
owspan="1" class="confluenceTd"><p><code>update</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>[groupMembershipRequest]</code>, <code>[role]</code>, <code>membershipId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxGroupMembership</code></p></td></tr></tbody></table></div><h5 id="Box-URIOptionsforgroups">URI Options for <code>groups</code></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.restclientv2.requestsbase.BoxDefaultRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>groupId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>String</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>groupMembershipRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.requests.requestobjects.BoxGroupMembershipRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>groupRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.requests.requestobjects.BoxGroupRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>membershipId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>name</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>role</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><
p><code>String</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>userId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr></tbody></table></div><h4 id="Box-EndpointPrefix-search"><span style="font-size: 16.0px;line-height: 1.5625;">Endpoint Prefix - </span><code>search</code></h4><p>For more information on Box search API see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#search" rel="nofollow">https://developers.box.com/docs/#search</a>. The following endpoints can be invoked with the prefix <strong><code>search</code></strong> as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[box://search/endpoint?[options]]]></script>
+</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Shorthand Alias</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Options</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Result Body Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>search</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code>, <code>searchQuery</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxCollection</code></p></td></tr></tbody></table></div><h5 id="Box-URIOptionsforsearch">URI Options for <em>search</em></h5><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" r
owspan="1" class="confluenceTh"><p>Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.restclientv2.requestsbase.BoxDefaultRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>searchQuery</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr></tbody></table></div><h4 id="Box-EndpointPrefix-commentsandshared-comments">Endpoint Prefix - <code>comments</code> and <strong><code>shared-comments</code></strong></h4><p>For more information on Box comments see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#comments" rel="nofollow">https://developers.box.com/docs/#comments</a>. The following endpoints can be invoked with the prefix <code>comments</code> or <strong><code>shared-comments</code></strong> as follows. The <strong><code>sh
ared-comments</code></strong> prefix requires <strong><code>sharedLink</code></strong> and <strong><code>sharedPassword</code></strong> properties. </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[box://comments/endpoint?[options]
+box://shared-comments/endpoint?[options]]]></script>
+</div></div><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Shorthand Alias</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Options</p></th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>addComment</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>[commentRequest]</code>, <code>[commentedItemId</code>, <code>commentedItemType</code>, <code>message]</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxComment</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>deleteComment</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delete</code></p></td><td colspan="1" r
owspan="1" class="confluenceTd"><p><code>commentId</code>, <code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>getComment</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>comment</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>commentId</code>, <code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxComment</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>updateComment</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>update</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>commentId</code>, <code>commentRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.BoxComment</code></p></td></tr></tbody></table></div><h5 id="
Box-URIOptionsforcommentsandshared-comments">URI Options for <code>comments</code> and <code>shared-comments</code></h5><div class="table-wrap"><table class="confluenceTable" style="line-height: 1.4285715;"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>commentId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>commentRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.requests.requestobjects.BoxCommentRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>commentedItemId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr><tr><td colspan="1" rowspan="1" class="conflu
enceTd"><p><code>commentedItemType</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.boxjavalibv2.dao.IBoxType</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>defaultRequest</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>com.box.restclientv2.requestsbase.BoxDefaultRequestObject</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>message</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td></tr></tbody></table></div><h4 id="Box-EndpointPrefix-filesandshared-files">Endpoint Prefix - <code>files</code> and <code>shared-files</code></h4><p>For more information on Box files see <a shape="rect" class="external-link" href="https://developers.box.com/docs/#files" rel="nofollow">https://developers.box.com/docs/#files</a>. The following endpoints can be invoked with the prefix <strong><code>files</code></strong> or
60;<strong><code>shared-files</code></strong> as follows. The <strong><code>shared-files </code></strong>prefix requires <strong><code>sharedLink</code></strong> and <strong><code>sharedPassword</code></strong> properties. </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[box://files/endpoint?[options]
+box://shared-files/endpoint?[options]]]></script>
[... 33 lines stripped ...]
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.