THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
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 CamelBox.<option>. Note that the inBody option overrides message header, i.e. the endpoint option inBody=option would override a CamelBox.option header.
If a value is not provided for the option defaultRequest either in the endpoint URI or in a message header, it will be assumed to be null. Note that the null value will only be used if other options do not satisfy matching endpoints.
In case of Box API errors the endpoint will throw a RuntimeCamelException with a com.box.restclientv2.exceptions.BoxSDKException derived exception cause.
...
URI Options for collaborations
If a value is not provided for one of the option(s) [defaultRequest] either in the endpoint URI or in a message header, it will be assumed to be null. Note that the null value(s) will only be used if other options do not satisfy matching endpoints.
| Name | Type |
|---|---|
| collabId | |
| Name | Type |
| collabId | String |
| collabRequest | com.box.boxjavalibv2.requests.requestobjects.BoxCollabRequestObject |
| defaultRequest | com.box.restclientv2.requestsbase.BoxDefaultRequestObject |
| folderId | String |
| getAllCollabsRequest | com.box.boxjavalibv2.requests.requestobjects.BoxGetAllCollabsRequestObject |
...
| Code Block |
|---|
box://events/endpoint?[options] |
| Endpoint | Shorthand Alias | Options | Result Body Type |
|---|---|---|---|
| getEventOptions | eventOptions | defaultRequest | com.box.boxjavalibv2.dao.BoxCollection |
| getEvents | events | eventRequest | com.box.boxjavalibv2.dao.BoxEventCollection |
URI Options for events
If a value is not provided for one of the option(s) [defaultRequest] either in the endpoint URI or in a message header, it will be assumed to be null. Note that the null value(s) will only be used if other options do not satisfy matching endpoints.
| Name | Type |
|---|---|
| defaultRequest | com.box.restclientv2.requestsbase.BoxDefaultRequestObject |
| eventRequest | com.box.boxjavalibv2.requests.requestobjects.BoxEventRequestObject |
...
| Endpoint | Shorthand Alias | Options | Result Body Type |
|---|---|---|---|
| createGroup | [groupRequest], [name] | com.box.boxjavalibv2.dao.BoxGroup | |
| createMembership | [groupId, role, userId], [groupMembershipRequest] | com.box.boxjavalibv2.dao.BoxGroupMembership | |
| deleteGroup | delete | defaultRequest, groupId | |
| deleteMembership | delete | defaultRequest, membershipId | |
| getAllCollaborations | allCollaborations | defaultRequest, groupId | com.box.boxjavalibv2.dao.BoxCollection |
| getAllGroups | allGroups | defaultRequest | com.box.boxjavalibv2.dao.BoxCollection |
| getMembership | membership | defaultRequest, membershipId | com.box.boxjavalibv2.dao.BoxGroupMembership |
| getMemberships | memberships | defaultRequest, groupId | com.box.boxjavalibv2.dao.BoxCollection |
| updateGroup | update | groupId, groupRequest | com.box.boxjavalibv2.dao.BoxGroup |
| updateMembership | update | [groupMembershipRequest], [role], membershipId | com.box.boxjavalibv2.dao.BoxGroupMembership |
URI Options for groups
If a value is not provided for one of the option(s) [defaultRequest] either in the endpoint URI or in a message header, it will be assumed to be null. Note that the null value(s) will only be used if other options do not satisfy matching endpoints.
| Name | Type |
|---|---|
| defaultRequest | com.box.restclientv2.requestsbase.BoxDefaultRequestObject |
| groupId | String |
| groupMembershipRequest | com.box.boxjavalibv2.requests.requestobjects.BoxGroupMembershipRequestObject |
| groupRequest | com.box.boxjavalibv2.requests.requestobjects.BoxGroupRequestObject |
| membershipId | String |
| name | String |
| role | String |
| userId | String |
...
| Endpoint | Shorthand Alias | Options | Result Body Type |
|---|---|---|---|
| search | defaultRequest, searchQuery | com.box.boxjavalibv2.dao.BoxCollection |
URI Options for search
If a value is not provided for one of the option(s) [defaultRequest] either in the endpoint URI or in a message header, it will be assumed to be null. Note that the null value(s) will only be used if other options do not satisfy matching endpoints.
| .boxjavalibv2.dao.BoxCollection |
URI Options for search
| Name | Type |
|---|---|
| defaultRequest | com.box.restclientv2.requestsbase.BoxDefaultRequestObject |
| searchQuery | String |
...
| Name | Type |
|---|---|
| commentId | String |
| commentRequest | com.box.boxjavalibv2.requests.requestobjects.BoxCommentRequestObject |
| commentedItemId | String |
| commentedItemType | com.box.boxjavalibv2.dao.IBoxType |
| defaultRequest | com.box.restclientv2.requestsbase.BoxDefaultRequestObject |
| message | String |
...
Endpoint Prefix files and shared-files
The following endpoints can be invoked with the prefix files or shared-files as follows:. The shared-files prefix requires a sharedLink and sharedPassword properties.
| Code Block |
|---|
|
...
box://files/endpoint?[options] |
...
box://shared-files/endpoint?[options] |
...
| Endpoint | Shorthand Alias | Options | Result Body Type |
|---|---|---|---|
| copyFile | fileId, itemCopyRequest | com.box.boxjavalibv2.dao.BoxFile | |
| createSharedLink | create | fileId, sharedLinkRequest | com.box.boxjavalibv2.dao.BoxFile |
| deleteFile | defaultRequest, fileId | ||
| downloadFile | download | [destination, listener], [listener, outputStreams], defaultRequest, fileId | java.io.InputStream |
| downloadThumbnail | download | extension, fileId, imageRequest | java.io.InputStream |
| getFile | file | defaultRequest, fileId | com.box.boxjavalibv2.dao.BoxFile |
| getFileComments | fileComments | defaultRequest, fileId | com.box.boxjavalibv2.dao.BoxCollection |
| getFileVersions | fileVersions | defaultRequest, fileId | java.util.List |
| getPreview | preview | extension, fileId, imageRequest | com.box.boxjavalibv2.dao.BoxPreview |
| getThumbnail | thumbnail | extension, fileId, imageRequest | com.box.boxjavalibv2.dao.BoxThumbnail |
| updateFileInfo | update | fileId, fileRequest | com.box.boxjavalibv2.dao.BoxFile |
| uploadFile | upload | fileUploadRequest | com.box.boxjavalibv2.dao.BoxFile |
| uploadNewVersion | upload | fileId, fileUploadRequest | com.box.boxjavalibv2.dao.BoxFile |
...
| Code Block |
|---|
from("direct:foo")
.setHeader("CamelFacebook.query", header("bar"))
.to("facebook://posts");
|