53.5. プロデューサーエンドポイント:
プロデューサーエンドポイントは、エンドポイント接頭辞の後にエンドポイント名と次に説明する関連オプションを使用できます。一部のエンドポイントには省略形のエイリアスを使用できます。エンドポイント URI には接頭辞が含まれている必要があります。
				必須ではないエンドポイントオプションは [] で示されます。エンドポイントに必須のオプションがない場合、[] オプションのセットの 1 つを提供する必要があります。プロデューサーエンドポイントは、特別なオプション inBody を使用することもできます。このオプションには、値が Camel Exchange In メッセージに含まれるエンドポイントオプションの名前が含まれている必要があります。
			
				エンドポイントオプションは、エンドポイント URI またはメッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelBox.<option> の形式である必要があります。inBody オプションはメッセージヘッダーをオーバーライドすることに注意してください。つまり、エンドポイントオプション inBody=option は CamelBox.option ヘッダーをオーバーライドします。
			
				エンドポイント URI またはメッセージヘッダーのオプション defaultRequest に値が指定されていない場合は、null と見なされます。null 値は、他のオプションが一致するエンドポイントを満たさない場合にのみ使用されることに注意してください。
			
Box API エラーの場合、エンドポイントは com.box.sdk.BoxAPIException から生成された例外が原因で RuntimeCamelException を出力します。
53.5.1. エンドポイント接頭辞 collaborations
					Box コラボレーションの詳細は、https://developer.box.com/reference#collaboration-object を参照してください。次のエンドポイントは、次のように接頭辞 collaborations を使用して呼び出すことができます。
				
box:collaborations/endpoint?[options]
box:collaborations/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| addFolderCollaboration | add | folderId、コラボレーター、ロール | com.box.sdk.BoxCollaboration | 
| addFolderCollaborationByEmail | addByEmail | folderId、電子メール、ロール | com.box.sdk.BoxCollaboration | 
| deleteCollaboration | delete | collaborationId | |
| getFolderCollaborations | コラボレーション | folderId | java.util.Collection | 
| getPendingCollaborations | pendingCollaborations | java.util.Collection | |
| getCollaborationInfo | info | collaborationId | com.box.sdk.BoxCollaboration.Info | 
| updateCollaborationInfo | updateInfo | collaborationId, info | com.box.sdk.BoxCollaboration | 
コラボレーションの URI オプション
| 名前 | タイプ | 
|---|---|
| collaborationId | String | 
| コラボレーター | com.box.sdk.BoxCollaborator | 
| role | com.box.sdk.BoxCollaboration.Role | 
| folderId | String | 
|  | String | 
| info | com.box.sdk.BoxCollaboration.Info | 
53.5.2. エンドポイント接頭辞 comments
					Box コメントの詳細は、https://developer.box.com/reference#comment-object を参照してください。次のエンドポイントは、次のように接頭辞 comments を使用して呼び出すことができます。
				
box:comments/endpoint?[options]
box:comments/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| addFileComment | add | fileId, message | com.box.sdk.BoxFile | 
| changeCommentMessage | updateMessage | commentId, message | com.box.sdk.BoxComment | 
| deleteComment | delete | commentId | |
| getCommentInfo | info | commentId | com.box.sdk.BoxComment.Info | 
| getFileComments | コメント | fileId | java.util.List | 
| replyToComment | 応答 | commentId, message | com.box.sdk.BoxComment | 
コラボレーションの URI オプション
| 名前 | タイプ | 
|---|---|
| commentId | String | 
| fileId | String | 
| message | String | 
53.5.3. エンドポイント接頭辞 events-logs
					Box イベントログの詳細は、https://developer.box.com/reference#events を参照してください。次のエンドポイントは、次のように接頭辞 event-logs で呼び出すことができます。
				
box:event-logs/endpoint?[options]
box:event-logs/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| getEnterpriseEvents | events | position, after, before, [types] | java.util.List | 
event-logs の URI オプション
| 名前 | タイプ | 
|---|---|
| position | String | 
| after | Date | 
| before | Date | 
| types | com.box.sdk.BoxEvent.Types[] | 
53.5.4. エンドポイント接頭辞 files
					Box ファイルの詳細は、https://developer.box.com/reference#file-object を参照してください。次のエンドポイントは、次のように接頭辞 files を使用して呼び出すことができます。
				
box:files/endpoint?[options]
box:files/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| uploadFile | upload | parentFolderId, content, fileName, [created], [modified], [size], [listener] | com.box.sdk.BoxFile | 
| downloadFile | ダウンロード | fileId, output, [rangeStart], [rangeEnd], [listener] | java.io.OutputStream | 
| copyFile | copy | fileId, destinationFolderId, [newName] | com.box.sdk.BoxFile | 
| moveFile | move | fileId, destinationFolderId, [newName] | com.box.sdk.BoxFile | 
| renameFile | rename | fileId, newFileName | com.box.sdk.BoxFile | 
| createFileSharedLink | リンク | fileId, access, [unshareDate], [permissions] | com.box.sdk.BoxSharedLink | 
| deleteFile | delete | fileId | |
| uploadNewFileVersion | uploadVersion | fileId, fileContent, [modified], [fileSize], [listener] | com.box.boxsdk.BoxFile | 
| promoteFileVersion | promoteVersion | fileId, version | com.box.sdk.BoxFileVersion | 
| getFileVersions | versions | fileId | java.util.Collection | 
| downloadPreviousFileVersions | downloadVersion | fileId, version, output, [listener] | java.io.OutputStream | 
| deleteFileVersion | deleteVersion | fileId, version | |
| getFileInfo | info | fileId, fields | com.box.sdk.BoxFile.Info | 
| updateFileInfo | updateInfo | fileId, info | com.box.sdk.BoxFile | 
| createFileMetadata | createMetadata | fileId, metadata, [typeName] | com.box.sdk.Metadata | 
| getFileMetadata | metadata | fileId, [typeName] | com.box.sdk.Metadata | 
| updateFileMetadata | updateMetadata | fileId, metadata | com.box.sdk.Metadata | 
| deleteFileMetadata | deleteMetadata | fileId | |
| getDownloadUrl | url | fileId | java.net.URL | 
| getPreviewLink | preview | fileId | java.net.URL | 
| getFileThumbnail | thumbnail | fileId, fileType, minWidth, minHeight, maxWidth, maxHeight | byte[] | 
ファイル の URI オプション
| 名前 | タイプ | 
|---|---|
| parentFolderId | String | 
| content | java.io.InputStream | 
| fileName | String | 
| created | Date | 
| modified | Date | 
| size | Long | 
| listener | com.box.sdk.ProgressListener | 
| output | java.io.OutputStream | 
| rangeStart | Long | 
| rangeEnd | Long | 
| outputStreams | java.io.OutputStream[] | 
| destinationFolderId | String | 
| newName | String | 
| fields | String[] | 
| info | com.box.sdk.BoxFile.Info | 
| fileSize | Long | 
| version | Integer | 
| access | com.box.sdk.BoxSharedLink.Access | 
| unshareDate | Date | 
| permissions | com.box.sdk.BoxSharedLink.Permissions | 
| fileType | com.box.sdk.BoxFile.ThumbnailFileType | 
| minWidth | Integer | 
| minHeight | Integer | 
| maxWidth | Integer | 
| maxHeight | Integer | 
| metadata | com.box.sdk.Metadata | 
| typeName | String | 
53.5.5. エンドポイント接頭辞 folders
					Box フォルダーの詳細は、https://developer.box.com/reference#folder-object を参照してください。次のエンドポイントは、次のように接頭辞 folders を使用して呼び出すことができます。
				
box:folders/endpoint?[options]
box:folders/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| getRootFolder | root | com.box.sdk.BoxFolder | |
| createFolder | create | parentFolderId, folderName | com.box.sdk.BoxFolder | 
| createFolder | create | parentFolderId, path | com.box.sdk.BoxFolder | 
| copyFolder | copy | folderId, destinationfolderId, [newName] | com.box.sdk.BoxFolder | 
| moveFolder | move | folderId, destinationFolderId, newName | com.box.sdk.BoxFolder | 
| renameFolder | rename | folderId, newFolderName | com.box.sdk.BoxFolder | 
| createFolderSharedLink | リンク | folderId, access, [unsharedDate], [permissions] | java.util.List | 
| deleteFolder | delete | folderId | |
| getFolder | folder | path | com.box.sdk.BoxFolder | 
| getFolderInfo | info | folderId, fields | com.box.sdk.BoxFolder.Info | 
| getFolderItems | items | folderId, offset, limit, fields | java.util.List | 
| updateFolderInfo | updateInfo | folderId, info | com.box.sdk.BoxFolder | 
folders の URI オプション
| 名前 | タイプ | 
|---|---|
| path | String[] | 
| folderId | String | 
| offset | Long | 
| limit | Long | 
| fields | String[] | 
| parentFolderId | String | 
| folderName | String | 
| destinationFolderId | String | 
| newName | String | 
| newFolderName | String | 
| info | String | 
| access | com.box.sdk.BoxSharedLink.Access | 
| unshareDate | Date | 
| permissions | com.box.sdk.BoxSharedLink.Permissions | 
53.5.6. エンドポイント接頭辞 groups
					Box グループの詳細は、https://developer.box.com/reference#group-object を参照してください。次のエンドポイントは、次のように接頭辞 groups を使用して呼び出すことができます。
				
box:groups/endpoint?[options]
box:groups/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| createGroup | create | name, [provenance, externalSyncIdentifier, description, invitabilityLevel, memberViewabilityLevel] | com.box.sdk.BoxGroup | 
| addGroupMembership | createMembership | groupId, userId, role | com.box.sdk.BoxGroupMembership | 
| deleteGroup | delete | groupId | |
| getAllGroups | groups | java.util.Collection | |
| getGroupInfo | info | groupId | com.box.sdk.BoxGroup.Info | 
| updateGroupInfo | updateInfo | groupId、groupInfo | com.box.sdk.BoxGroup | 
| addGroupMembership | addMembership | groupId, userId, role | com.box.sdk.BoxGroupMembership | 
| deleteGroupMembership | deleteMembership | groupMembershipId | |
| getGroupMemberships | memberships | groupId | java.uti.Collection | 
| getGroupMembershipInfo | membershipInfo | groupMemebershipId | com.box.sdk.BoxGroup.Info | 
| updateGroupMembershipInfo | updateMembershipInfo | groupMemebershipId、info | com.box.sdk.BoxGroupMembership | 
groups の URI オプション
| 名前 | タイプ | 
|---|---|
| name | String | 
| groupId | String | 
| userId | String | 
| role | com.box.sdk.BoxGroupMembership.Role | 
| groupMembershipId | String | 
| info | com.box.sdk.BoxGroupMembership.Info | 
53.5.7. エンドポイント接頭辞 search
					Box 検索 API の詳細は、https://developer.box.com/reference#searching-for-content を参照してください。次のエンドポイントは、次のように接頭辞 search を使用して呼び出すことができます。
				
box:search/endpoint?[options]
box:search/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| searchFolder | search | folderId, query | java.util.Collection | 
search の URI オプション
| 名前 | タイプ | 
|---|---|
| folderId | String | 
| query | String | 
53.5.8. エンドポイント接頭辞 tasks
					Box タスクの詳細は、https://developer.box.com/reference#task-object-1 を参照してください。次のエンドポイントは、次のように接頭辞 tasks を使用して呼び出すことができます。
				
box:tasks/endpoint?[options]
box:tasks/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| addFileTask | add | fileId, action, dueAt, [message] | com.box.sdk.BoxUser | 
| deleteTask | delete | taskId | |
| getFileTasks | tasks | fileId | java.util.List | 
| getTaskInfo | info | taskId | com.box.sdk.BoxTask.Info | 
| updateTaskInfo | updateInfo | taskId, info | com.box.sdk.BoxTask | 
| addAssignmentToTask | addAssignment | taskId, assignTo | com.box.sdk.BoxTask | 
| deleteTaskAssignment | deleteAssignment | taskAssignmentId | |
| getTaskAssignments | assignments | taskId | java.util.List | 
| getTaskAssignmentInfo | assignmentInfo | taskAssignmentId | com.box.sdk.BoxTaskAssignment.Info | 
tasks の URI オプション
| 名前 | タイプ | 
|---|---|
| fileId | String | 
| action | com.box.sdk.BoxTask.Action | 
| dueAt | Date | 
| message | String | 
| taskId | String | 
| info | com.box.sdk.BoxTask.Info | 
| assignTo | com.box.sdk.BoxUser | 
| taskAssignmentId | String | 
53.5.9. エンドポイント接頭辞 users
					Box ユーザーは、https://developer.box.com/reference#user-object を参照してください。次のエンドポイントは、次のように接頭辞 users を使用して呼び出すことができます。
				
box:users/endpoint?[options]
box:users/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ | 
|---|---|---|---|
| getCurrentUser | currentUser | com.box.sdk.BoxUser | |
| getAllEnterpriseOrExternalUsers | users | filterTerm, [fields] | com.box.sdk.BoxUser | 
| createAppUser | create | name, [params] | com.box.sdk.BoxUser | 
| createEnterpriseUser | create | login, name, [params] | com.box.sdk.BoxUser | 
| deleteUser | delete | userId, notifyUser, force | |
| getUserEmailAlias | emailAlias | userId | com.box.sdk.BoxUser | 
| deleteUserEmailAlias | deleteEmailAlias | userId, emailAliasId | java.util.List | 
| getUserInfo | info | userId | com.box.sdk.BoxUser.Info | 
| updateUserInfo | updateInfo | userId, info | com.box.sdk.BoxUser | 
| moveFolderToUser | - | userId, sourceUserId | com.box.sdk.BoxFolder.Info | 
users の URI オプション
| 名前 | タイプ | 
|---|---|
| defaultRequest | com.box.restclientv2.requestsbase.BoxDefaultRequestObject | 
| emailAliasRequest | com.box.boxjavalibv2.requests.requestobjects.BoxEmailAliasRequestObject | 
| emailId | String | 
| filterTerm | String | 
| folderId | String | 
| simpleUserRequest | com.box.boxjavalibv2.requests.requestobjects.BoxSimpleUserRequestObject | 
| userDeleteRequest | com.box.boxjavalibv2.requests.requestobjects.BoxUserDeleteRequestObject | 
| userId | String | 
| userRequest | com.box.boxjavalibv2.requests.requestobjects.BoxUserRequestObject | 
| userUpdateLoginRequest | com.box.boxjavalibv2.requests.requestobjects.BoxUserUpdateLoginRequestObject |