Objective Connect (預覽版)
Objective Connect 是值得信賴的文件共享平台,允許組織與外部各方共享敏感文檔。 用戶可以在幾秒鐘內創建私人工作區並邀請雲中的參與者。 協作、報告、安全性和合規性功能使政府和受監管行業能夠在外部工作,同時高枕無憂。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連接器中繼資料 | |
|---|---|
| Publisher | 目標公司 |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 密碼 | securestring | 此 API 的密碼 | 對 |
| 伺服器區域。 (英國 - secure.objectiveconnect.co.uk,澳新銀行 - secure.objectiveconnect.com) | 字串 | 指定 Objective Connect 伺服器。 | 對 |
| 用戶名稱 | securestring | 此 API 的使用者名稱 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 上傳文件內容 |
上傳文件的內容 |
| 列出共用文件 |
依工作區UUID取得資產清單 |
| 列出工作區 |
取得要求使用者有權查看的共用清單 |
| 列出文件版本 |
取得資產版本清單 |
| 刪除參與者 |
從工作區中移除參與者 |
| 取得使用者 |
獲取用戶 |
| 取得工作區 |
依識別碼取得工作區 |
| 取得文件內容 |
傳回文件的內容 |
| 取得文件版本 |
取得資產版本 |
| 取得文件版本內容 |
傳回文件版本的內容 |
| 吸引參與者 |
取得工作區參與者 |
| 建立工作區 |
建立工作區 |
| 建立文件 |
如果 Request 是 application:hal+json,則只會建立中繼資料。 如果 Request 是 multipart:form-data,則會在一次呼叫中建立包含內容的檔案。 |
| 新增或更新參與者 |
邀請新參與者或編輯指派的角色 |
上傳文件內容
上傳文件的內容
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件
|
assetUuid | True | string |
文件 UUID |
|
工作空間
|
shareUuid | True | string |
工作區 UUID |
|
檔案內容
|
file | True | file |
要上傳的檔案內容 |
列出共用文件
依工作區UUID取得資產清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作空間
|
shareUuid | True | string |
工作區 UUID |
|
長度
|
length | integer |
要擷取的結果數目上限 |
|
|
Offset
|
offset | integer |
傳回值開始的結果 (預設為 0) |
|
|
父系 UUID
|
parentUuid | string |
共用或母資產的 UUID。 如果提供,結果將僅限於股份或資產的直系子項。 如果無效,則回應會是 200,並顯示空白清單。 |
|
|
Query
|
query | string |
搜尋查詢字串。 如果提供,結果將限制為名稱以指定查詢值開頭的資產。 |
|
|
排序
|
sort | string |
排序順序準則字串。 可接受的值為
|
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
註解計數
|
annotationsCount | integer |
註解計數 |
|
評論計數
|
commentCount | integer |
評論計數 |
|
內容版本
|
contentVersion | integer |
內容版本 |
|
建立日期
|
createdDate | string |
建立日期 |
|
副檔名
|
extension | string |
副檔名 |
|
檔案大小
|
fileSize | integer |
檔案大小 |
|
已鎖定
|
locked | boolean |
已鎖定 |
|
型號
|
model | string |
型號 |
|
修改ByUuid
|
modifiedByUuid | string |
修改ByUuid |
|
修改日期
|
modifiedDate | string |
修改日期 |
|
名稱
|
name | string |
名稱 |
|
pdf預覽狀態
|
pdfPreviewstatus | string |
pdf預覽狀態 |
|
預覽頁數
|
previewPageCount | integer |
預覽頁數 |
|
預覽狀態
|
previewstatus | string |
預覽狀態 |
|
狀態
|
status | string |
狀態 |
|
型別
|
type | string |
型別 |
|
全域唯一識別碼 (UUID)
|
uuid | string |
全域唯一識別碼 (UUID) |
|
wopi限制
|
wopiRestricted | boolean |
wopi限制 |
列出工作區
取得要求使用者有權查看的共用清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
長度
|
length | integer |
要擷取的結果數目上限 |
|
|
Offset
|
offset | integer |
傳回值開始的結果 (預設為 0) |
|
|
所有者
|
ownerUuid | string |
擁有者的使用者 UUID。 如果提供,結果將僅限於該用戶擁有的股份 |
|
|
參與者
|
participantUuid | string |
參與者的使用者 UUID。 如果提供,結果將僅限於該使用者是參與者的共用 |
|
|
Query
|
query | string |
搜尋查詢字串。 如果提供,結果將限制為名稱包含指定查詢值的共用 |
|
|
排序
|
sort | string |
排序順序準則字串。 可接受的值為
|
|
|
工作組
|
workgroupUuid | string |
工作群組 UUID。 如果提供,結果將僅限於屬於工作組的股份 |
傳回
- response
- array of ShareResponse
列出文件版本
取得資產版本清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件
|
assetUuid | True | string |
文件 UUID |
|
工作空間
|
shareUuid | True | string |
工作區 UUID |
|
長度
|
length | integer |
要擷取的結果數目上限 |
|
|
Offset
|
offset | integer |
要開始的結果 (預設為 0)。 |
傳回
- response
- array of DocumentVersion
刪除參與者
從工作區中移除參與者
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
User
|
uuid | True | string |
使用者 UUID |
取得使用者
獲取用戶
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Email
|
emailAddress | string |
要搜尋的電子郵件地址 |
|
|
長度
|
length | integer |
要傳回的結果數目。 僅在使用偏移時使用。 |
|
|
Offset
|
offset | integer |
在此位置之後傳回結果 |
|
|
組織
|
orgUuid | string |
要搜尋的組織的 UUID |
|
|
排序
|
sort | string |
參數 - sort 的格式應該是表示排序欄位的單字,如果不存在,則假設為可選的「:d esc」標籤。 錯誤或空白的要求預設為遞增名稱。 可用的排序包括 - firstName、lastName、電子郵件 |
|
|
使用者 UUID
|
uuids | array |
使用者 uuid 清單 |
傳回
- response
- array of UserResponse
取得工作區
取得文件內容
傳回文件的內容
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件
|
assetUuid | True | string |
通用唯一識別碼 (UUID) |
|
工作空間
|
shareUuid | True | string |
通用唯一識別碼 (UUID) |
取得文件版本
取得資產版本
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件
|
assetUuid | True | string |
通用唯一識別碼 (UUID) |
|
工作空間
|
shareUuid | True | string |
通用唯一識別碼 (UUID) |
|
版本
|
version | True | integer |
文件的版本號碼 |
傳回
取得文件版本內容
傳回文件版本的內容
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件
|
assetUuid | True | string |
通用唯一識別碼 (UUID) |
|
內容版本
|
contentVersion | True | integer |
文件的版本號碼 |
|
工作空間
|
shareUuid | True | string |
通用唯一識別碼 (UUID) |
吸引參與者
取得工作區參與者
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
User
|
userUuid | string |
使用者 UUID |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
accepted
|
accepted | boolean |
accepted |
|
電子郵件
|
string |
電子郵件 |
|
|
是擁有者
|
isOwner | boolean |
是擁有者 |
|
加入日期
|
joinedDate | string |
加入日期 |
|
型號
|
model | string |
型號 |
|
名稱
|
name | string |
名稱 |
|
角色
|
roles | array of string |
角色 |
|
shareUuid
|
shareUuid | string |
shareUuid |
|
型別
|
type | string |
型別 |
|
全域唯一識別碼 (UUID)
|
uuid | string |
全域唯一識別碼 (UUID) |
建立工作區
建立工作區
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 UUID
|
userUuid | True | string |
使用者 UUID |
|
存取權
|
access | string | ||
|
代理人
|
agentShareToken | string |
代理程式權杖 |
|
|
名稱
|
name | True | string |
名稱 |
|
組織
|
organisationUuid | string |
組織 UUID |
|
|
所有者
|
ownerUuid | string |
擁有者 UUID |
|
|
總結
|
summary | string |
總結 |
|
|
通用唯一識別碼 (UUID)
|
uuid | string |
通用唯一識別碼 (UUID) |
傳回
建立文件
如果 Request 是 application:hal+json,則只會建立中繼資料。 如果 Request 是 multipart:form-data,則會在一次呼叫中建立包含內容的檔案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區 UUID
|
shareUuid | True | string |
路徑中的共用 uuid |
|
檔案內容
|
file | True | file |
要上傳的檔案內容 |
|
檔案名稱
|
name | True | string |
檔案名稱 |
|
父系 UUID
|
parentUuid | string |
(選擇性) |
|
|
總結
|
summary | string |
(選擇性) |
傳回
新增或更新參與者
邀請新參與者或編輯指派的角色
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電子郵件
|
emails | True | array of string |
電子郵件 |
|
Message
|
message | string |
邀請訊息 |
|
|
角色
|
roles | array of string |
角色 |
|
|
工作區 UUID
|
shareUuid | True | string |
通用唯一識別碼 (UUID) |
|
參與者可見性
|
type | string |
標準 - 對其他參與者可見。 密件抄送 - 參與者將對其他人隱藏 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
accepted
|
accepted | boolean |
accepted |
|
電子郵件
|
string |
電子郵件 |
|
|
是擁有者
|
isOwner | boolean |
是擁有者 |
|
型號
|
model | string |
型號 |
|
角色
|
roles | array of string |
角色 |
|
shareUuid
|
shareUuid | string |
shareUuid |
|
型別
|
type | string |
型別 |
|
全域唯一識別碼 (UUID)
|
uuid | string |
全域唯一識別碼 (UUID) |
定義
存取權
- 存取權
- string
AssetReturnDocument回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
評論計數
|
commentCount | integer | |
|
內容版本
|
contentVersion | integer | |
|
建立日期
|
createdDate | string | |
|
副檔名
|
extension | string | |
|
檔案大小
|
fileSize | integer | |
|
已鎖定
|
locked | boolean | |
|
型號
|
model | string | |
|
修改ByUuid
|
modifiedByUuid | string | |
|
修改日期
|
modifiedDate | string | |
|
名稱
|
name | string | |
|
parentUuid
|
parentUuid | string | |
|
預覽頁數
|
previewPageCount | integer | |
|
預覽狀態
|
previewstatus | PreviewStatus | |
|
狀態
|
status | AssetStatus | |
|
摘要
|
summary | string | |
|
型別
|
type | AssetType | |
|
全域唯一識別碼 (UUID)
|
uuid | string | |
|
wopi限制
|
wopiRestricted | boolean |
資產狀態
AssetType
文件版本
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
建立日期
|
createdDate | string | |
|
副檔名
|
extension | string | |
|
檔案大小
|
fileSize | integer | |
|
型號
|
model | string | |
|
狀態
|
status | AssetStatus | |
|
全域唯一識別碼 (UUID)
|
uuid | string | |
|
版本
|
version | integer |
EndOnDateOptional值
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
禮物
|
present | boolean | |
|
value
|
value | string |
NotificationPreference
- NotificationPreference
- string
預覽狀態
分享回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
存取權
|
access | Access | |
|
connections
|
connections | integer | |
|
建立日期
|
createdDate | string | |
|
EndOnDateOptional值
|
endOnDateOptionalValue | EndOnDateOptionalValue | |
|
型號
|
model | string | |
|
修改日期
|
modifiedDate | string | |
|
名稱
|
name | string | |
|
組織Uuid
|
organisationUuid | string | |
|
ownerUuid
|
ownerUuid | string | |
|
安全的
|
secure | boolean | |
|
共用狀態
|
shareStatus | ShareStatus | |
|
狀態
|
status | AssetStatus | |
|
同步狀態
|
synchStatus | SynchStatus | |
|
全域唯一識別碼 (UUID)
|
uuid | string |
共用狀態
- 共用狀態
- string
同步狀態
- 同步狀態
- string
使用者回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
停用
|
disabled | boolean | |
|
電子郵件
|
string | ||
|
名字
|
firstName | string | |
|
隱藏電子郵件地址
|
hideEmailAddress | boolean | |
|
lastName
|
lastName | string | |
|
型號
|
model | string | |
|
notificationPreferences
|
notificationPreferences | array of NotificationPreference | |
|
組織Uuid
|
organisationUuid | string | |
|
角色
|
roles | array of string | |
|
使用者狀態
|
status | UserStatus | |
|
timezone
|
timezone | string | |
|
全域唯一識別碼 (UUID)
|
uuid | string |
使用者狀態
- 使用者狀態
- string