53.5. 생산자 끝점:
생산자 끝점은 엔드포인트 접두사 뒤에 엔드포인트 이름 및 다음에 설명된 관련 옵션을 사용할 수 있습니다. 일부 끝점에는 단축 별칭을 사용할 수 있습니다. 엔드포인트 URI에는 접두사가 포함되어야 합니다.
필수가 아닌 끝점 옵션은 [] 로 표시됩니다. 끝점에 대한 필수 옵션이 없는 경우 [] 옵션 세트 중 하나를 제공해야 합니다. 생산자 끝점은 Camel Exchange In 메시지에 포함된 값이 있는 끝점 옵션의 이름을 차례로 포함해야 하는 특수 옵션을 사용할 수도 있습니다.
엔드포인트 URI 중 하나 또는 메시지 헤더에서 동적으로 모든 끝점 옵션을 제공할 수 있습니다. 메시지 헤더 이름은 CamelBox.<option> 형식이어야 합니다. inBody 옵션은 메시지 헤더를 재정의합니다. 즉, Body=option의 끝점 옵션은 CamelBox.option 헤더를 재정의합니다.
엔드포인트 URI 또는 메시지 헤더에서 defaultRequest 옵션에 값을 지정하지 않으면 null 로 간주됩니다. 다른 옵션이 일치하는 엔드포인트를 충족하지 않는 경우에만 null 값이 사용됩니다.
Box API 오류가 발생하는 경우 엔드포인트에서 com.box.sdk.BoxAPIException 파생 예외 원인을 사용하여 RuntimeCamelException이 발생합니다.
53.5.1. 엔드포인트 접두사 협업
박스 협업에 대한 자세한 내용은 https://developer.box.com/reference#collaboration-object 을 참조하십시오. 다음과 같이 접두사 협업 을 사용하여 다음 끝점을 호출할 수 있습니다.
box:collaborations/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| addFolderCollaboration | add | folderId, collaborator, role | com.box.sdk.BoxCollaboration |
| addFolderCollaborationByEmail | addByEmail | folderId, email, role | com.box.sdk.BoxCollaboration |
| deleteCollaboration | 삭제 | 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 | 문자열 |
| 협업자 | com.box.sdk.BoxCollaborator |
| role | com.box.sdk.BoxCollaboration.Role |
| folderId | 문자열 |
| | 문자열 |
| info | com.box.sdk.BoxCollaboration.Info |
53.5.2. 엔드 포인트 접두사 주석
Box 주석에 대한 자세한 내용은 https://developer.box.com/reference#comment-object 을 참조하십시오. 다음과 같이 접두사 주석 을 사용하여 다음 끝점을 호출할 수 있습니다.
box:comments/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| addFileComment | add | fileId, message | com.box.sdk.BoxFile |
| changeCommentMessage | updateMessage | commentId, message | com.box.sdk.BoxComment |
| deleteComment | 삭제 | commentId | |
| getCommentInfo | info | commentId | com.box.sdk.BoxComment.Info |
| getFileComments | 댓글 | fileId | java.util.List |
| replyToComment | 응답 | commentId, message | com.box.sdk.BoxComment |
협업을 위한 URI 옵션
| 이름 | 유형 |
|---|---|
| commentId | 문자열 |
| fileId | 문자열 |
| message | 문자열 |
53.5.3. 엔드 포인트 Prefix events-logs
Box 이벤트 로그에 대한 자세한 내용은 https://developer.box.com/reference#events 을 참조하십시오. 다음과 같이 event- log 접두사를 사용하여 다음 끝점을 호출할 수 있습니다.
box:event-logs/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| getEnterpriseEvents | 이벤트 | 위치, 이전, [유형] | java.util.List |
이벤트로그에 대한 URI 옵션
| 이름 | 유형 |
|---|---|
| 위치 | 문자열 |
| after | 날짜 |
| 이전 | 날짜 |
| 유형 | com.box.sdk.BoxEvent.Types[] |
53.5.4. 엔드 포인트 접두사 파일
박스 파일에 대한 자세한 내용은 https://developer.box.com/reference#file-object 을 참조하십시오. 다음과 같이 접두사 파일을 사용하여 다음 엔드포인트를 호출할 수 있습니다.
box:files/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| uploadFile | 업로드 | parentFolderId, content, fileName, [created], [modified], [size], [listener] | com.box.sdk.BoxFile |
| downloadFile | 다운로드 | fileId, output, [rangeStart], [rangeEnd], [listener] | java.io.OutputStream |
| copyFile | 복사 | fileId, destinationFolderId, [newName] | com.box.sdk.BoxFile |
| moveFile | 이동 | fileId, destinationFolderId, [newName] | com.box.sdk.BoxFile |
| renameFile | 이름 변경 | fileId, newFileName | com.box.sdk.BoxFile |
| createFileSharedLink | link | fileId, access, [unshareDate], [permissions] | com.box.sdk.BoxSharedLink |
| deleteFile | 삭제 | fileId | |
| uploadNewFileVersion | uploadVersion | fileId, fileContent, [modified], [fileSize], [listener] | com.box.boxsdk.BoxFile |
| promoteFileVersion | promoteVersion | fileId, version | com.box.sdk.BoxFileVersion |
| getFileVersions | 버전 | 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 | 프리뷰 | fileId | java.net.URL |
| getFileThumbnail | 도구 모음 | fileId, fileType, minWidth, minHeight, maxWidth, maxHeight | byte[] |
파일의 URI 옵션
| 이름 | 유형 |
|---|---|
| parentFolderId | 문자열 |
| 콘텐츠 | java.io.InputStream |
| fileName | 문자열 |
| created | 날짜 |
| modified | 날짜 |
| 크기 | long |
| 리스너 | com.box.sdk.ProgressListener |
| 출력 | java.io.OutputStream |
| rangeStart | long |
| rangeEnd | long |
| outputStreams | java.io.OutputStream[] |
| destinationFolderId | 문자열 |
| newName | 문자열 |
| 필드 | String[] |
| info | com.box.sdk.BoxFile.Info |
| fileSize | long |
| 버전 | 정수 |
| 액세스 | com.box.sdk.BoxSharedLink.Access |
| unshareDate | 날짜 |
| 권한 | com.box.sdk.BoxSharedLink.Permissions |
| fileType | com.box.sdk.BoxFile.ThumbnailFileType |
| minWidth | 정수 |
| minHeight | 정수 |
| maxWidth | 정수 |
| maxHeight | 정수 |
| metadata | com.box.sdk.Metadata |
| typeName | 문자열 |
53.5.5. 엔드포인트 접두사 폴더
박스 폴더에 대한 자세한 내용은 https://developer.box.com/reference#folder-object 을 참조하십시오. 다음과 같이 접두사 폴더 를 사용하여 다음 엔드포인트를 호출할 수 있습니다.
box:folders/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| getRootFolder | root | com.box.sdk.BoxFolder | |
| createFolder | create | parentFolderId, folderName | com.box.sdk.BoxFolder |
| createFolder | create | parentFolderId, path | com.box.sdk.BoxFolder |
| copyFolder | 복사 | folderId, destinationfolderId, [newName] | com.box.sdk.BoxFolder |
| moveFolder | 이동 | folderId, destinationFolderId, newName | com.box.sdk.BoxFolder |
| renameFolder | 이름 변경 | folderId, newFolderName | com.box.sdk.BoxFolder |
| createFolderSharedLink | link | folderId, access, [unsharedDate], [permissions] | java.util.List |
| deleteFolder | 삭제 | folderId | |
| getFolder | 폴더 | 경로 | com.box.sdk.BoxFolder |
| getFolderInfo | info | folderId, fields | com.box.sdk.BoxFolder.Info |
| getFolderItems | 항목 | folderId, offset, limit, fields | java.util.List |
| updateFolderInfo | updateInfo | folderId, info | com.box.sdk.BoxFolder |
폴더에대한 URI 옵션
| 이름 | 유형 |
|---|---|
| 경로 | String[] |
| folderId | 문자열 |
| offset | long |
| 제한 | long |
| 필드 | String[] |
| parentFolderId | 문자열 |
| folderName | 문자열 |
| destinationFolderId | 문자열 |
| newName | 문자열 |
| newFolderName | 문자열 |
| info | 문자열 |
| 액세스 | com.box.sdk.BoxSharedLink.Access |
| unshareDate | 날짜 |
| 권한 | com.box.sdk.BoxSharedLink.Permissions |
53.5.6. 엔드 포인트 접두사 그룹
박스 그룹에 대한 자세한 내용은 https://developer.box.com/reference#group-object 을 참조하십시오. 다음과 같이 접두사 그룹을 사용하여 다음 끝점을 호출할 수 있습니다.
box:groups/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| createGroup | create | name, [provenance, externalSyncIdentifier, description, invitabilityLevel, memberViewabilityLevel] | com.box.sdk.BoxGroup |
| addGroupMembership | createMembership | groupId, userId, role | com.box.sdk.BoxGroupMembership |
| deleteGroup | 삭제 | 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 | 멤버십 | groupId | java.uti.Collection |
| getGroupMembershipInfo | membershipInfo | groupMemebershipId | com.box.sdk.BoxGroup.Info |
| updateGroupMembershipInfo | updateMembershipInfo | groupMemebershipId, info | com.box.sdk.BoxGroupMembership |
그룹의URI 옵션
| 이름 | 유형 |
|---|---|
| name | 문자열 |
| groupId | 문자열 |
| userId | 문자열 |
| role | com.box.sdk.BoxGroupMembership.Role |
| groupMembershipId | 문자열 |
| info | com.box.sdk.BoxGroupMembership.Info |
53.5.7. 엔드 포인트 접두사 검색
박스 검색 API에 대한 자세한 내용은 https://developer.box.com/reference#searching-for-content 을 참조하십시오. 다음과 같이 접두사 검색을 사용하여 다음 끝점을 호출할 수 있습니다.
box:search/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| searchFolder | search | folderId, query | java.util.Collection |
검색에대한 URI 옵션
| 이름 | 유형 |
|---|---|
| folderId | 문자열 |
| query | 문자열 |
53.5.8. 엔드 포인트 접두사 작업
Box 작업에 대한 자세한 내용은 https://developer.box.com/reference#task-object-1 을 참조하십시오. 다음과 같이 접두사 작업을 사용하여 다음 끝점을 호출할 수 있습니다.
box:tasks/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| addFileTask | add | fileId, action, dueAt, [message] | com.box.sdk.BoxUser |
| deleteTask | 삭제 | 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 | 할당 | taskId | java.util.List |
| getTaskAssignmentInfo | assignmentInfo | taskAssignmentId | com.box.sdk.BoxTaskAssignment.Info |
작업에대한 URI 옵션
| 이름 | 유형 |
|---|---|
| fileId | 문자열 |
| 작업 | com.box.sdk.BoxTask.Action |
| dueAt | 날짜 |
| message | 문자열 |
| taskId | 문자열 |
| info | com.box.sdk.BoxTask.Info |
| assignTo | com.box.sdk.BoxUser |
| taskAssignmentId | 문자열 |
53.5.9. 엔드 포인트 접두사 사용자
박스 사용자에 대한 자세한 내용은 https://developer.box.com/reference#user-object 을 참조하십시오. 다음과 같이 접두사 사용자를 사용하여 다음 끝점을 호출할 수 있습니다.
box:users/endpoint?[options]
| endpoint | 짧은 별칭 | 옵션 | 결과 본문 유형 |
|---|---|---|---|
| getCurrentUser | currentUser | com.box.sdk.BoxUser | |
| getAllEnterpriseOrExternalUsers | 사용자 | filterTerm, [fields] | com.box.sdk.BoxUser |
| createAppUser | create | name, [params] | com.box.sdk.BoxUser |
| createEnterpriseUser | create | login, name, [params] | com.box.sdk.BoxUser |
| deleteUser | 삭제 | 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 |
사용자를위한 URI 옵션
| 이름 | 유형 |
|---|---|
| defaultRequest | com.box.restclientv2.requestsbase.BoxDefaultRequestObject |
| emailAliasRequest | com.box.boxjavalibv2.requests.requestobjects.BoxEmailAliasRequestObject |
| emailId | 문자열 |
| filterTerm | 문자열 |
| folderId | 문자열 |
| simpleUserRequest | com.box.boxjavalibv2.requests.requestobjects.BoxSimpleUserRequestObject |
| userDeleteRequest | com.box.boxjavalibv2.requests.requestobjects.BoxUserDeleteRequestObject |
| userId | 문자열 |
| userRequest | com.box.boxjavalibv2.requests.requestobjects.BoxUserRequestObject |
| userUpdateLoginRequest | com.box.boxjavalibv2.requests.requestobjects.BoxUserUpdateLoginRequestObject |
