Redque (プレビュー)
Redque システムへのアクセスと管理。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Redque s.r.o. |
| [URL] | https://redque.com |
| メール | info@redque.com |
| Connector Metadata | |
|---|---|
| 発行者 | Redque s.r.o. |
| Web サイト | https://redque.cz/en/ |
| プライバシー ポリシー | https://redque.cz/policy.html |
| カテゴリー | AI;Finance |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| すべての列挙型を返す |
すべての列挙型のリストを返します。 |
| アクセス許可を削除 |
ユーザーのアクセス許可を取り消します。 |
| アクセス許可を追加する |
ユーザーにアクセス許可を追加します。 |
| トークンを削除 |
登録トークンを削除します。 |
| トークンを生成 |
新しい登録トークンを生成します。 |
| トークンを返す |
現在の登録トークンを返します。トークンがアクティブでない場合は何も返しません。 |
| ドキュメントのファイルをダウンロード |
ドキュメントのファイルをダウンロードします。 |
| ドキュメントのフィルター |
パラメータに基づいてドキュメントのリストを返します。 |
| ドキュメントのメタデータを取得 |
ドキュメントのメタデータを取得します。 |
| ドキュメントのロック |
ドキュメントをロック (開く) して、他のユーザーが変更できないようにします。 |
| ドキュメントの更新 |
ドキュメントを更新します。 |
| ドキュメントをアップロードして処理をスケジュール |
ドキュメントをアップロードして処理をスケジュールします。 |
| ドキュメントを抽出 |
ドキュメントの抽出を要求します。 ドキュメントが取得されると、削除がスケジュールされます。 |
| パスワードの変更 |
ユーザーのパスワードを変更します。 |
| フィルター ユーザー |
条件に基づいてユーザーのリストを取得します。 |
| フォルダー データを更新 |
フォルダー データを更新します。 |
| フォルダーの検索 |
ID でフォルダーを検索します。 |
| フォルダーをダウンロード |
フォルダー内のすべてのドキュメントを単一のアーカイブとしてダウンロードします。 |
| フォルダーを作成する |
新しいフォルダーを作成します。 |
| フォルダーを削除 |
既存のフォルダーを削除します。 |
| ユーザーのパスワードを変更 |
指定したユーザーのパスワードを変更します。 ユーザー管理アクセス許可を求めます。 |
| ユーザーの更新 |
指定されたユーザーを部分的に更新します。 |
| ユーザーを作成 |
新しいユーザーを作成します。 |
| ユーザーを削除 |
ユーザーを削除します。 |
| ユーザーを検索する |
ユーザーを検索します。 |
| ライセンス情報 |
ライセンス情報を返します。 |
| ロックされたドキュメントのロック解除 |
ロックされたドキュメントのロックを解除して (閉じて)、他のユーザーがその内容を変更できるようにします。 |
| 修正のためにドキュメントを発行者に返す |
提供されたメール アドレスの修正のためにドキュメントを発行者に返します。 |
| 列挙型を返す |
特定の列挙型を返します。 |
| 抽出されたドキュメントを |
抽出されたドキュメントは削除対象としてマークされ、アクセスされてから数時間以内に削除されます。 これにより、結果の取得が失敗した場合に、ユーザーに結果の取得を再試行する時間が与えられます。 |
| 指定されたページの画像 |
指定されたページの画像を返します。 |
| 指定されたユーザーにドキュメント アクセスを付与 |
指定されたユーザーにドキュメント アクセスを付与します。 |
| 指定したユーザーのドキュメントへのアクセスを削除 |
指定したユーザーのドキュメントへのアクセスを削除します。 |
| 新しい列挙型を作成 |
列挙キーは自動生成され、値キーには小文字、大文字、数字、アンダースコア、ダッシュのみが含まれている必要があることに注意してください |
| 既存のドキュメントを削除 |
既存のドキュメントを削除します。 |
| 更新して送信者構成に戻す |
更新して送信者構成に戻します。 |
| 特定の ID を持つ列挙型を削除 |
特定の列挙型を削除します。 |
| 特定の列挙型を更新 |
特定の列挙型を更新します。 |
| 送信者構成に戻す |
送信者に返送アクションの現在の設定を取得します。 |
すべての列挙型を返す
アクセス許可を削除
ユーザーのアクセス許可を取り消します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
ユーザーの ID |
|
permissions
|
permissions | array of string |
データへのアクセス |
アクセス許可を追加する
ユーザーにアクセス許可を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
ユーザーの ID |
|
permissions
|
permissions | array of string |
データへのアクセス |
トークンを削除
登録トークンを削除します。
トークンを生成
トークンを返す
ドキュメントのファイルをダウンロード
ドキュメントのファイルをダウンロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメント識別子 |
ドキュメントのフィルター
パラメータに基づいてドキュメントのリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
text
|
text | string |
一般的な検索に使用される検索テキスト |
|
|
価値
|
value | string | ||
|
values
|
values | string |
ドキュメントの状態 |
|
|
values
|
values | string |
ドキュメントの状態 |
|
|
価値
|
value | string | ||
|
価値
|
value | boolean | ||
|
values
|
values | string | ||
|
values
|
values | array of string | ||
|
送信元
|
from | date-time | ||
|
送信先
|
to | date-time | ||
|
fields
|
fields | object |
フィールド フィルター |
|
|
skip
|
skip | integer |
リストの開始からスキップする項目数。 改ページを許可します。 |
|
|
take (取り出し)
|
take | integer |
返されるリスト項目の最大数 |
|
|
フィールド
|
field | string |
結果をソートできるプロパティのリスト |
|
|
direction
|
direction | string |
リスト値をソートする方向 |
|
|
scopes
|
scopes | string |
ドキュメントのどの部分を返す必要があるかをフィルタリングするドキュメント スコープ |
戻り値
検索結果
ドキュメントのメタデータを取得
ドキュメントのメタデータを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメント id |
|
ドキュメント ID 外部 ID?
|
isExternalId | boolean |
ドキュメント ID 外部 ID? |
戻り値
- Body
- ApiDocument
ドキュメントのロック
ドキュメントをロック (開く) して、他のユーザーが変更できないようにします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
ドキュメントの更新
ドキュメントを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document Id |
|
documentId
|
documentId | string | ||
|
価値
|
value | string | ||
|
価値
|
value | string | ||
|
価値
|
value | string | ||
|
価値
|
value | string | ||
|
価値
|
value | string | ||
|
価値
|
value | string | ||
|
価値
|
value | string | ||
|
価値
|
value | boolean | ||
|
価値
|
value | boolean | ||
|
価値
|
value | string | ||
|
価値
|
value | string | ||
|
Operation
|
operation | string | ||
|
key
|
key | string | ||
|
message
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
価値
|
value | string | ||
|
Operation
|
operation | string | ||
|
key
|
key | string | ||
|
message
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
userId
|
userId | string | ||
|
userId
|
userId | string | ||
|
州
|
state | string |
ドキュメントの状態 |
|
|
価値
|
value | string | ||
|
Operation
|
operation | string | ||
|
価値
|
value | string | ||
|
Operation
|
operation | string |
戻り値
ステータス応答データ。 要求がデータを返さない場合の応答として使用されます。
- Body
- RedQueStatus
ドキュメントをアップロードして処理をスケジュール
ドキュメントをアップロードして処理をスケジュールします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
File
|
File | file |
File |
|
|
ドキュメントの外部 ID
|
DocumentId | string |
外部ドキュメント ID |
|
|
フォルダー ID
|
FolderId | string |
フォルダー ID |
|
|
日
|
Date | date-time |
日 |
|
|
Order
|
Ordinal | integer |
並行してアップロードされるドキュメントの順序を維持するために使用される順序 |
|
|
ドキュメントは添付ファイルですか
|
IsAttachment | boolean |
ドキュメントが添付ファイルの場合は True |
|
|
ドキュメント クラス
|
DocumentClass | string |
ドキュメント クラス |
戻り値
ファイル アップロードの結果
- Body
- ApiUploadResponse
ドキュメントを抽出
ドキュメントの抽出を要求します。 ドキュメントが取得されると、削除がスケジュールされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
externalDocumentId | string |
ドキュメント ID (オプション - 外部ドキュメント ID) |
|
|
File
|
file | file |
File |
パスワードの変更
ユーザーのパスワードを変更します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
ユーザーの ID |
|
body
|
body | string |
ユーザーのパスワード |
フィルター ユーザー
条件に基づいてユーザーのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
text
|
text | string |
一般的な検索に使用される検索テキスト |
|
|
価値
|
value | string | ||
|
skip
|
skip | integer |
リストの開始からスキップする項目数。 改ページを許可します。 |
|
|
take (取り出し)
|
take | integer |
返されるリスト項目の最大数 |
|
|
フィールド
|
field | string |
ユーザーのソートパラメータを宣言するための列挙型 |
|
|
direction
|
direction | string |
リスト値をソートする方向 |
戻り値
検索結果
- Body
- ApiUserApiListResult
フォルダー データを更新
フォルダー データを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
folderId | True | string |
フォルダー ID |
|
folderId
|
folderId | string |
ドキュメント id。 |
|
|
ownerId
|
ownerId | string |
コンテナー所有者 ID |
|
|
created
|
created | date-time |
コンテナ作成の時刻 |
|
|
metadata
|
metadata | object |
コンテナにアタッチされているすべてのヘッダー |
フォルダーの検索
ID でフォルダーを検索します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
folderId | True | string |
フォルダー識別子 |
|
メンバーと一緒に
|
withMembers | boolean |
メンバーが含まれるドキュメントの場合は True |
戻り値
コンテナ内のドキュメントのメタデータを含むコンテナ メタデータ
- Body
- ApiFolderWithMembers
フォルダーをダウンロード
フォルダー内のすべてのドキュメントを単一のアーカイブとしてダウンロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
folderId | True | string |
フォルダー識別子 |
フォルダーを作成する
フォルダーを削除
既存のフォルダーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
folderId | True | string |
フォルダー識別子 |
ユーザーのパスワードを変更
指定したユーザーのパスワードを変更します。 ユーザー管理アクセス許可を求めます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
ユーザーの ID |
|
password
|
password | string |
ユーザーのパスワード |
|
|
accountId
|
accountId | string |
ユーザーのアカウント ID |
|
|
activationkey
|
activationkey | string |
ユーザーのアクティブ化キー |
ユーザーの更新
指定されたユーザーを部分的に更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
ユーザー ID |
|
firstName
|
firstName | string |
ユーザーの名 |
|
|
lastName
|
lastName | string |
ユーザーの姓 |
ユーザーを作成
新しいユーザーを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
firstName
|
firstName | string |
ユーザーの名 |
|
|
lastName
|
lastName | string |
ユーザーの姓 |
|
|
password
|
password | string |
アカウントのパスワード |
|
|
メールアドレス
|
string |
ユーザーのメールアドレス (ログイン名) |
ユーザーを削除
ユーザーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
ユーザー Id |
ユーザーを検索する
ライセンス情報
ロックされたドキュメントのロック解除
ロックされたドキュメントのロックを解除して (閉じて)、他のユーザーがその内容を変更できるようにします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
修正のためにドキュメントを発行者に返す
提供されたメール アドレスの修正のためにドキュメントを発行者に返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
additionalDocuments
|
additionalDocuments | array of string | ||
|
recipientEmail
|
recipientEmail | string | ||
|
reason
|
reason | string | ||
|
requestedByUserId
|
requestedByUserId | string |
列挙型を返す
抽出されたドキュメントを
抽出されたドキュメントは削除対象としてマークされ、アクセスされてから数時間以内に削除されます。 これにより、結果の取得が失敗した場合に、ユーザーに結果の取得を再試行する時間が与えられます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
id | True | string |
ドキュメント ID (RedQue または外部から提供) |
指定されたページの画像
指定されたページの画像を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
ページ インデックス
|
pageIndex | True | integer |
ページ インデックス |
|
プレビュー
|
isPreview | boolean |
縮小サイズの画像を返す必要がある場合は True。 |
戻り値
- 返答
- uri
指定されたユーザーにドキュメント アクセスを付与
指定されたユーザーにドキュメント アクセスを付与します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
User ID
|
userId | True | string |
User ID |
|
documentId
|
documentId | string |
ドキュメント ID |
|
|
userId
|
userId | string |
ユーザー ID |
|
|
message
|
message | string |
指定したユーザーのドキュメントへのアクセスを削除
指定したユーザーのドキュメントへのアクセスを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメント識別子 |
|
User ID
|
userId | True | string |
ユーザー ID |
新しい列挙型を作成
列挙キーは自動生成され、値キーには小文字、大文字、数字、アンダースコア、ダッシュのみが含まれている必要があることに注意してください
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | string |
列挙型識別子 |
|
|
名称
|
name | string |
ユーザー フレンドリな列挙型名 |
|
|
values
|
values | object |
列挙型値のリスト |
|
|
isEditable
|
isEditable | boolean |
列挙型を編集できるかどうかを示します |
戻り値
汎用応答の値
- Body
- StringApiValue
既存のドキュメントを削除
既存のドキュメントを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメント id |
更新して送信者構成に戻す
更新して送信者構成に戻します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート
|
template | string | ||
|
subject
|
subject | string |
特定の ID を持つ列挙型を削除
特定の列挙型を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
列挙型キー
|
id | True | string |
列挙型識別子/キー |
特定の列挙型を更新
特定の列挙型を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
列挙型識別子
|
id | True | string |
列挙型識別子 |
|
id
|
id | string |
列挙型識別子 |
|
|
名称
|
name | string |
ユーザー フレンドリな列挙型名 |
|
|
values
|
values | object |
列挙型値のリスト |
|
|
isEditable
|
isEditable | boolean |
列挙型を編集できるかどうかを示します |
送信者構成に戻す
送信者に返送アクションの現在の設定を取得します。
定義
ApiApproval
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
承認者
|
approver | ApiUser |
ユーザー情報 |
|
approvalStepTime
|
approvalStepTime | date-time |
現在の承認者への割り当て時間。 |
|
approvalState
|
approvalState | ApprovalState |
ドキュメントの状態 |
|
delegatedTo
|
delegatedTo | ApiUser |
ユーザー情報 |
|
note
|
note | string |
Approver note |
ApiApprovalReminder
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
fromUser
|
fromUser | ApiUser |
ユーザー情報 |
|
toUser
|
toUser | ApiUser |
ユーザー情報 |
|
sentTime
|
sentTime | date-time |
送信の時刻 |
|
note
|
note | string |
緊急メモ |
ApiDocument
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
documentId
|
documentId | string |
ドキュメント ID |
|
externalDocumentId
|
externalDocumentId | string |
外部ドキュメント ID |
|
folderId
|
folderId | string |
ドキュメント コンテナー ID |
|
contentHash
|
contentHash | string |
コンテンツのハッシュ |
|
pageCount
|
pageCount | integer |
ドキュメント内の合計ページ数。最初のインデックスは 1 です。 ドキュメントのページ数が多すぎる場合、パフォーマンス上の理由により一部のページがスキップされる可能性があるため、この数値はページ数と等しくない場合があります |
|
fileName
|
fileName | string |
ドキュメントのファイル名 |
|
所有者
|
owner | ApiUser |
ユーザー情報 |
|
州
|
state | DocumentState |
ドキュメントの状態 |
|
エラー
|
error | string |
ドキュメントのエラー コード |
|
isImagesGenerated
|
isImagesGenerated | boolean |
画像は生成されましたか |
|
isReturned
|
isReturned | boolean |
ドキュメントが送信者に返送された場合は True。 |
|
returnReason
|
returnReason | string |
返却の理由。 |
|
creationTime
|
creationTime | date-time |
作成日 |
|
size
|
size | integer |
ドキュメントのサイズ (KB) |
|
contentType
|
contentType | string |
Content type |
|
source
|
source | DocumentSource | |
|
sourceInfo
|
sourceInfo | string |
ソースの詳細 (一般的なメール アドレス) |
|
extractionTime
|
extractionTime | date-time |
分類日付 |
|
モデル
|
model | string |
このドキュメントのタイプ |
|
isAttachment
|
isAttachment | boolean |
ドキュメントが添付ファイルかどうかを示します |
|
isValidated
|
isValidated | boolean |
ドキュメントが検証されたかどうかを示すインジケータ |
|
isEdited
|
isEdited | boolean |
このドキュメントが編集されているかどうかを示すインジケータ (少なくとも 1 つのフィールド、メモ、またはタグが変更されている) |
|
note
|
note | string |
カスタム ユーザー メモ |
|
fields
|
fields | object |
抽出されたフィールドのリスト |
|
アイテム
|
items | array of object |
抽出された項目のリスト |
|
アイテム
|
items | object | |
|
pages
|
pages | array of ApiPage |
抽出の一部であるすべてのページのリスト。 |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
一般的な結果 |
|
isPostProcessCompleted
|
isPostProcessCompleted | boolean |
後処理が完了したかどうかを示すインジケーター |
|
isPrevalidated
|
isPrevalidated | boolean |
ドキュメントに事前検証 pp スクリプトがあるかどうか |
|
lastOpenTime
|
lastOpenTime | date-time |
最後に開いた日付 |
|
lastOpenUserId
|
lastOpenUserId | string |
最後にこのドキュメントを開いたユーザーの ID |
|
isLocked
|
isLocked | boolean |
ドキュメントがロックされているかどうかを決定 |
|
validationTime
|
validationTime | date-time |
ドキュメントが検証された時刻 |
|
version
|
version | integer |
バージョン番号 (アップデートごとに増分) |
|
approvalState
|
approvalState | ApprovalState |
ドキュメントの状態 |
|
currentApproverId
|
currentApproverId | string |
このドキュメントを承認する必要があるユーザーの ID |
|
lastApprovalStepTime
|
lastApprovalStepTime | date-time |
現在の承認者への割り当て時間 |
|
isCurrentApproverNotificationSent
|
isCurrentApproverNotificationSent | boolean |
現在の承認者に通知が送信されました |
|
approvalHistory
|
approvalHistory | array of ApiApproval |
承認履歴 |
|
approvalReminderHistory
|
approvalReminderHistory | array of ApiApprovalReminder |
承認履歴 |
|
authorizedUserIds
|
authorizedUserIds | array of string |
このドキュメントへのアクセスが許可されているユーザー |
|
duplicateDocIds
|
duplicateDocIds | array of string |
重複したドキュメント ID (フィールド値に基づく) |
|
approvedBy
|
approvedBy | ApiUser |
ユーザー情報 |
|
validatedBy
|
validatedBy | ApiUser |
ユーザー情報 |
ApiDocumentApiListResult
検索結果
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
list
|
list | array of ApiDocument |
見つかったすべての値のリスト |
|
hasMore
|
hasMore | boolean |
検索でより多くの値を返せる場合は True |
|
offset
|
offset | integer |
オフセット値 (スキップされる値の数) |
ApiEnum
フィールド型列挙型の列挙型データ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
列挙型識別子 |
|
名称
|
name | string |
ユーザー フレンドリな列挙型名 |
|
values
|
values | object |
列挙型値のリスト |
|
isEditable
|
isEditable | boolean |
列挙型を編集できるかどうかを示します |
ApiFolderCreationResult
コンテナ作成の結果
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
folderId
|
folderId | string |
コンテナー ID |
ApiFolderWithMembers
コンテナ内のドキュメントのメタデータを含むコンテナ メタデータ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
folderId
|
folderId | string |
ドキュメント id。 |
|
ownerId
|
ownerId | string |
コンテナー所有者 ID |
|
created
|
created | date-time |
コンテナ作成の時刻 |
|
metadata
|
metadata | object |
コンテナにアタッチされているすべてのヘッダー |
|
members
|
members | array of ApiDocument |
すべてのコンテナ メンバーのリスト |
ApiItemCell
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | string |
セルの値 |
|
modifiedByPostProcessing
|
modifiedByPostProcessing | boolean |
この値が後処理によって変更されたかどうかを示します |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
プラグインの結果 |
ApiItemColumn
項目テーブル列を定義します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
フィールド
|
field | string |
Field |
|
幅
|
width | double |
行の高さ。 |
ApiItemRow
項目テーブル行を定義します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
高さ
|
height | double |
行の高さ。 |
|
セル
|
cells | array of ApiItemCell |
この列のすべてのセルのリスト。 カウントは常に列数と同じである必要があります。 |
ApiItemTable
項目のテーブル
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
pageIndex
|
pageIndex | integer |
テーブルが属しているページのインデックス。 |
|
offset
|
offset | Offset |
X 座標と Y 座標を使用して 2 次元のオフセットを定義します。 |
|
columns
|
columns | array of ApiItemColumn |
列の定義のリスト。 |
|
行
|
rows | array of ApiItemRow |
行定義と各行のセルのリスト。 |
ApiPage
ドキュメント ページ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
index
|
index | integer |
ドキュメントのページ インデックス。 1 からインデックス付けされます。 |
|
幅
|
width | integer |
ページ幅 (ピクセル)。 |
|
高さ
|
height | integer |
ページの高さ (ピクセル)。 |
|
回転
|
rotation | double |
ページの回転 (度)。 |
|
単語
|
words | array of ApiWord |
ページ上に存在するすべての単語のリスト。 |
|
itemTable
|
itemTable | ApiItemTable |
項目のテーブル |
ApiPluginResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
pluginName
|
pluginName | string |
このドキュメントを検証したスクリプトの名前を取得または設定します |
|
resultCode
|
resultCode | PostProcessResult |
後処理の結果 |
|
価値
|
value | string |
ローカライズされたメッセージのコレクションを取得または設定 |
|
extraInformationRequired
|
extraInformationRequired | boolean |
追加情報が必要かどうかを取得または設定 |
|
extraInformationMessage
|
extraInformationMessage | string |
追加情報要件メッセージを取得または設定 |
ApiUploadResponse
ファイル アップロードの結果
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
documentId
|
documentId | string |
Document Id |
|
folderId
|
folderId | string |
フォルダー ID |
ApiUser
ユーザー情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
ユーザーの ID |
|
firstName
|
firstName | string |
ユーザーの名 |
|
lastName
|
lastName | string |
ユーザーの姓 |
|
メールアドレス
|
string |
ユーザーのメール |
ApiUserApiListResult
検索結果
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
list
|
list | array of ApiUser |
見つかったすべての値のリスト |
|
hasMore
|
hasMore | boolean |
検索でより多くの値を返せる場合は True |
|
offset
|
offset | integer |
オフセット値 (スキップされる値の数) |
ApiWord
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
wordId
|
wordId | integer |
単語の ID、1 つのドキュメントごとに一意 |
|
pageIndex
|
pageIndex | integer |
単語が記載されているページのインデックス |
|
text
|
text | string |
単語のテキスト |
|
locX
|
locX | integer |
単語の X 座標 |
|
locY
|
locY | integer |
単語の Y 座標 |
|
幅
|
width | integer |
単語の幅 |
|
高さ
|
height | integer |
単語の高さ |
ApprovalState
DocumentSource
DocumentState
LicenseTimePeriod
MLicense
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
responseCode
|
responseCode | ResponseCode | |
|
responseMessage
|
responseMessage | string | |
|
validFrom
|
validFrom | date-time | |
|
validTo
|
validTo | date-time | |
|
nextPeriod
|
nextPeriod | date-time | |
|
usageLimit
|
usageLimit | integer | |
|
usageLimitPeriod
|
usageLimitPeriod | LicenseTimePeriod |
ライセンスの有効期間 |
|
試用版です
|
isTrial | boolean | |
|
usageCount
|
usageCount | integer |
ページ
X 座標と Y 座標を使用して 2 次元のオフセットを定義します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
x
|
x | double |
X 座標でのオフセット。 |
|
y
|
y | double |
Y 座標でのオフセット。 |
PostProcessResult
RedQueStatus
ステータス応答データ。 要求がデータを返さない場合の応答として使用されます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態Code
|
statusCode | integer |
状態コード |
|
message
|
message | string |
Message |
ResponseCode
StringApiValue
汎用応答の値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | string |
価値 |