共用方式為


Redque (預覽版)

存取和管理 Redque 系統。

此連接器適用於以下產品和區域:

服務 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)
連絡人​​
名稱 雷德克 s.r.o.
URL https://redque.com
Email info@redque.com
連接器中繼資料
Publisher 雷德克 s.r.o.
網站 https://redque.cz/en/
隱私策略 https://redque.cz/policy.html
類別 人工智慧;財政

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

上傳文件並排程處理

上傳文件並排程處理。

下載文件檔案

下載文件的檔案。

下載資料夾

將資料夾中的所有文件下載為單一封存。

傳回列舉

傳回特定的列舉。

傳回所有列舉

傳回所有列舉的清單。

傳回權杖

傳回目前的註冊權杖,如果權杖未作用中,則不傳回任何內容。

刪除使用者

刪除使用者。

刪除具有特定 ID 的列舉

刪除特定列舉。

取得擷取的文件

解壓縮的文件被標記為刪除,並將在訪問後的幾個小時內刪除。 這讓使用者有時間在碰巧失敗時重試擷取結果。

取得文件的中繼資料

取得文件的中繼資料。

將文件存取權授與指定的使用者

將文件存取權授與指定的使用者。

尋找使用者

尋找使用者。

尋找資料夾

依 ID 尋找資料夾。

建立使用者

建立新使用者。

建立新的列舉

請注意,枚舉鍵是自動生成的,值鍵只能包含小寫字母、大寫字母、數字、底線、破折號

建立資料夾

建立新的資料夾。

指定頁面的影像

傳回指定頁面的影像。

授權資訊

傳回授權資訊。

擷取文件

要求擷取文件。 擷取文件後,會排程刪除文件。

新增許可權

將權限新增至使用者。

更改密碼

變更使用者的密碼。

更新使用者

部分更新指定的使用者。

更新傳回寄件者設定

更新會返回寄件者設定。

更新文件

更新文件。

更新特定列舉

更新特定列舉。

更新資料夾資料

更新資料夾資料。

產生權杖

產生新的註冊權杖。

發回發卡機構作更正

將文件退回給發行人,以便更正所提供的電子郵件地址。

移除指定使用者對文件的存取權

移除指定使用者對文件的存取權。

移除權杖

移除註冊權杖。

移除權限

撤銷使用者的權限。

移除現有文件

移除現有文件。

移除資料夾

刪除現有文件夾。

篩選使用者

依準則取得使用者清單。

篩選文件

根據參數傳回文件清單。

解除鎖定鎖定的文件

解除鎖定 (關閉) 的文件,以允許其他使用者修改其內容。

變更使用者的密碼

變更指定使用者的密碼。 需要使用者管理權限。

返回寄件者設定

擷取目前的組態,以返回寄件者動作。

鎖定文件

鎖定 (開啟) 文件,防止其他使用者修改文件。

上傳文件並排程處理

上傳文件並排程處理。

參數

名稱 機碼 必要 類型 Description
檔案
File file

檔案

文件的外部 ID
DocumentId string

外部文件識別碼

資料夾 ID
FolderId string

資料夾識別碼

Date
Date date-time

Date

訂單
Ordinal integer

用於保持平行上傳文件順序的順序

文件是附件嗎
IsAttachment boolean

如果文件是附件,則為 True

文件類別
DocumentClass string

文件類別

傳回

檔案上傳的結果

下載文件檔案

下載文件的檔案。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件識別碼

下載資料夾

將資料夾中的所有文件下載為單一封存。

參數

名稱 機碼 必要 類型 Description
資料夾 ID
folderId True string

資料夾識別碼

傳回列舉

傳回特定的列舉。

參數

名稱 機碼 必要 類型 Description
列舉識別碼
id True string

列舉識別碼

傳回

欄位類型列舉的列舉資料

身體
ApiEnum

傳回所有列舉

傳回所有列舉的清單。

傳回

response
array of ApiEnum

傳回權杖

傳回目前的註冊權杖,如果權杖未作用中,則不傳回任何內容。

傳回

一般回應值

刪除使用者

刪除使用者。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

使用者識別碼

刪除具有特定 ID 的列舉

刪除特定列舉。

參數

名稱 機碼 必要 類型 Description
列舉索引鍵
id True string

列舉識別碼/索引鍵

取得擷取的文件

解壓縮的文件被標記為刪除,並將在訪問後的幾個小時內刪除。 這讓使用者有時間在碰巧失敗時重試擷取結果。

參數

名稱 機碼 必要 類型 Description
文件 ID
id True string

文件 ID(由 RedQue 或外部提供)

取得文件的中繼資料

取得文件的中繼資料。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件 ID

文件ID是外部ID嗎?
isExternalId boolean

文件ID是外部ID嗎?

傳回

身體
ApiDocument

將文件存取權授與指定的使用者

將文件存取權授與指定的使用者。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件 ID

使用者識別碼
userId True string

使用者識別碼

documentId
documentId string

文件 ID

userId
userId string

使用者識別碼

訊息
message string

尋找使用者

尋找使用者。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

使用者的識別碼

傳回

用戶資訊

身體
ApiUser

尋找資料夾

依 ID 尋找資料夾。

參數

名稱 機碼 必要 類型 Description
資料夾 ID
folderId True string

資料夾識別碼

與會員
withMembers boolean

如果文件具有成員,則為 True

傳回

容器中繼資料,其中包含容器內文件的中繼資料

建立使用者

建立新使用者。

參數

名稱 機碼 必要 類型 Description
名字
firstName string

使用者名字

lastName
lastName string

使用者姓氏

密碼
password string

帳戶密碼

電子郵件
email string

使用者的電子郵件(登入名稱)

建立新的列舉

請注意,枚舉鍵是自動生成的,值鍵只能包含小寫字母、大寫字母、數字、底線、破折號

參數

名稱 機碼 必要 類型 Description
識別碼
id string

列舉識別碼

名稱
name string

使用者友善的列舉名稱

values
values object

列舉值清單

isEditable
isEditable boolean

指出是否可以編輯列舉

傳回

一般回應值

建立資料夾

建立新的資料夾。

傳回

容器建立的結果

指定頁面的影像

傳回指定頁面的影像。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件 ID

頁面索引
pageIndex True integer

頁面索引

Preview
isPreview boolean

如果應傳回縮小大小的影像,則為 true。

傳回

response
uri

授權資訊

傳回授權資訊。

傳回

身體
MLicense

擷取文件

要求擷取文件。 擷取文件後,會排程刪除文件。

參數

名稱 機碼 必要 類型 Description
文件 ID
externalDocumentId string

文件 ID (選用 - 您的外部文件 ID)

檔案
file file

檔案

新增許可權

將權限新增至使用者。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

使用者的識別碼

使用權限
permissions array of string

存取資料

更改密碼

變更使用者的密碼。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

使用者的識別碼

body
body string

使用者密碼

更新使用者

部分更新指定的使用者。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

使用者識別碼

名字
firstName string

使用者名字

lastName
lastName string

使用者姓氏

更新傳回寄件者設定

更新會返回寄件者設定。

參數

名稱 機碼 必要 類型 Description
樣板
template string
主題
subject string

更新文件

更新文件。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件標識碼

documentId
documentId string
value
value string
value
value string
value
value string
value
value string
value
value string
value
value string
value
value string
value
value boolean
value
value boolean
value
value string
value
value string
作業
operation string
Key
key string
訊息
message string
是警告
isWarning boolean
wordIds
wordIds array of integer
value
value string
作業
operation string
Key
key string
訊息
message string
是警告
isWarning boolean
wordIds
wordIds array of integer
userId
userId string
userId
userId string
狀態
state string

文件狀態

value
value string
作業
operation string
value
value string
作業
operation string

傳回

狀態回應資料。 當請求傳回沒有資料時用作回應。

身體
RedQueStatus

更新特定列舉

更新特定列舉。

參數

名稱 機碼 必要 類型 Description
列舉識別碼
id True string

列舉識別碼

識別碼
id string

列舉識別碼

名稱
name string

使用者友善的列舉名稱

values
values object

列舉值清單

isEditable
isEditable boolean

指出是否可以編輯列舉

更新資料夾資料

更新資料夾資料。

參數

名稱 機碼 必要 類型 Description
資料夾 ID
folderId True string

資料夾識別碼

folderId
folderId string

文件 ID。

擁有者ID
ownerId string

容器擁有者識別碼

創建
created date-time

容器建立時間

中繼資料
metadata object

附加至容器的所有標頭

產生權杖

產生新的註冊權杖。

傳回

一般回應值

發回發卡機構作更正

將文件退回給發行人,以便更正所提供的電子郵件地址。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件 ID

附加文件
additionalDocuments array of string
收件者電子郵件
recipientEmail string
reason
reason string
requestedByUserId
requestedByUserId string

移除指定使用者對文件的存取權

移除指定使用者對文件的存取權。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件識別碼

使用者識別碼
userId True string

使用者識別碼

移除權杖

移除註冊權杖。

移除權限

撤銷使用者的權限。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

使用者的識別碼

使用權限
permissions array of string

存取資料

移除現有文件

移除現有文件。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件 ID

移除資料夾

刪除現有文件夾。

參數

名稱 機碼 必要 類型 Description
資料夾 ID
folderId True string

資料夾識別碼

篩選使用者

依準則取得使用者清單。

參數

名稱 機碼 必要 類型 Description
收發簡訊
text string

用於一般搜尋的搜尋文字

value
value string
略過
skip integer

要從清單開頭略過的項目數。 允許分頁。

take integer

將傳回的清單項目數目上限

欄位
field string

用於聲明用戶排序參數的枚舉

方向
direction string

清單值排序的方向

傳回

搜尋結果

篩選文件

根據參數傳回文件清單。

參數

名稱 機碼 必要 類型 Description
收發簡訊
text string

用於一般搜尋的搜尋文字

value
value string
values
values string

文件狀態

values
values string

文件狀態

value
value string
value
value boolean
values
values string
values
values array of string
from date-time
to date-time
fields
fields object

欄位篩選器

略過
skip integer

要從清單開頭略過的項目數。 允許分頁。

take integer

將傳回的清單項目數目上限

欄位
field string

可排序結果的屬性清單

方向
direction string

清單值排序的方向

範圍
scopes string

篩選應傳回文件部分的文件範圍

傳回

搜尋結果

解除鎖定鎖定的文件

解除鎖定 (關閉) 的文件,以允許其他使用者修改其內容。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件 ID

變更使用者的密碼

變更指定使用者的密碼。 需要使用者管理權限。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

使用者的識別碼

密碼
password string

使用者密碼

accountId
accountId string

使用者的帳戶識別碼

啟動金鑰
activationkey string

使用者的啟動金鑰

返回寄件者設定

擷取目前的組態,以返回寄件者動作。

鎖定文件

鎖定 (開啟) 文件,防止其他使用者修改文件。

參數

名稱 機碼 必要 類型 Description
文件 ID
documentId True string

文件 ID

定義

Api核准

名稱 路徑 類型 Description
核准者
approver ApiUser

用戶資訊

核准步驟時間
approvalStepTime date-time

指派給目前核准者的時間」。

approval狀態
approvalState ApprovalState

文件狀態

delegatedTo
delegatedTo ApiUser

用戶資訊

注意
note string

核准者附註

ApiApprovalReminder

名稱 路徑 類型 Description
fromUser
fromUser ApiUser

用戶資訊

給用戶
toUser ApiUser

用戶資訊

發送時間
sentTime date-time

發送時間

注意
note string

緊急性說明

Api文件

名稱 路徑 類型 Description
documentId
documentId string

文件 ID

externalDocumentId
externalDocumentId string

外部文件 ID

folderId
folderId string

文件容器識別碼

內容哈希
contentHash string

內容雜湊

頁數
pageCount integer

文件中的總頁數,第一個索引為 1。 此數字可能不等於頁數,因為如果文件有太多頁面,則可能會因為效能原因而略過其中一些頁面

fileName
fileName string

文件的檔案名稱

擁有者
owner ApiUser

用戶資訊

狀態
state DocumentState

文件狀態

錯誤
error string

文件的錯誤碼

isImages生成
isImagesGenerated boolean

是否生成了圖像

是已傳回
isReturned boolean

如果文件已傳回給寄件者,則為 true。

return原因
returnReason string

退貨原因。

創建時間
creationTime date-time

建立日期

size
size integer

文件大小 (KB)

內容類型
contentType string

內容類型

來源
source DocumentSource
來源資訊
sourceInfo string

來源詳細信息(一般電子郵件地址)

提取時間
extractionTime date-time

分類日期

型號
model string

本文件的類型

是附件
isAttachment boolean

指出文件是否為附件

isValidated
isValidated boolean

文件是否已驗證的指示器

是編輯的
isEdited boolean

指示器,如果此文件已被編輯(至少一個欄位、註釋或標籤已變更)

注意
note string

自訂使用者附註

fields
fields object

擷取的欄位清單

items
items array of object

擷取項目清單

items
items object
pages
pages array of ApiPage

屬於擷取的所有頁面的清單。

外掛結果
pluginResults array of ApiPluginResult

一般結果

isPostProcess已完成
isPostProcessCompleted boolean

指示器 (如果後處理已完成)

是預先驗證
isPrevalidated boolean

文檔是否有一些預驗證 pp 腳本

最後開放時間
lastOpenTime date-time

最後開放日期

lastOpenUserId
lastOpenUserId string

上次開啟此文件之使用者的識別碼

已鎖定
isLocked boolean

判斷文件是否已鎖定

驗證時間
validationTime date-time

文件已驗證的時間

版本
version integer

版本號碼,每次更新都會遞增

approval狀態
approvalState ApprovalState

文件狀態

currentApproverId
currentApproverId string

必須核准此文件的使用者識別碼

lastApprovalStepTime
lastApprovalStepTime date-time

指派給目前核准者的時間

isCurrentApproverNotification已傳送
isCurrentApproverNotificationSent boolean

通知已傳送給目前的核准者

核准歷史記錄
approvalHistory array of ApiApproval

核准歷史記錄

核准提醒歷史記錄
approvalReminderHistory array of ApiApprovalReminder

核准歷史記錄

授權使用者標識碼
authorizedUserIds array of string

有權存取文件的使用者

重複DocId
duplicateDocIds array of string

重複的文件 ID (根據欄位值)

核准者
approvedBy ApiUser

用戶資訊

驗證者
validatedBy ApiUser

用戶資訊

ApiDocumentApiList結果

搜尋結果

名稱 路徑 類型 Description
list
list array of ApiDocument

所有找到的值清單

有更多
hasMore boolean

如果搜尋可以傳回更多值,則為 True

位移
offset integer

偏移值 (略過值的數目)

ApiEnum

欄位類型列舉的列舉資料

名稱 路徑 類型 Description
識別碼
id string

列舉識別碼

名稱
name string

使用者友善的列舉名稱

values
values object

列舉值清單

isEditable
isEditable boolean

指出是否可以編輯列舉

ApiFolderCreation結果

容器建立的結果

名稱 路徑 類型 Description
folderId
folderId string

容器識別碼

ApiFolderWithMembers

容器中繼資料,其中包含容器內文件的中繼資料

名稱 路徑 類型 Description
folderId
folderId string

文件 ID。

擁有者ID
ownerId string

容器擁有者識別碼

創建
created date-time

容器建立時間

中繼資料
metadata object

附加至容器的所有標頭

會員
members array of ApiDocument

所有容器成員的清單

ApiItemCell

名稱 路徑 類型 Description
value
value string

儲存格值

修改後處理
modifiedByPostProcessing boolean

指出此值是否已由後處理修改

外掛結果
pluginResults array of ApiPluginResult

外掛程式的結果

ApiItemColumn

定義項目表欄。

名稱 路徑 類型 Description
欄位
field string

領域

寬度
width double

列的高度。

ApiItemRow

定義項目表格列。

名稱 路徑 類型 Description
height
height double

列的高度。

細胞
cells array of ApiItemCell

此欄中所有儲存格的清單。 計數應一律等於資料行數目。

ApiItemTable

項目表

名稱 路徑 類型 Description
頁面索引
pageIndex integer

表格所屬頁面的索引。

位移
offset Offset

定義具有 X 和 Y 座標的二維偏移。

columns
columns array of ApiItemColumn

資料行定義清單。

資料列
rows array of ApiItemRow

每列中的列定義和儲存格清單。

Api頁面

文件頁面

名稱 路徑 類型 Description
索引
index integer

文件頁面索引。 從 1 開始索引。

寬度
width integer

頁面的寬度(以像素為單位)。

height
height integer

頁面的高度(以像素為單位)。

輪流
rotation double

頁面的旋轉(以度為單位)。

words
words array of ApiWord

頁面上所有單詞的列表。

itemTable
itemTable ApiItemTable

項目表

ApiPlugin結果

名稱 路徑 類型 Description
插件名稱
pluginName string

取得或設定已驗證此檔的指令碼名稱

結果代碼
resultCode PostProcessResult

後處理結果

value
value string

取得或設定當地語系化訊息的集合

額外資訊必填
extraInformationRequired boolean

取得或設定是否需要額外資訊

額外資訊訊息
extraInformationMessage string

取得或設定額外資訊需求訊息

ApiUpload回應

檔案上傳的結果

名稱 路徑 類型 Description
documentId
documentId string

文件標識碼

folderId
folderId string

資料夾識別碼

Api用戶

用戶資訊

名稱 路徑 類型 Description
識別碼
id string

使用者的 ID

名字
firstName string

使用者名字

lastName
lastName string

使用者姓氏

電子郵件
email string

用戶電子郵件

ApiUserApiList結果

搜尋結果

名稱 路徑 類型 Description
list
list array of ApiUser

所有找到的值清單

有更多
hasMore boolean

如果搜尋可以傳回更多值,則為 True

位移
offset integer

偏移值 (略過值的數目)

阿皮沃德

名稱 路徑 類型 Description
wordId
wordId integer

單字的 ID,對於一個文件來說是唯一的

頁面索引
pageIndex integer

該詞所呈現頁面的索引

收發簡訊
text string

單詞的文本

位置X
locX integer

單字的 X 座標

位置Y
locY integer

單字的 Y 座標

寬度
width integer

單字的寬度

height
height integer

Word 的高度

Approval狀態

文件狀態

文件狀態

文件來源

文件狀態

文件狀態

文件狀態

LicenseTime期間

授權的時段

授權的時段

Micense

名稱 路徑 類型 Description
responseCode
responseCode ResponseCode
回應訊息
responseMessage string
validFrom
validFrom date-time
validTo
validTo date-time
下一個時期
nextPeriod date-time
使用限制
usageLimit integer
usageLimitPeriod
usageLimitPeriod LicenseTimePeriod

授權的時段

是審判
isTrial boolean
使用計數
usageCount integer

Offset

定義具有 X 和 Y 座標的二維偏移。

名稱 路徑 類型 Description
x
x double

在 X 座標處偏移。

y
y double

在 Y 座標處偏移。

後置處理結果

後處理結果

後處理結果

RedQue狀態

狀態回應資料。 當請求傳回沒有資料時用作回應。

名稱 路徑 類型 Description
StatusCode
statusCode integer

狀態碼

訊息
message string

Message

回應代碼 (ResponseCode)

StringApi值

一般回應值

名稱 路徑 類型 Description
value
value string

價值觀

統一資源識別碼 (URI)

uri