InfoShare
InfoShare は、デジタルのドキュメント、情報、バインダー、プロセスの管理方法を最適化する方法を模索している企業向けに設計されています。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Kendox Support |
| [URL] | https://kendox.com/en/service/support-services |
| メール | support@kendox.com |
| Connector Metadata | |
|---|---|
| 発行者 | Kendox AG |
| Web サイト | https://www.kendox.com/en |
| プライバシー ポリシー | https://www.kendox.com/en/about-us/data-protection |
| カテゴリ | コラボレーション ; コンテンツとファイル |
Kendox InfoShare は、パワフルで非常に広範な REST API を提供します。 この API を使用すると、InfoShare 内でドキュメントとプロセスを作成および管理できます。 Kendox InfoShare Power Automate コネクタと一緒に使用すれば、幅広いアプリケーション環境でコンテンツ プロセスを合理化し、情報のサイロ化を防ぐことができます。 InfoShare コネクタは、ドキュメントとプロセスを管理するためのアクションを提供します。
前提条件
- このコネクタを使用するためのライセンスは、sales@kendox.com で利用できます。
- Kendox InfoShare は、オンラインでアクセス可能な WCF サービスのエンドポイントを備えています。
- Kendox InfoShare のログイン資格情報。
資格情報の入手方法
コネクタ API キーは、電子メール リクエストで sales@kendox.com を使用して購入できます。 WCF サービス エンドポイントは、Kendox (クラウド) またはそれぞれの InfoShare インスタンスを実装した Kendox パートナーから提供されます。
コネクターの使用方法は?
まず、コネクタへの接続を作成する必要があります。 接続には API キーが必要です。 sales@kendox.com から入手できます。 最初のアクションはいつもログオンまたは LogonWithHashedPasswort アクションです。 これらのアクションは、その後のすべてのアクションに必要な接続 ID を返します。 接続 ID が 10 分以上使用されない場合、接続 ID は期限切れになり、Logon または LogonWithHashedPasswort アクションを使用して再ログオンする必要があります。
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| API キー | securestring | この API の API キー | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| オープン状態のプロセスをクローズします |
オープン状態のプロセスをクローズします |
| タスクを閉じてプロセスを続行する |
タスクを閉じてプロセスを続行する |
| ドキュメント プロパティを取得する |
ドキュメント プロパティを取得する |
| ドキュメントの作成 |
ドキュメントの作成 |
| ドキュメントの取得する |
ドキュメントの取得します |
| ドキュメントの検索 |
ドキュメントの検索 |
| ドキュメントを更新する |
ドキュメントを更新します |
| ハッシュされたパスワードを使用してログオンする |
ハッシュされたパスワードを使用してログオンする |
| ファイル コンテンツの取得 |
ファイル コンテンツの取得 |
| ファイル コンテンツを変換する |
ファイル コンテンツを別の形式に変換します。 ファイル コンテンツに注釈またはオーバーレイを追加します |
| プロセス プロパティを取得する |
プロセス プロパティを取得する |
| プロセスの一覧 |
プロセスの一覧 |
| プロセスの作成 |
プロセスの作成 |
| プロセスを取得する |
プロセスを取得します |
| ユーザー テーブルから行を取得する |
ユーザー テーブルから行を取得する |
| ユーザー テーブルの行を削除する |
ユーザー テーブルの行を削除する |
| ユーザー テーブルを作成する |
ユーザー テーブルを作成する |
| ログオフ |
ログオフ |
| ログオン |
ログオン |
| 更新プロセス |
更新プロセス |
| 現在のタスクを閉じて、ユーザーを次のタスクに割り当てる |
現在のタスクを閉じて、ユーザーを次のタスクに割り当てる |
| 行をユーザー テーブルに挿入する |
テーブルの行をユーザー テーブルにインポートします |
オープン状態のプロセスをクローズします
オープン状態のプロセスをクローズします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
接続を識別するための接続 ID |
|
ProcessId
|
processId | True | string |
プロセスの ID (Guid) |
|
コメント
|
comment | string |
追加するコメント |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
AccessRightsEnumList
|
CloseProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
CloseProcessResult.CheckOutStateEnum | string |
ドキュメントのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null) |
|
CheckOutUserId
|
CloseProcessResult.CheckOutUserId | string |
プロセスがチェックアウトされているユーザーの ID |
|
コメント
|
CloseProcessResult.Comments | array of object |
コメント |
|
日
|
CloseProcessResult.Comments.Date | string |
コメントの日付 |
|
ID
|
CloseProcessResult.Comments.Id | string |
コメントの ID |
|
テキスト
|
CloseProcessResult.Comments.Text | string |
ユーザーの定義のコメント |
|
UserId
|
CloseProcessResult.Comments.UserId | string |
ユーザー ID |
|
CompletedDate
|
CloseProcessResult.CompletedDate | string |
プロセスの完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CompletedTasks
|
CloseProcessResult.CompletedTasks | array of object |
CompletedTasks |
|
操作
|
CloseProcessResult.CompletedTasks.Action | string |
ユーザーへのアクション テキスト |
|
AssignedUserIds
|
CloseProcessResult.CompletedTasks.AssignedUserIds | array of |
AssignedUserIds |
|
コメント
|
CloseProcessResult.CompletedTasks.Comments | array of object |
コメント |
|
日
|
CloseProcessResult.CompletedTasks.Comments.Date | string |
コメントの日付 |
|
ID
|
CloseProcessResult.CompletedTasks.Comments.Id | string |
コメントの ID |
|
テキスト
|
CloseProcessResult.CompletedTasks.Comments.Text | string |
ユーザーの定義のコメント |
|
UserId
|
CloseProcessResult.CompletedTasks.Comments.UserId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
CloseProcessResult.CompletedTasks.CompletedDate | string |
完了済みタスクの完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CompletedTasks.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CompletedTasks.CreatedDate | string |
完了済みタスクの作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CompletedTasks.CreatorId | string |
完了済みタスクの作成者のユーザー ID |
|
内容
|
CloseProcessResult.CompletedTasks.Description | string |
完了済みタスクのタスク説明 |
|
DueDate
|
CloseProcessResult.CompletedTasks.DueDate | string |
タスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
ID
|
CloseProcessResult.CompletedTasks.Id | string |
タスクの ID |
|
IntendedUserIds
|
CloseProcessResult.CompletedTasks.IntendedUserIds | array of |
IntendedUserIds |
|
ReminderDate
|
CloseProcessResult.CompletedTasks.ReminderDate | string |
完了済みタスクのアラームの日付。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
CloseProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
StatusEnum
|
CloseProcessResult.CompletedTasks.StatusEnum | string |
タスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
CloseProcessResult.CompletedTasks.TaskTemplateId | string |
タスク テンプレート ID |
|
CreatedDate
|
CloseProcessResult.CreatedDate | string |
プロセスの作成日。日付の形式: yyyy-MM-ddTHH:mm:ss |
|
操作
|
CloseProcessResult.CurrentTask.Action | string |
ユーザーへのアクション テキスト |
|
AssignedUserIds
|
CloseProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
コメント
|
CloseProcessResult.CurrentTask.Comments | array of object |
コメント |
|
日
|
CloseProcessResult.CurrentTask.Comments.Date | string |
コメントの日付 |
|
ID
|
CloseProcessResult.CurrentTask.Comments.Id | string |
コメントの ID |
|
テキスト
|
CloseProcessResult.CurrentTask.Comments.Text | string |
ユーザーの定義のコメント |
|
UserId
|
CloseProcessResult.CurrentTask.Comments.UserId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
CloseProcessResult.CurrentTask.CompletedDate | string |
現在のタスクの完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CurrentTask.CreatedDate | string |
現在のタスクの作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CurrentTask.CreatorId | string |
現在のタスクの作成者のユーザー ID |
|
内容
|
CloseProcessResult.CurrentTask.Description | string |
現在のタスクのタスク説明 |
|
DueDate
|
CloseProcessResult.CurrentTask.DueDate | string |
現在のタスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
ID
|
CloseProcessResult.CurrentTask.Id | string |
現在のタスクの ID |
|
IntendedUserIds
|
CloseProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
ReminderDate
|
CloseProcessResult.CurrentTask.ReminderDate | string |
現在のタスクのアラームの日付。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
CloseProcessResult.CurrentTask.RequiresAllRecipients | boolean |
すべての受信者が現在のタスクをクローズする必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
CloseProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
現在のタスクでタスクのクローズ ダイアログを表示します |
|
StatusEnum
|
CloseProcessResult.CurrentTask.StatusEnum | string |
現在のタスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
CloseProcessResult.CurrentTask.TaskTemplateId | string |
現在のタスクのタスク テンプレート ID |
|
CustomProperties
|
CloseProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
現在のプロパティのカスタム プロパティ型の列挙値 (文字列、日付、数値) |
|
件名
|
CloseProcessResult.CustomProperties.Name | string |
カスタム プロパティの名前 |
|
値
|
CloseProcessResult.CustomProperties.Value | string |
カスタム プロパティの値 |
|
DocumentIds
|
CloseProcessResult.DocumentIds | array of string |
DocumentIds |
|
DueDate
|
CloseProcessResult.DueDate | string |
プロセスの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
ID
|
CloseProcessResult.Id | string |
プロセスの ID |
|
値
|
CloseProcessResult.Name.Values | array of object |
値 |
|
カルチャ
|
CloseProcessResult.Name.Values.Culture | string |
テキストが指定されるカルチャ (de、en、fr、...) |
|
テキスト
|
CloseProcessResult.Name.Values.Text | string |
プロセスの名前 |
|
PluginStream
|
CloseProcessResult.PluginStream | array of string |
PluginStream |
|
PriorityEnum
|
CloseProcessResult.PriorityEnum | string |
プロセスの優先度 (High、Normal、Low) |
|
ProcessTemplateId
|
CloseProcessResult.ProcessTemplateId | string |
プロセスのテンプレート ID |
|
プロパティ
|
CloseProcessResult.Properties | array of object |
プロパティ |
|
GlobalValues
|
CloseProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
値
|
CloseProcessResult.Properties.GlobalValues.Values | array of object |
値 |
|
カルチャ
|
CloseProcessResult.Properties.GlobalValues.Values.Culture | string |
カルチャ |
|
テキスト
|
CloseProcessResult.Properties.GlobalValues.Values.Text | string |
テキスト |
|
PropertyTypeId
|
CloseProcessResult.Properties.PropertyTypeId | string |
インデックス フィールドの種類 ID |
|
値
|
CloseProcessResult.Properties.Values | array of string |
値 |
|
ProtectionDomainId
|
CloseProcessResult.ProtectionDomainId | string |
プロセスの保護ドメイン ID |
|
SessionCount
|
CloseProcessResult.SessionCount | integer |
セッション数 |
|
StatusEnum
|
CloseProcessResult.StatusEnum | string |
プロセスの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
タスクを閉じてプロセスを続行する
タスクを閉じてプロセスを続行する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
接続を識別するための接続 ID |
|
ProcessId
|
processId | True | string |
プロセスの ID (Guid) |
|
コメント
|
comment | string |
追加するコメント |
|
|
TaskId
|
taskId | string |
タスク ID |
|
|
AssignUsers
|
assignUsers | True | boolean |
ユーザーに割り当てます。 no に設定した場合は、"プロセスを更新する" アクションを使用してユーザーを割り当てます |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
操作
|
action | string |
ユーザー用のアクションテキスト。 エンドユーザーに表示 |
|
AssignedUserIds
|
assignedUserIds | string |
割り当て済みユーザー ID の一覧 |
|
comments
|
comments | array of object |
comments |
|
日
|
comments.date | string |
コメントの日付 |
|
ID
|
comments.id | string |
コメントの ID |
|
テキスト
|
comments.text | string |
ユーザーの定義のコメント |
|
UserId
|
comments.userId | string |
ユーザー ID |
|
CompletedDate
|
completedDate | string |
完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
completedUserIds | string |
完了済みユーザー ID の一覧 |
|
CreatedDate
|
createdDate | string |
作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
作成者のユーザー ID |
|
内容
|
description | string |
タスクの説明 |
|
DueDate
|
dueDate | string |
タスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
IntendedUserIds
|
intendedUserIds | string |
このタスクの対象ユーザー |
|
ReminderDate
|
reminderDate | string |
アラームの日時。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
requiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
ステータス
|
statusEnum | string |
タスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
taskTemplateId | string |
タスク テンプレート ID |
ドキュメント プロパティを取得する
ドキュメント プロパティを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
DocumentId
|
DocumentId | True | string |
ドキュメント ID |
|
カルチャ
|
Culture | string |
プロパティ名が指定されるカルチャ (de、en、fr、...)。既定値 = de |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
globalValues
|
globalValues | array of object |
globalValues |
|
値
|
globalValues.values | array of object |
値 |
|
culture
|
globalValues.values.culture | string |
カルチャ |
|
テキスト
|
globalValues.values.text | string |
テキスト |
|
PropertyName
|
propertyName | string |
プロパティ名前 |
|
PropertyTypeId
|
propertyTypeId | string |
インデックス フィールドの種類 ID |
|
値
|
values | array of string |
値 |
ドキュメントの作成
ドキュメントの作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
DocumentTitle
|
DocumentTitle | True | string |
ドキュメントのタイトル (拡張子を含む) |
|
ImportTemplate
|
ImportTemplate | True | string |
テンプレートのインポート |
|
DocumentProperties
|
DocumentProperties | string |
ドキュメント プロパティの挿入形式: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713 |
|
|
カルチャ
|
Culture | string |
プロパティ名が指定されるカルチャ (de、en、fr、...)。既定値 = de |
|
|
FileContent
|
FileContent | True | string |
ファイル コンテンツの Base64 文字列 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
購読
|
abonnements | array of string |
購読 |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
付箋の注釈から取得された作成日 |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
付箋の注釈から取得された作成者のユーザー ID |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
付箋の注釈から取得されたイタリックのフォント指定 |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
付箋の注釈から取得された 取り消し線 のフォント指定 |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
付箋の注釈から取得された下線のフォント指定 |
|
件名
|
annotationManager.postItAnnotations.fontInfo.name | string |
付箋の注釈から取得されたフォント名。 既定値 = Arial |
|
ピッチ
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
付箋の注釈から取得されたフォントのピッチ |
|
サイズ
|
annotationManager.postItAnnotations.fontInfo.size | integer |
付箋の注釈から取得されたフォント サイズ。 例: サイズ: 12 は 12000です。 係数 1000 が必要です |
|
太さ
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
付箋の注釈から取得されたフォントの太さ |
|
ID
|
annotationManager.postItAnnotations.id | string |
付箋の注釈の ID |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
付箋の注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
付箋の注釈から取得されたページ数 |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
付箋の注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
annotationManager.postItAnnotations.selectable | boolean |
付箋の注釈をユーザーが選択できるかどうかを定義します |
|
テキスト
|
annotationManager.postItAnnotations.text | string |
付箋の注釈のユーザー定義テキスト |
|
X
|
annotationManager.postItAnnotations.x | integer |
付箋の注釈の X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
annotationManager.postItAnnotations.y | integer |
付箋の注釈の Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectangleAnnotations |
|
色
|
annotationManager.rectangleAnnotations.color | integer |
四角形の注釈から取得された四角形の色 (32 ビットの ARGB 値)。例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
四角形の注釈から取得された四角形の色 (RGB の 16 進コード)。 例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
四角形の注釈から取得された作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
高さ
|
annotationManager.rectangleAnnotations.height | integer |
四角形の高さ (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ID
|
annotationManager.rectangleAnnotations.Id | string |
四角形の注釈の ID |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
四角形の注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
四角形の注釈から取得されたページ数 |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
四角形の注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
annotationManager.rectangleAnnotations.selectable | boolean |
長方形注釈がユーザーによって選択できるかどうかを定義します |
|
透明
|
annotationManager.rectangleAnnotations.transparent | boolean |
四角形が透明になります (ハイライト) |
|
幅
|
annotationManager.rectangleAnnotations.width | integer |
四角形の幅 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
四角形の注釈から取得された X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
annotationManager.rectangleAnnotations.y | integer |
四角形の注釈から取得された Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
テキストの注釈から取得された背景の色 (32 ビットの ARGB 値)。例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
テキストの注釈から取得された背景の色 (RGB の 16 進コード)。例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
テキストの注釈から取得された作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
テキストの注釈から取得された作成者のユーザー ID |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
テキストの注釈から取得されたイタリックのフォント指定 |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
テキストの注釈から取得された取り消し線のフォント指定 |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
テキストの注釈から取得された下線のフォント指定 |
|
件名
|
annotationManager.textAnnotations.fontInfo.name | string |
テキストの注釈から取得されたフォント名。 既定値 = Arial |
|
ピッチ
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
テキストの注釈から取得されたフォントのピッチ |
|
サイズ
|
annotationManager.textAnnotations.fontInfo.size | integer |
テキストの注釈から取得されたフォント サイズ。 例: サイズ: 12 は 12000です。 係数 1000 が必要です |
|
太さ
|
annotationManager.textAnnotations.fontInfo.weight | integer |
テキストの注釈から取得されたフォントの太さ |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
テキストの注釈から取得された前景の色 (32 ビットの ARGB 値)。 例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
テキストの注釈から取得された前景の色 (RGB の 16 進コード)。 例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
高さ
|
annotationManager.textAnnotations.height | integer |
テキストの注釈から取得されたテキストの高さ (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ID
|
annotationManager.textAnnotations.id | string |
テキスト注釈の ID |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
テキストの注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
テキストの注釈から取得されたページ数 |
|
回転
|
annotationManager.textAnnotations.rotation | integer |
テキストの注釈から取得された回転の角度 |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
テキストの注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
annotationManager.textAnnotations.selectable | boolean |
テキスト注釈がユーザーによって選択できるかどうかを定義します |
|
テキスト
|
annotationManager.textAnnotations.text | string |
テキストの注釈のユーザー定義テキスト |
|
透明
|
annotationManager.textAnnotations.transparent | boolean |
テキストの注釈が透明になります |
|
幅
|
annotationManager.textAnnotations.width | integer |
テキストの注釈から取得されたテキストの幅 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
X
|
annotationManager.textAnnotations.x | integer |
テキストの注釈から取得された X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
annotationManager.textAnnotations.y | integer |
テキストの注釈から取得された Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ブログ
|
blogs | array of object |
ブログ |
|
ブログ
|
blogs | object |
すべてのブログ項目の一覧 |
|
CheckOutState
|
checkOutStateEnum | string |
ドキュメントのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null) |
|
CheckOutUserId
|
checkOutUserId | string |
ドキュメントがチェックアウトされているユーザーの ID |
|
documentData
|
documentData | array of object |
documentData |
|
ID
|
documentData.id | string |
ドキュメント レンディションの ID |
|
件名
|
documentData.name | string |
レンディションのドキュメント名 |
|
レンディション
|
documentData.renditions | array of object |
レンディション |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
contentProtections |
|
拡張子
|
documentData.renditions.extension | string |
レンディションの拡張子 |
|
ファイル
|
documentData.renditions.files | array of object |
ファイル |
|
blobPath
|
documentData.renditions.files.blobPath | string |
レンディションの BLOB パス |
|
blobStoreId
|
documentData.renditions.files.blobStoreId | string |
レンディションの BLOB ストア ID |
|
ID
|
documentData.renditions.id | string |
ID |
|
pageCount
|
documentData.renditions.pageCount | string |
レンディションのページ数 |
|
サイズ
|
documentData.renditions.size | string |
レンディションのサイズ |
|
HasOverlay
|
hasOverlay | boolean |
ドキュメントをオーバーレイを使って表示するかどうかを定義します |
|
ID
|
id | string |
ドキュメントの ID |
|
ImportTemplateId
|
importTemplateId | string |
このドキュメントのインポート テンプレートの ID |
|
InfoStoreId
|
infoStoreId | string |
情報ストアの ID |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
チェックアウト ライフ サイクル状態 |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
ライフ サイクルの計算済み終了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
ライフ サイクルの開始日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
ライフサイクル状態の ID |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
次の自動ライフ サイクル状態 |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
保護の有効期限後にドキュメントを削除することを許可します |
|
ID
|
lifeCycleManager.lifeCycleProtections.id | string |
ライフ サイクル状態保護の ID |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
注釈が変更されないよう保護します |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
チェックアウトされないよう保護します |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
コンテンツが変更されないよう保護します |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
削除されないよう保護します |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
プロパティが変更されないよう保護します |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
セキュリティが変更されないよう保護します |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
保護の期間 |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
ライフサイクルの ID |
|
MainFileLength
|
mainFileLength | integer |
メイン ファイル サイズ |
|
件名
|
name | string |
ドキュメントの名前 |
|
PageCount
|
pageCount | integer |
メイン ファイルのページ数 |
|
プロパティ
|
properties | array of object |
プロパティ |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
値
|
properties.globalValues.values | array of object |
値 |
|
culture
|
properties.globalValues.values.culture | string |
カルチャ |
|
テキスト
|
properties.globalValues.values.text | string |
テキスト |
|
PropertyTypeId
|
properties.propertyTypeId | string |
インデックス フィールドの種類 ID |
|
値
|
properties.values | array of string |
値 |
|
ProtectionDomainId
|
protectionDomainId | string |
保護ドメインの ID |
|
件のアラーム
|
reminders | array of object |
件のアラーム |
|
アラーム
|
reminders | object |
すべてのアラームの一覧 |
|
SessionCount
|
sessionCount | integer |
セッション数 |
|
SigningProfileId
|
signingProfileId | string |
署名プロファイルの ID |
|
VersionId
|
versionId | string |
ドキュメントのバージョン ID |
ドキュメントの取得する
ドキュメントの取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
接続を識別するための接続 ID |
|
DocumentId
|
documentId | True | string |
ドキュメント ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
購読
|
GetDocumentResult.Abonnements | array of object |
購読 |
|
OnContentChange
|
GetDocumentResult.Abonnements.OnContentChange | boolean |
ファイルの変更に対する購読がアクティブです |
|
OnDelete
|
GetDocumentResult.Abonnements.OnDelete | boolean |
削除に対する購読がアクティブです |
|
OnMetadataChange
|
GetDocumentResult.Abonnements.OnMetadataChange | boolean |
インデックスの変更に対する購読がアクティブです |
|
UserId
|
GetDocumentResult.Abonnements.UserId | string |
この購読のユーザー ID |
|
AccessRightsEnumList
|
GetDocumentResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
PostItAnnotations
|
GetDocumentResult.AnnotationManager.PostItAnnotations | array of object |
PostItAnnotations |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate | string |
付箋の注釈から取得された作成日 |
|
CreatorId
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId | string |
付箋の注釈から取得された作成者のユーザー ID |
|
IsItalic
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic | boolean |
付箋の注釈から取得されたイタリックのフォント指定 |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut | boolean |
付箋の注釈から取得された 取り消し線 のフォント指定 |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline | boolean |
付箋の注釈から取得された下線のフォント指定 |
|
件名
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name | string |
付箋の注釈から取得されたフォント名。 既定値 = Arial |
|
ピッチ
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch | integer |
付箋の注釈から取得されたフォントのピッチ |
|
サイズ
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size | integer |
付箋の注釈から取得されたフォント サイズ。 例: サイズ: 12 は 12000です。 係数 1000 が必要です |
|
太さ
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight | integer |
付箋の注釈から取得されたフォントの太さ |
|
ID
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Id | string |
付箋の注釈の ID |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate | string |
付箋の注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber | integer |
付箋の注釈から取得されたページ数 |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum | string |
付箋の注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable | boolean |
付箋の注釈をユーザーが選択できるかどうかを定義します |
|
テキスト
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Text | string |
付箋の注釈のユーザー定義テキスト |
|
X
|
GetDocumentResult.AnnotationManager.PostItAnnotations.X | integer |
付箋の注釈の X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Y | integer |
付箋の注釈の Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
RectangleAnnotations
|
GetDocumentResult.AnnotationManager.RectangleAnnotations | array of object |
RectangleAnnotations |
|
色
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color | integer |
四角形の注釈から取得された四角形の色 (32 ビットの ARGB 値)。 例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
ColorHexCode
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode | string |
四角形の注釈から取得された四角形の色 (RGB の 16 進コード)。 例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate | string |
四角形の注釈から取得された作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId | string |
CreatorId |
|
高さ
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height | integer |
四角形の高さ (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ID
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id | string |
四角形の注釈の ID |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate | string |
四角形の注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber | integer |
四角形の注釈から取得されたページ数 |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum | string |
四角形の注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable | boolean |
長方形注釈がユーザーによって選択できるかどうかを定義します |
|
透明
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent | boolean |
四角形が透明になります (ハイライト) |
|
幅
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width | integer |
四角形の幅 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
X
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.X | integer |
四角形の注釈から取得された X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Y | integer |
四角形の注釈から取得された Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
TextAnnotations
|
GetDocumentResult.AnnotationManager.TextAnnotations | array of object |
TextAnnotations |
|
BackgroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor | integer |
テキストの注釈から取得された背景の色 (32 ビットの ARGB 値)。 例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
BackgroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode | string |
テキストの注釈から取得された背景の色 (RGB の 16 進コード)。 例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate | string |
テキストの注釈から取得された作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId | string |
テキストの注釈から取得された作成者のユーザー ID |
|
IsItalic
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic | boolean |
テキストの注釈から取得されたイタリックのフォント指定 |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut | boolean |
テキストの注釈から取得された取り消し線のフォント指定 |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline | boolean |
テキストの注釈から取得された下線のフォント指定 |
|
件名
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name | string |
テキストの注釈から取得されたフォント名。 既定値 = Arial |
|
ピッチ
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch | integer |
テキストの注釈から取得されたフォントのピッチ |
|
サイズ
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size | integer |
テキストの注釈から取得されたフォント サイズ。 例: サイズ: 12 は 12000です。 係数 1000 が必要です |
|
太さ
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight | integer |
テキストの注釈から取得されたフォントの太さ |
|
ForegroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor | integer |
テキストの注釈から取得された前景の色 (32 ビットの ARGB 値)。 例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
ForegroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode | string |
テキストの注釈から取得された前景の色 (RGB の 16 進コード)。 例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
高さ
|
GetDocumentResult.AnnotationManager.TextAnnotations.Height | integer |
テキストの注釈から取得されたテキストの高さ (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ID
|
GetDocumentResult.AnnotationManager.TextAnnotations.Id | string |
テキスト注釈の ID |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate | string |
テキストの注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber | integer |
テキストの注釈から取得されたページ数 |
|
回転
|
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation | integer |
テキストの注釈から取得された回転の角度 |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum | string |
テキストの注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable | boolean |
テキスト注釈がユーザーによって選択できるかどうかを定義します |
|
テキスト
|
GetDocumentResult.AnnotationManager.TextAnnotations.Text | string |
テキストの注釈のユーザー定義テキスト |
|
透明
|
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent | boolean |
テキストの注釈が透明になります |
|
幅
|
GetDocumentResult.AnnotationManager.TextAnnotations.Width | integer |
テキストの注釈から取得されたテキストの幅 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
X
|
GetDocumentResult.AnnotationManager.TextAnnotations.X | integer |
テキストの注釈から取得された X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
GetDocumentResult.AnnotationManager.TextAnnotations.Y | integer |
テキストの注釈から取得された Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ブログ
|
GetDocumentResult.Blogs | array of object |
ブログ |
|
CreatedDate
|
GetDocumentResult.Blogs.CreatedDate | string |
ブログが作成された日付。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.Blogs.CreatorId | string |
ブログを作成しているユーザーのユーザー ID |
|
ID
|
GetDocumentResult.Blogs.Id | string |
ブログの ID |
|
テキスト
|
GetDocumentResult.Blogs.Text | string |
ブログ項目のテキスト |
|
CheckOutStateEnum
|
GetDocumentResult.CheckOutStateEnum | string |
ドキュメントのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null) |
|
CheckOutUserId
|
GetDocumentResult.CheckOutUserId | string |
ドキュメントがチェックアウトされているユーザーの ID |
|
DocumentData
|
GetDocumentResult.DocumentData | array of object |
DocumentData |
|
ID
|
GetDocumentResult.DocumentData.Id | string |
ドキュメント レンディションの ID |
|
件名
|
GetDocumentResult.DocumentData.Name | string |
レンディションのドキュメント名 |
|
レンディション
|
GetDocumentResult.DocumentData.Renditions | array of object |
レンディション |
|
ContentProtections
|
GetDocumentResult.DocumentData.Renditions.ContentProtections | array of |
ContentProtections |
|
拡張
|
GetDocumentResult.DocumentData.Renditions.Extension | string |
拡張 |
|
ファイル
|
GetDocumentResult.DocumentData.Renditions.Files | array of object |
ファイル |
|
BlobPath
|
GetDocumentResult.DocumentData.Renditions.Files.BlobPath | string |
BlobPath |
|
BlobStoreId
|
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId | string |
BlobStoreId |
|
HashValue
|
GetDocumentResult.DocumentData.Renditions.HashValue | array of integer |
HashValue |
|
ID
|
GetDocumentResult.DocumentData.Renditions.Id | string |
ID |
|
PageCount
|
GetDocumentResult.DocumentData.Renditions.PageCount | integer |
PageCount |
|
サイズ
|
GetDocumentResult.DocumentData.Renditions.Size | integer |
サイズ |
|
HasOverlay
|
GetDocumentResult.HasOverlay | boolean |
ドキュメントをオーバーレイを使って表示するかどうかを定義します |
|
ID
|
GetDocumentResult.Id | string |
ドキュメントの ID |
|
ImportTemplateId
|
GetDocumentResult.ImportTemplateId | string |
このドキュメントのインポート テンプレートの ID |
|
InfoStoreId
|
GetDocumentResult.InfoStoreId | string |
情報ストアの ID |
|
CheckOutLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId | string |
チェックアウト ライフ サイクル状態 |
|
LifeCycleEndDate
|
GetDocumentResult.LifeCycleManager.LifeCycleEndDate | string |
ライフ サイクルの計算済み終了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
GetDocumentResult.LifeCycleManager.LifeCycleStartDate | string |
ライフ サイクルの開始日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
GetDocumentResult.LifeCycleManager.LifeCycleStateId | string |
ライフサイクル状態の ID |
|
NextAutomaticLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId | string |
次の自動ライフ サイクル状態 |
|
NextLifeCycleStates
|
GetDocumentResult.LifeCycleManager.NextLifeCycleStates | array of string |
NextLifeCycleStates |
|
LifeCycleProtections
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections | array of object |
LifeCycleProtections |
|
DeleteAfterExpiration
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration | boolean |
保護の有効期限後にドキュメントを削除することを許可します |
|
ID
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id | string |
ライフ サイクル状態保護の ID |
|
ProtectAnnotationChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange | boolean |
注釈が変更されないよう保護します |
|
ProtectCheckOut
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut | boolean |
チェックアウトされないよう保護します |
|
ProtectContentChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange | boolean |
コンテンツが変更されないよう保護します |
|
ProtectDelete
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete | boolean |
削除されないよう保護します |
|
ProtectPropertyChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange | boolean |
プロパティが変更されないよう保護します |
|
ProtectProtectionDomainChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange | boolean |
セキュリティが変更されないよう保護します |
|
ProtectionDurationTicks
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks | integer |
保護の期間 |
|
LifeCycleId
|
GetDocumentResult.LifeCycleManager.LifeCycleId | string |
ライフサイクルの ID |
|
MainFileLength
|
GetDocumentResult.MainFileLength | integer |
メイン ファイル サイズ |
|
件名
|
GetDocumentResult.Name | string |
ドキュメントの名前 |
|
PageCount
|
GetDocumentResult.PageCount | integer |
メイン ファイルのページ数 |
|
プロパティ
|
GetDocumentResult.Properties | array of object |
プロパティ |
|
GlobalValues
|
GetDocumentResult.Properties.GlobalValues | array of object |
GlobalValues |
|
値
|
GetDocumentResult.Properties.GlobalValues.Values | array of object |
値 |
|
カルチャ
|
GetDocumentResult.Properties.GlobalValues.Values.Culture | string |
カルチャ |
|
テキスト
|
GetDocumentResult.Properties.GlobalValues.Values.Text | string |
テキスト |
|
PropertyTypeId
|
GetDocumentResult.Properties.PropertyTypeId | string |
インデックス フィールドの種類 ID |
|
値
|
GetDocumentResult.Properties.Values | array of string |
値 |
|
ProtectionDomainId
|
GetDocumentResult.ProtectionDomainId | string |
保護ドメインの ID |
|
アラーム
|
GetDocumentResult.Reminders | array of object |
アラーム |
|
内容
|
GetDocumentResult.Reminders.Description | string |
アラームの説明 |
|
間隔
|
GetDocumentResult.Reminders.Interval | integer |
アラームの間隔 (日数) |
|
ProcessTemplateId
|
GetDocumentResult.Reminders.ProcessTemplateId | string |
このアラームのプロセス テンプレート ID |
|
ReminderDate
|
GetDocumentResult.Reminders.ReminderDate | string |
アラームの日付。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
ReminderId
|
GetDocumentResult.Reminders.ReminderId | string |
アラームの ID |
|
SubjectIds
|
GetDocumentResult.Reminders.SubjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
GetDocumentResult.Reminders.UseUserFromProcessTemplate | boolean |
プロセス テンプレートからのユーザー定義が使用されるかどうかを定義します |
|
SessionCount
|
GetDocumentResult.SessionCount | integer |
セッション数 |
|
SigningProfileId
|
GetDocumentResult.SigningProfileId | string |
署名プロファイルの ID |
|
VersionId
|
GetDocumentResult.VersionId | string |
ドキュメントのバージョン ID |
ドキュメントの検索
ドキュメントの検索
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
条件
|
Conditions | string |
検索条件の形式: [|||]。 ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". 例: [Last check in|Less|2021-12-31|And],[Firstname|Equals|Peter|And] |
|
|
カルチャ
|
Culture | string |
カルチャ (de、en、fr、...)。既定値 = de |
|
|
FulltextWords
|
FulltextWords | string |
フルテキストで検索する語句 |
|
|
FulltextWordRelation
|
FulltextWordRelation | string |
フルテキストの語句の関係 (AND、OR)。 既定値 = AND |
|
|
MaxSerchResults
|
MaxSerchResults | string |
ドキュメント検索結果の最大数。 既定値 = 100 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント
|
documents | array of object |
ドキュメント |
|
購読
|
documents.abonnements | string |
購読の一覧 |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
accessRightsEnumList |
|
AnnotationManager
|
documents.annotationManager | string |
メイン ドキュメント ファイルの注釈 |
|
ブログ
|
documents.blogs | string |
すべてのブログ項目の一覧 |
|
CheckOutState
|
documents.checkOutStateEnum | string |
ドキュメントのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null) |
|
CheckOutUserId
|
documents.checkOutUserId | string |
ドキュメントがチェックアウトされているユーザーの ID |
|
DocumentData
|
documents.documentData | string |
ドキュメント データの一覧 |
|
HasOverlay
|
documents.hasOverlay | boolean |
ドキュメントをオーバーレイを使って表示するかどうかを定義します |
|
ID
|
documents.id | string |
ドキュメントの ID |
|
ImportTemplateId
|
documents.importTemplateId | string |
このドキュメントのインポート テンプレートの ID |
|
InfoStoreId
|
documents.infoStoreId | string |
情報ストアの ID |
|
LifeCycleManager
|
documents.lifeCycleManager | string |
ライフ サイクルの情報 |
|
MainFileLength
|
documents.mainFileLength | integer |
メイン ファイル サイズ |
|
件名
|
documents.name | string |
ドキュメントの名前 |
|
PageCount
|
documents.pageCount | integer |
メイン ファイルのページ数 |
|
プロパティ
|
documents.properties | array of |
プロパティ |
|
ProtectionDomainId
|
documents.protectionDomainId | string |
保護ドメインの ID |
|
アラーム
|
documents.reminders | string |
すべてのアラームの一覧 |
|
SessionCount
|
documents.sessionCount | integer |
セッション数 |
|
SigningProfileId
|
documents.signingProfileId | string |
署名プロファイルの ID |
|
VersionId
|
documents.versionId | string |
ドキュメントのバージョン ID |
|
HasMore
|
hasMore | boolean |
結果がさらに存在するかどうかを示します。 結果をさらに取得できる場合は、フラグが true に設定されます |
|
ResumePoint
|
resumePoint | string |
前の検索操作からの再開ポイントです。 最初の検索操作の場合は null に設定されます |
ドキュメントを更新する
ドキュメントを更新します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
DocumentId
|
DocumentId | True | string |
ドキュメント ID |
|
DocumentTitle
|
DocumentTitle | string |
ドキュメントのタイトル |
|
|
DocumentProperties
|
DocumentProperties | string |
ドキュメント プロパティの更新形式: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713 |
|
|
カルチャ
|
Culture | string |
テキストが指定されるカルチャ (de、en、fr、...)。既定値 = de |
|
|
FileContent
|
FileContent | string |
ファイル コンテンツの Base64 文字列 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
購読
|
abonnements | array of object |
購読 |
|
OnContentChange
|
abonnements.onContentChange | boolean |
ファイルの変更に対する購読がアクティブです |
|
OnDelete
|
abonnements.onDelete | boolean |
削除に対する購読がアクティブです |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
インデックスの変更に対する購読がアクティブです |
|
UserId
|
abonnements.userId | string |
この購読のユーザー ID |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
付箋の注釈から取得された作成日 |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
付箋の注釈から取得された作成者のユーザー ID |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
付箋の注釈から取得されたイタリックのフォント指定 |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
付箋の注釈から取得された 取り消し線 のフォント指定 |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
付箋の注釈から取得された下線のフォント指定 |
|
件名
|
annotationManager.postItAnnotations.fontInfo.name | string |
付箋の注釈から取得されたフォント名。 既定値 = Arial |
|
ピッチ
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
付箋の注釈から取得されたフォントのピッチ |
|
サイズ
|
annotationManager.postItAnnotations.fontInfo.size | integer |
付箋の注釈から取得されたフォント サイズ。 例: サイズ: 12 は 12000です。 係数 1000 が必要です |
|
太さ
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
付箋の注釈から取得されたフォントの太さ |
|
ID
|
annotationManager.postItAnnotations.id | string |
付箋の注釈の ID |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
付箋の注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
付箋の注釈から取得されたページ数 |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
付箋の注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
annotationManager.postItAnnotations.selectable | boolean |
付箋の注釈をユーザーが選択できるかどうかを定義します |
|
テキスト
|
annotationManager.postItAnnotations.text | string |
付箋の注釈のユーザー定義テキスト |
|
X
|
annotationManager.postItAnnotations.x | integer |
付箋の注釈の X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
annotationManager.postItAnnotations.y | integer |
付箋の注釈の Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectangleAnnotations |
|
色
|
annotationManager.rectangleAnnotations.color | integer |
四角形の注釈から取得された四角形の色 (32 ビットの ARGB 値)。例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
四角形の注釈から取得された四角形の色 (RGB の 16 進コード)。 例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
四角形の注釈から取得された作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
高さ
|
annotationManager.rectangleAnnotations.height | integer |
四角形の高さ (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ID
|
annotationManager.rectangleAnnotations.Id | string |
四角形の注釈の ID |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
四角形の注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
四角形の注釈から取得されたページ数 |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
四角形の注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
annotationManager.rectangleAnnotations.selectable | boolean |
長方形注釈がユーザーによって選択できるかどうかを定義します |
|
透明
|
annotationManager.rectangleAnnotations.transparent | boolean |
四角形が透明になります (ハイライト) |
|
幅
|
annotationManager.rectangleAnnotations.width | integer |
四角形の幅 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
四角形の注釈から取得された X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
annotationManager.rectangleAnnotations.y | integer |
四角形の注釈から取得された Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
テキストの注釈から取得された背景の色 (32 ビットの ARGB 値)。 例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
テキストの注釈から取得された背景の色 (RGB の 16 進コード)。 例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
テキストの注釈から取得された作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
テキストの注釈から取得された作成者のユーザー ID |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
テキストの注釈から取得されたイタリックのフォント指定 |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
テキストの注釈から取得された取り消し線のフォント指定 |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
テキストの注釈から取得された下線のフォント指定 |
|
件名
|
annotationManager.textAnnotations.fontInfo.name | string |
テキストの注釈から取得されたフォント名。 既定値 = Arial |
|
ピッチ
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
テキストの注釈から取得されたフォントのピッチ |
|
サイズ
|
annotationManager.textAnnotations.fontInfo.size | integer |
テキストの注釈から取得されたフォント サイズ。 例: サイズ: 12 は 12000です。 係数 1000 が必要です |
|
太さ
|
annotationManager.textAnnotations.fontInfo.weight | integer |
テキストの注釈から取得されたフォントの太さ |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
テキストの注釈から取得された前景の色 (32 ビットの ARGB 値)。 例: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
テキストの注釈から取得された前景の色 (RGB の 16 進コード)。 例: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
高さ
|
annotationManager.textAnnotations.height | integer |
テキストの注釈から取得されたテキストの高さ (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ID
|
annotationManager.textAnnotations.id | string |
テキスト注釈の ID |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
テキストの注釈から取得された修正日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
テキストの注釈から取得されたページ数 |
|
回転
|
annotationManager.textAnnotations.rotation | integer |
テキストの注釈から取得された回転の角度 |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
テキストの注釈のセキュリティ レベル (PubliclyAvailable、Personal、PersonalProtected、OnlyEditors)。 既定値 = PubliclyAvailable |
|
選択可能
|
annotationManager.textAnnotations.selectable | boolean |
テキスト注釈がユーザーによって選択できるかどうかを定義します |
|
テキスト
|
annotationManager.textAnnotations.text | string |
テキストの注釈のユーザー定義テキスト |
|
透明
|
annotationManager.textAnnotations.transparent | boolean |
テキストの注釈が透明になります |
|
幅
|
annotationManager.textAnnotations.width | integer |
テキストの注釈から取得されたテキストの幅 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
X
|
annotationManager.textAnnotations.x | integer |
テキストの注釈から取得された X 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
年
|
annotationManager.textAnnotations.y | integer |
テキストの注釈から取得された Y 座標 (単位は、7200 DPI に対応した 1 インチあたりのピクセル数) |
|
ブログ
|
blogs | array of object |
ブログ |
|
CreatedDate
|
blogs.createdDate | string |
ブログが作成された日付。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
ブログを作成しているユーザーのユーザー ID |
|
ID
|
blogs.id | string |
ブログの ID |
|
テキスト
|
blogs.text | string |
ブログ項目のテキスト |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
ドキュメントのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null) |
|
CheckOutUserId
|
checkOutUserId | string |
ドキュメントがチェックアウトされているユーザーの ID |
|
documentData
|
documentData | array of object |
documentData |
|
ID
|
documentData.id | string |
ドキュメント データの ID |
|
件名
|
documentData.name | string |
ドキュメント データ名 |
|
レンディション
|
documentData.renditions | array of object |
レンディション |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
contentProtections |
|
拡張子
|
documentData.renditions.extension | string |
レンディションの拡張子 |
|
ファイル
|
documentData.renditions.files | array of object |
ファイル |
|
blobPath
|
documentData.renditions.files.blobPath | string |
レンディションの BLOB パス |
|
blobStoreId
|
documentData.renditions.files.blobStoreId | string |
レンディションの BLOB ストア ID |
|
ID
|
documentData.renditions.id | string |
ID |
|
pageCount
|
documentData.renditions.pageCount | string |
レンディションのページ数 |
|
サイズ
|
documentData.renditions.size | string |
レンディションのサイズ |
|
HasOverlay
|
hasOverlay | boolean |
ドキュメントをオーバーレイを使って表示するかどうかを定義します |
|
ID
|
id | string |
ドキュメントの ID |
|
ImportTemplateId
|
importTemplateId | string |
このドキュメントのインポート テンプレートの ID |
|
InfoStoreId
|
infoStoreId | string |
情報ストアの ID |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
チェックアウト ライフ サイクル状態 |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
ライフ サイクルの計算済み終了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
ライフ サイクルの開始日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
ライフサイクル状態の ID |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
次の自動ライフ サイクル状態 |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
保護の有効期限後にドキュメントを削除することを許可します |
|
ID
|
lifeCycleManager.lifeCycleProtections.id | string |
ライフ サイクル状態保護の ID |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
注釈が変更されないよう保護します |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
チェックアウトされないよう保護します |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
コンテンツが変更されないよう保護します |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
削除されないよう保護します |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
プロパティが変更されないよう保護します |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
セキュリティが変更されないよう保護します |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
保護の期間 |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
ライフサイクルの ID |
|
MainFileLength
|
mainFileLength | integer |
メイン ファイル サイズ |
|
件名
|
name | string |
ドキュメントの名前 |
|
PageCount
|
pageCount | integer |
メイン ファイルのページ数 |
|
プロパティ
|
properties | array of object |
プロパティ |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
値
|
properties.globalValues.values | array of object |
値 |
|
culture
|
properties.globalValues.values.culture | string |
カルチャ |
|
テキスト
|
properties.globalValues.values.text | string |
テキスト |
|
PropertyName
|
properties.propertyName | string |
プロパティ名前 |
|
PropertyTypeId
|
properties.propertyTypeId | string |
インデックス フィールドの種類 ID |
|
値
|
properties.values | array of string |
値 |
|
ProtectionDomainId
|
protectionDomainId | string |
保護ドメインの ID |
|
件のアラーム
|
reminders | array of object |
件のアラーム |
|
内容
|
reminders.description | string |
アラームの説明 |
|
間隔
|
reminders.interval | integer |
アラームの間隔 (日数) |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
このアラームのプロセス テンプレート ID |
|
ReminderDate
|
reminders.reminderDate | string |
アラームの日付。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
アラームの ID |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
プロセス テンプレートからのユーザー定義が使用されるかどうかを定義します |
|
SigningProfileId
|
signingProfileId | string |
署名プロファイルの ID |
|
VersionId
|
versionId | string |
ドキュメントのバージョン ID |
ハッシュされたパスワードを使用してログオンする
ハッシュされたパスワードを使用してログオンする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ユーザー名
|
userName | True | string |
ログオンのユーザー名 |
|
ハッシュされたパスワード
|
passwordHashed | True | string |
ログオン用のユーザー パスワード (Base64 エンコードされた SHA 512 ハッシュ) |
|
テナント名
|
tenantName | string |
ログオン先のテナント名 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ConnectionId
|
LogonResult.ConnectionId | string |
接続を識別するための接続 ID |
|
ConnectionTimeoutSeconds
|
LogonResult.ConnectionTimeoutSeconds | integer |
接続タイムアウト (秒) |
|
IsApplicationLicence
|
LogonResult.IsApplicationLicence | boolean |
種類はアプリケーション ライセンスです |
|
IsConcurrentLicence
|
LogonResult.IsConcurrentLicence | boolean |
種類はコンカレント ライセンスです |
|
IsNamedLicence
|
LogonResult.IsNamedLicence | boolean |
種類は名前付きライセンスです |
|
IsVerificationCodeNeeded
|
LogonResult.IsVerificationCodeNeeded | boolean |
検証コードが必要です |
|
JWTToken
|
LogonResult.JWTToken | string |
この接続の JWT トークン |
|
PossibleTwoWayAuthenticationType
|
LogonResult.PossibleTwoWayAuthenticationType | string |
可能な双方向認証の種類 (なし、Mail、SMS) |
|
TwoWayAuthenticationTargetMail
|
LogonResult.TwoWayAuthenticationTargetMail | string |
twoWayAuthentication でメールが送信されるマスク メール アドレス |
ファイル コンテンツの取得
ファイル コンテンツの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
DocumentId
|
DocumentId | True | string |
ドキュメント ID |
|
VersionId
|
VersionId | string |
バージョンの ID (GUID) |
|
|
DocumentDataId
|
DocumentDataId | string |
ドキュメント データの ID (GUID) |
|
|
RenditionId
|
RenditionId | string |
ドキュメント レンディションの ID (GUID) |
|
|
IgnoreHashValidation
|
IgnoreHashValidation | boolean |
ハッシュ検証のシステム構成を無視します。 既定値 = yes |
戻り値
ファイル コンテンツ
- ファイル コンテンツ
- string
ファイル コンテンツを変換する
ファイル コンテンツを別の形式に変換します。 ファイル コンテンツに注釈またはオーバーレイを追加します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
DocumentId
|
DocumentId | True | string |
ドキュメント ID |
|
VersionId
|
VersionId | string |
バージョンの ID (GUID) |
|
|
DocumentDataId
|
DocumentDataId | string |
ドキュメント データの ID (GUID) |
|
|
RenditionId
|
RenditionId | string |
ドキュメント レンディションの ID (GUID) |
|
|
TargetFormat
|
TargetFormat | string |
ターゲット形式 (例: "png;pdf;tif;...") |
|
|
AddAnnotatins
|
AddAnnotatins | boolean |
ドキュメントを注釈と一緒にエクスポートするかどうかを定義します。 既定値 = yes |
|
|
AddOverlay
|
AddOverlay | boolean |
ドキュメントをオーバーレイと一緒にエクスポートするかどうかを定義します。 既定値 = yes |
戻り値
変換されたファイル コンテンツ
- ファイル コンテンツ
- string
プロセス プロパティを取得する
プロセス プロパティを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
ProcessId
|
ProcessId | True | string |
プロセスの ID (Guid) |
|
カルチャ
|
Culture | string |
プロパティ名が指定されるカルチャ (de、en、fr、...)。既定値 = de |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
PropertyName
|
propertyName | string |
プロセス プロパティ名 |
|
PropertyTypeId
|
propertyTypeId | string |
プロパティ型の ID |
|
値
|
values | array of string |
値 |
プロセスの一覧
プロセスの一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
受領者
|
Receiver | string |
プロセスからの受信者のログイン名 (例: john@sample.com|megan@sample.com)。 空の場合は、ログインしているユーザーが受信者として取得されます |
|
|
Status
|
Status | string |
プロセスの状態。 既定値 = open |
|
|
IgnoreReceiver
|
IgnoreReceiver | boolean |
yes の場合、受信者の不要なすべてのプロセスが一覧表示されます。 既定値 = false |
|
|
MaxSerchResults
|
MaxSerchResults | string |
プロセス検索結果の最大数。 既定値 = 100 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
プロセス
|
processes | array of object |
プロセス |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
processes.checkOutStateEnum | string |
プロセスのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null) |
|
CheckOutUserId
|
processes.checkOutUserId | string |
ドキュメントがチェックアウトされているユーザーの ID |
|
comments
|
processes.comments | array of object |
comments |
|
日
|
processes.comments.date | string |
コメントの日付 |
|
ID
|
processes.comments.id | string |
コメントの ID |
|
テキスト
|
processes.comments.text | string |
ユーザーの定義のコメント |
|
UserId
|
processes.comments.userId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
processes.completedDate | string |
プロセスの完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
completedTasks
|
processes.completedTasks | array of object |
completedTasks |
|
操作
|
processes.completedTasks.action | string |
ユーザー用のアクションテキスト。 エンドユーザーに表示 |
|
assignedUserIds
|
processes.completedTasks.assignedUserIds | array of |
assignedUserIds |
|
comments
|
processes.completedTasks.comments | array of object |
comments |
|
日
|
processes.completedTasks.comments.date | string |
コメントの日付 |
|
ID
|
processes.completedTasks.comments.id | string |
コメントの ID |
|
テキスト
|
processes.completedTasks.comments.text | string |
ユーザーの定義のコメント |
|
UserId
|
processes.completedTasks.comments.userId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
processes.completedTasks.completedDate | string |
完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds
|
processes.completedTasks.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
processes.completedTasks.createdDate | string |
作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
processes.completedTasks.creatorId | string |
作成者のユーザー ID |
|
内容
|
processes.completedTasks.description | string |
タスクの説明 |
|
DueDate
|
processes.completedTasks.dueDate | string |
タスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds
|
processes.completedTasks.intendedUserIds | array of |
intendedUserIds |
|
ReminderDate
|
processes.completedTasks.reminderDate | string |
アラームの日時。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
processes.completedTasks.requiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
processes.completedTasks.showCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
ステータス
|
processes.completedTasks.statusEnum | string |
タスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
processes.completedTasks.taskTemplateId | string |
タスク テンプレート ID |
|
CreatedDate
|
processes.createdDate | string |
プロセスの作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CurrentTask
|
processes.currentTask | string |
現在のアクティブなタスク |
|
CustomProperties
|
processes.customProperties | string |
すべてのカスタム プロパティの一覧 |
|
DocumentIds
|
processes.documentIds | string |
すべての添付ドキュメント ID の一覧 |
|
DueDate
|
processes.dueDate | string |
プロセスの期限 日付の形式: yyyy-MM-ddTHH:mm:ss |
|
FolderElementId
|
processes.folderElementId | string |
フォルダ要素としてのプロセスの ID |
|
HasLinks
|
processes.hasLinks | boolean |
プロセスにリンクがあるかどうかを示すフラグ |
|
ID
|
processes.id | string |
プロセスの ID |
|
値
|
processes.name.values | array of object |
値 |
|
culture
|
processes.name.values.culture | string |
culture |
|
テキスト
|
processes.name.values.text | string |
テキスト |
|
PriorityEnum
|
processes.priorityEnum | string |
プロセスの優先度 (High、Normal、Low) |
|
PluginStream
|
processes.pluginStream | string |
プラグインのデータ コンテナー |
|
ProcessTemplateId
|
processes.processTemplateId | string |
プロセスのテンプレート ID |
|
プロパティ
|
processes.properties | array of object |
プロパティ |
|
propertyName
|
processes.properties.propertyName | string |
propertyName |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
propertyTypeId |
|
値
|
processes.properties.values | array of string |
値 |
|
ProtectionDomainId
|
processes.protectionDomainId | string |
プロセスの保護ドメイン ID |
|
StatusEnum
|
processes.statusEnum | string |
プロセスの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
HasMore
|
hasMore | boolean |
結果がさらに存在するかどうかを示します。 結果をさらに取得できる場合は、フラグが true に設定されます |
|
ResumePoint
|
resumePoint | string |
前の検索操作からの再開ポイントです。 最初の検索操作の場合は null に設定されます |
プロセスの作成
プロセスの作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
ProcessProperties
|
ProcessProperties | string |
プロセス プロパティの更新形式: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713 |
|
|
CustomProperties
|
CustomProperties | string |
カスタム プロパティ。 フォーマット: [||PropertyType] (例 [Supplier|Muster|String][InvoiceDate|2021-01-29T13:05:45 | Date][InvoiceNo|4711|Number]) |
|
|
DocumentIds
|
DocumentIds | string |
添付するすべてのドキュメント ID の一覧 |
|
|
ProcessTemplateName
|
ProcessTemplateName | True | string |
プロセス テンプレートの名前 |
|
DueDate
|
DueDate | string |
プロセスの期限。 日付の形式: yyyy-MM-ddTHH:mm:ss。 既定値 = 現在の日付 |
|
|
優先順位
|
Priority | string |
プロセスの優先度 (例: Low、Normal、High)。 既定値 = Normal |
|
|
コメント
|
Comment | string |
プロセス コメント |
|
|
カルチャ
|
Culture | string |
テキストが指定されるカルチャ (de、en、fr、...)。既定値 = de |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutState
|
checkOutStateEnum | string |
ドキュメントのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null) |
|
CheckOutUserId
|
checkOutUserId | string |
プロセスがチェックアウトされているユーザーの ID |
|
comments
|
comments | array of object |
comments |
|
日
|
comments.date | string |
コメントの日付 |
|
ID
|
comments.id | string |
コメントの ID |
|
テキスト
|
comments.text | string |
ユーザーの定義のコメント |
|
UserId
|
comments.userId | string |
ユーザー ID |
|
CompletedDate
|
completedDate | string |
完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
completedTasks
|
completedTasks | array of string |
completedTasks |
|
CreatedDate
|
createdDate | string |
作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
操作
|
currentTask.action | string |
ユーザー用のアクションテキスト。 エンドユーザーに表示 |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
comments
|
currentTask.comments | array of string |
comments |
|
CompletedDate
|
currentTask.completedDate | string |
現在のタスクの完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
currentTask.createdDate | string |
現在のタスクの作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
currentTask.creatorId | string |
現在のタスクの作成者のユーザー ID |
|
内容
|
currentTask.description | string |
現在のタスクの説明 |
|
DueDate
|
currentTask.dueDate | string |
現在のタスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds
|
currentTask.intendedUserIds | array of string |
intendedUserIds |
|
ReminderDate
|
currentTask.reminderDate | string |
現在のタスクのアラームの日付。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
currentTask.requiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
StatusEnum
|
currentTask.statusEnum | string |
現在のタスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
currentTask.taskTemplateId | string |
現在のタスクのテンプレート ID |
|
customProperties
|
customProperties | array of object |
customProperties |
|
CustomPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
カスタム プロパティ型の列挙値 (文字列、日付、数値) |
|
件名
|
customProperties.name | string |
カスタム プロパティの名前 |
|
値
|
customProperties.value | string |
カスタム プロパティの値 |
|
documentIds
|
documentIds | array of string |
documentIds |
|
DueDate
|
dueDate | string |
プロセスの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
FolderElementId
|
folderElementId | string |
フォルダー要素としてのドキュメントの ID |
|
HasLinks
|
hasLinks | boolean |
フォルダー要素としてのドキュメントの ID |
|
ID
|
id | string |
Process id |
|
値
|
name.values | array of object |
値 |
|
カルチャ
|
name.values.culture | string |
テキストが指定されるカルチャ (de、en、fr、...) |
|
テキスト
|
name.values.text | string |
この言語のテキスト |
|
PriorityEnum
|
priorityEnum | string |
プロセスの優先度 (High、Normal、Low)。 既定値 = Normal |
|
PluginStream
|
pluginStream | string |
プラグインのデータ コンテナー |
|
ProcessTemplateId
|
processTemplateId | string |
プロセスのテンプレート ID |
|
プロパティ
|
properties | array of object |
プロパティ |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
値
|
properties.globalValues.values | array of object |
値 |
|
culture
|
properties.globalValues.values.culture | string |
culture |
|
テキスト
|
properties.globalValues.values.text | string |
テキスト |
|
PropertyName
|
properties.propertyName | string |
プロセス プロパティの名前 |
|
PropertyTypeId
|
properties.propertyTypeId | string |
プロセス プロパティの ID |
|
値
|
properties.values | array of string |
値 |
|
ProtectionDomainId
|
protectionDomainId | string |
プロセスの保護ドメイン ID |
|
StatusEnum
|
statusEnum | string |
プロセスの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
プロセスを取得する
プロセスを取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
接続を識別するための接続 ID |
|
ProcessId
|
processId | True | string |
プロセスの ID (Guid) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
AccessRightsEnumList
|
GetProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
GetProcessResult.CheckOutStateEnum | string |
ドキュメントのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null) |
|
CheckOutUserId
|
GetProcessResult.CheckOutUserId | string |
プロセスがチェックアウトされているユーザーの ID |
|
コメント
|
GetProcessResult.Comments | array of object |
コメント |
|
日
|
GetProcessResult.Comments.Date | string |
コメントの日付 |
|
ID
|
GetProcessResult.Comments.Id | string |
コメントの ID |
|
テキスト
|
GetProcessResult.Comments.Text | string |
ユーザーの定義のコメント |
|
UserId
|
GetProcessResult.Comments.UserId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
GetProcessResult.CompletedDate | string |
プロセスの完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CompletedTasks
|
GetProcessResult.CompletedTasks | array of object |
CompletedTasks |
|
操作
|
GetProcessResult.CompletedTasks.Action | string |
ユーザー用のアクションテキスト。 エンドユーザーに表示 |
|
AssignedUserIds
|
GetProcessResult.CompletedTasks.AssignedUserIds | array of |
assignedUserIds |
|
コメント
|
GetProcessResult.CompletedTasks.Comments | array of object |
コメント |
|
日
|
GetProcessResult.CompletedTasks.Comments.Date | string |
コメントの日付 |
|
ID
|
GetProcessResult.CompletedTasks.Comments.Id | string |
コメントの ID |
|
テキスト
|
GetProcessResult.CompletedTasks.Comments.Text | string |
ユーザーの定義のコメント |
|
UserId
|
GetProcessResult.CompletedTasks.Comments.UserId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
GetProcessResult.CompletedTasks.CompletedDate | string |
完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CompletedTasks.CompletedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
GetProcessResult.CompletedTasks.CreatedDate | string |
作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CompletedTasks.CreatorId | string |
作成者のユーザー ID |
|
内容
|
GetProcessResult.CompletedTasks.Description | string |
タスクの説明 |
|
DueDate
|
GetProcessResult.CompletedTasks.DueDate | string |
タスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
IntendedUserIds
|
GetProcessResult.CompletedTasks.IntendedUserIds | array of |
intendedUserIds |
|
ReminderDate
|
GetProcessResult.CompletedTasks.ReminderDate | string |
アラームの日時。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
GetProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
GetProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
ステータス
|
GetProcessResult.CompletedTasks.StatusEnum | string |
タスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
GetProcessResult.CompletedTasks.TaskTemplateId | string |
タスク テンプレート ID |
|
CreatedDate
|
GetProcessResult.CreatedDate | string |
プロセスの作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
操作
|
GetProcessResult.CurrentTask.Action | string |
ユーザー用のアクションテキスト。 エンドユーザーに表示 |
|
AssignedUserIds
|
GetProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
コメント
|
GetProcessResult.CurrentTask.Comments | array of string |
コメント |
|
CompletedDate
|
GetProcessResult.CurrentTask.CompletedDate | string |
完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
GetProcessResult.CurrentTask.CreatedDate | string |
作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CurrentTask.CreatorId | string |
作成者のユーザー ID |
|
内容
|
GetProcessResult.CurrentTask.Description | string |
タスクの説明 |
|
DueDate
|
GetProcessResult.CurrentTask.DueDate | string |
タスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
ID
|
GetProcessResult.CurrentTask.Id | string |
タスクの ID |
|
IntendedUserIds
|
GetProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
ReminderDate
|
GetProcessResult.CurrentTask.ReminderDate | string |
アラームの日時。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
GetProcessResult.CurrentTask.RequiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
GetProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
StatusEnum
|
GetProcessResult.CurrentTask.StatusEnum | string |
タスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
GetProcessResult.CurrentTask.TaskTemplateId | string |
タスク テンプレート ID |
|
CustomProperties
|
GetProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
GetProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
カスタム プロパティのデータ型の一覧 (文字列、日付、数値) |
|
件名
|
GetProcessResult.CustomProperties.Name | string |
カスタム プロパティ型の名前 |
|
値
|
GetProcessResult.CustomProperties.Value | string |
カスタム プロパティ型の値 |
|
DocumentIds
|
GetProcessResult.DocumentIds | array of string |
DocumentIds |
|
DueDate
|
GetProcessResult.DueDate | string |
プロセスの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
ID
|
GetProcessResult.Id | string |
プロセスの ID |
|
値
|
GetProcessResult.Name.Values | array of object |
値 |
|
カルチャ
|
GetProcessResult.Name.Values.Culture | string |
テキストが指定されるカルチャ (de、en、fr、...) |
|
テキスト
|
GetProcessResult.Name.Values.Text | string |
テキスト |
|
PluginStream
|
GetProcessResult.PluginStream | array of string |
PluginStream |
|
PriorityEnum
|
GetProcessResult.PriorityEnum | string |
プロセスの優先度 (High、Normal、Low) |
|
ProcessTemplateId
|
GetProcessResult.ProcessTemplateId | string |
プロセスのテンプレート ID |
|
プロパティ
|
GetProcessResult.Properties | array of object |
プロパティ |
|
GlobalValues
|
GetProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
値
|
GetProcessResult.Properties.GlobalValues.Values | array of object |
値 |
|
カルチャ
|
GetProcessResult.Properties.GlobalValues.Values.Culture | string |
カルチャ |
|
テキスト
|
GetProcessResult.Properties.GlobalValues.Values.Text | string |
テキスト |
|
PropertyTypeId
|
GetProcessResult.Properties.PropertyTypeId | string |
プロパティ型の ID |
|
値
|
GetProcessResult.Properties.Values | array of string |
値 |
|
ProtectionDomainId
|
GetProcessResult.ProtectionDomainId | string |
プロセスの保護ドメイン ID |
|
SessionCount
|
GetProcessResult.SessionCount | integer |
セッション数 |
|
StatusEnum
|
GetProcessResult.StatusEnum | string |
プロセスの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
ユーザー テーブルから行を取得する
ユーザー テーブルから行を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
UserTable
|
UserTable | True | string |
ユーザー テーブルの名前 |
|
WhereClause
|
WhereClause | string |
SQL の where 句の要素の一覧。 形式: [|||]。 ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (e.g.: [Firstname|Equals|Jon|AND],[Lastname|Equals|Doe|AND]) |
|
|
OrderByClause
|
OrderByClause | string |
句の要素ごとの、SQL の順序の一覧 (例: Firstname[ASC],City[DESC]) |
|
|
AddColumnHeaders
|
AddColumnHeaders | boolean |
列見出しを最初の行として追加します (既定値 = false) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
UserTableGetRecordsResult
|
UserTableGetRecordsResult | array of array |
UserTableGetRecordsResult |
|
項目
|
UserTableGetRecordsResult | array of string |
ユーザー テーブルの行を削除する
ユーザー テーブルの行を削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
UserTable
|
UserTable | True | string |
ユーザー テーブルの名前 |
|
WhereClause
|
WhereClause | string |
SQL の where 句の要素の一覧。 形式: [|||]。 ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (例: [Firstname|Equals|Jon|AND],[Lastname|Equals|Doe|OR]) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
userTableDeleteRecordsResult
|
userTableDeleteRecordsResult | integer |
userTableDeleteRecordsResult |
ユーザー テーブルを作成する
ユーザー テーブルを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
UserTable
|
UserTable | True | string |
ユーザー テーブルの名前 (例: Address) |
|
ColumnHeaders
|
ColumnHeaders | True | string |
列見出しの一覧 (例: Firstname,Lastname,City) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー テーブル
|
userTable | string |
ユーザー テーブルの名前 |
ログオフ
ログオフ
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
LogoffResult
|
LogoffResult | string |
ログオフの結果 |
ログオン
ログオン
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ユーザー名
|
Username | True | string |
ログオンのユーザー名 |
|
パスワード
|
Password | True | string |
パスワード |
|
テナント名
|
Tenantname | string |
ログオン先のテナント名 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ConnectionId
|
connectionId | string |
正常にログインした場合に、接続 ID が格納されます |
|
ConnectionTimeoutSeconds
|
connectionTimeoutSeconds | integer |
接続のタイムアウト |
|
IsApplicationLicence
|
isApplicationLicence | string |
種類はアプリケーション ライセンスです |
|
IsConcurrentLicence
|
isConcurrentLicence | string |
種類はコンカレント ライセンスです |
|
IsNamedLicence
|
isNamedLicence | string |
種類は名前付きライセンスです |
|
IsVerificationCodeNeeded
|
isVerificationCodeNeeded | string |
検証コードが必要です |
|
PossibleTwoWayAuthenticationType
|
possibleTwoWayAuthenticationType | string |
可能な双方向認証の種類 (なし、Mail、SMS) |
|
TwoWayAuthenticationTargetMail
|
twoWayAuthenticationTargetMail | string |
twoWayAuthentication でメールが送信されるマスク メール アドレス |
更新プロセス
更新プロセス
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
ProcessId
|
ProcessId | True | string |
プロセスの ID (Guid) |
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
ユーザーのログイン名を現在のタスクに割り当てます。 (例: peter.muster@kendox.com;megan.muster@kendox.com) |
|
|
ProcessProperties
|
ProcessProperties | string |
プロセス プロパティの更新形式: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713 |
|
|
カスタム プロパティ
|
CustomProperties | string |
カスタム プロパティ。 フォーマット: [||PropertyType] (例 [Supplier|Muster|String][InvoiceDate|2021-01-29T13:05:45 | Date][InvoiceNo|4711|Number]) |
|
|
コメント
|
Comment | string |
コメント |
|
|
カルチャ
|
Culture | string |
プロパティ名が指定されるカルチャ (de、en、fr、...)。既定値 = de |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutState
|
checkOutStateEnum | string |
プロセスのチェックアウト状態 (NotCheckedOut、CheckedOut、CheckedOutExclusive、Null): |
|
CheckOutUserId
|
checkOutUserId | string |
ドキュメントがチェックアウトされているユーザーの ID |
|
comments
|
comments | array of object |
comments |
|
日
|
comments.date | string |
コメントの日付 |
|
ID
|
comments.id | string |
コメントの ID |
|
テキスト
|
comments.text | string |
ユーザーの定義のコメント |
|
UserId
|
comments.userId | string |
ユーザー ID |
|
CompletedDate
|
completedDate | string |
プロセスの完了日 日付の形式: yyyy-MM-ddTHH:mm:ss |
|
completedTasks
|
completedTasks | array of object |
completedTasks |
|
操作
|
completedTasks.action | string |
ユーザー用のアクションテキスト。 エンドユーザーに表示 |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of |
assignedUserIds |
|
comments
|
completedTasks.comments | array of object |
comments |
|
日
|
completedTasks.comments.date | string |
コメントの日付 |
|
ID
|
completedTasks.comments.id | string |
コメントの ID |
|
テキスト
|
completedTasks.comments.text | string |
ユーザーの定義のコメント |
|
UserId
|
completedTasks.comments.userId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
completedTasks.completedDate | string |
完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
completedTasks.createdDate | string |
作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
completedTasks.creatorId | string |
作成者のユーザー ID |
|
内容
|
completedTasks.description | string |
タスクの説明 |
|
DueDate
|
completedTasks.dueDate | string |
タスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds
|
completedTasks.intendedUserIds | array of |
intendedUserIds |
|
ReminderDate
|
completedTasks.reminderDate | string |
アラームの日時。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
ステータス
|
completedTasks.statusEnum | string |
タスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
completedTasks.taskTemplateId | string |
タスク テンプレート ID |
|
CreatedDate
|
createdDate | string |
プロセスの作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
操作
|
currentTask.action | string |
ユーザー用のアクションテキスト。 エンドユーザーに表示 |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
comments
|
currentTask.comments | array of object |
comments |
|
日
|
currentTask.comments.date | string |
コメントの日付 |
|
ID
|
currentTask.comments.id | string |
コメントの ID |
|
テキスト
|
currentTask.comments.text | string |
ユーザーの定義のコメント |
|
UserId
|
currentTask.comments.userId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
currentTask.completedDate | string |
完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
currentTask.createdDate | string |
作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
currentTask.creatorId | string |
作成者のユーザー ID |
|
内容
|
currentTask.description | string |
タスクの説明 |
|
DueDate
|
currentTask.dueDate | string |
タスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds
|
currentTask.intendedUserIds | array of string |
intendedUserIds |
|
ReminderDate
|
currentTask.reminderDate | string |
アラームの日時。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
currentTask.requiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
ステータス
|
currentTask.statusEnum | string |
タスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
currentTask.taskTemplateId | string |
タスク テンプレート ID |
|
customProperties
|
customProperties | array of object |
customProperties |
|
CustomProperties
|
customProperties | object |
すべてのカスタム プロパティの一覧 |
|
documentIds
|
documentIds | array of string |
documentIds |
|
DueDate
|
dueDate | string |
プロセスの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
FolderElementId
|
folderElementId | string |
フォルダー要素としてのドキュメントの ID |
|
HasLinks
|
hasLinks | boolean |
フォルダー要素としてのドキュメントの ID |
|
ID
|
id | string |
Process id |
|
値
|
name.values | array of object |
値 |
|
カルチャ
|
name.values.culture | string |
テキストが指定されるカルチャ (de、en、fr、...) |
|
テキスト
|
name.values.text | string |
この言語のテキスト |
|
優先順位
|
priorityEnum | string |
プロセスの優先度 (High、Normal、Low) |
|
PluginStream
|
pluginStream | string |
プラグインのデータ コンテナー |
|
ProcessTemplateId
|
processTemplateId | string |
プロセスのテンプレート ID |
|
プロパティ
|
properties | array of object |
プロパティ |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
値
|
properties.globalValues.values | array of object |
値 |
|
culture
|
properties.globalValues.values.culture | string |
culture |
|
テキスト
|
properties.globalValues.values.text | string |
テキスト |
|
PropertyTypeId
|
properties.propertyTypeId | string |
インデックス フィールドの種類 ID |
|
値
|
properties.values | array of string |
値 |
|
ProtectionDomainId
|
protectionDomainId | string |
プロセスの保護ドメイン ID |
|
SessionCount
|
sessionCount | integer |
セッション数 |
|
ステータス
|
statusEnum | string |
プロセスの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
現在のタスクを閉じて、ユーザーを次のタスクに割り当てる
現在のタスクを閉じて、ユーザーを次のタスクに割り当てる
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
ProcessId
|
ProcessId | True | string |
プロセスの ID (Guid) |
|
TaskId
|
TaskId | string |
タスクの ID (Guid) |
|
|
コメント
|
Comment | string |
コメント |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | True | string |
AssignUserLoginNames |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
操作
|
action | string |
ユーザー用のアクションテキスト。 エンドユーザーに表示 |
|
assignedUserIds
|
assignedUserIds | array of string |
assignedUserIds |
|
comments
|
comments | array of object |
comments |
|
日
|
comments.date | string |
コメントの日付 |
|
ID
|
comments.id | string |
コメントの ID |
|
テキスト
|
comments.text | string |
ユーザーの定義のコメント |
|
UserId
|
comments.userId | string |
コメントを設定したユーザーの ID |
|
CompletedDate
|
completedDate | string |
完了日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
createdDate | string |
作成日。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
作成者のユーザー ID |
|
内容
|
description | string |
タスクの説明 |
|
DueDate
|
dueDate | string |
タスクの期限。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds
|
intendedUserIds | array of string |
intendedUserIds |
|
ReminderDate
|
reminderDate | string |
アラームの日時。 日付の表示形式: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
requiresAllRecipients | boolean |
すべての受信者がこのタスクを閉じる必要があるかどうかを定義します |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
タスク終了時にタスクを閉じるダイアログを表示します |
|
ステータス
|
statusEnum | string |
タスクの状態 (Open、InProcess、Complete、PreparedToComplete、Error) |
|
TaskTemplateId
|
taskTemplateId | string |
タスク テンプレート ID |
行をユーザー テーブルに挿入する
テーブルの行をユーザー テーブルにインポートします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
アーカイブ API のURL (例: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
接続を識別するための接続 ID |
|
UserTable
|
UserTable | True | string |
ユーザー テーブルの名前 |
|
値
|
Values | True | string |
挿入する行と列の値の一覧 (例: [John;Doe;New York],[Peter;Muster;Bern]) |
|
DeleteAllValues
|
DeleteAllValues | boolean |
UserTable 内のすべての値を削除するかどうかを定義します (既定値 = false) |
|
|
FirstRowContainsColumnHeaders
|
FirstRowContainsColumnHeaders | boolean |
Values パラメーターの最初の行に列見出しを含めるかどうかを定義します (既定値 = false) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー テーブル
|
userTable | string |
ユーザー テーブルの名前 |
|
挿入された行
|
insertedRows | integer |
挿入された行の数 |