Excel Process API の開始を使用すると、Excel ワークフロー プロセスを開始できます。送信された Excel ファイルはそれぞれのソリューション ライブラリに送信され、この新しいドキュメントで新しいプロセスが開始されます。この API は、POST メソッドを使用してワークフロー プロセスを開始します。
API の概要
以下は、Excel プロセス API の開始の概要です。
-
Excel ワークフロー名テンプレート機能をサポートしています。ExcelWorkflowObj.DataFile.Title プロパティは、対象の Excel プロセスがデータ ファイルの名前テンプレートで構成されている場合、無視されます。また、名前テンプレートの次の名前は、ドキュメントの名前を設定するために使用されます。
-
API は設定「バージョン管理: データ テンプレートのバージョン管理」をサポートします。これはアプリ レベルの設定であり、データ ファイルが API ルート/テンプレートに送信されるときにサポートされます。
また、ルート/ファイルは、データ テンプレート ファイルから作成されていない Excel ファイルを送信するために使用できます。このルートに送信されたファイルは、最新のテンプレート ファイルと見なされます。したがって、「データ テンプレートのバージョン管理」という設定には意味がありません。
-
ファイル送信者として指定された Evolve ユーザーは、ソリューションで作成元の役割を持っている必要があります。
-
ファイル送信者として指定された Evolve ユーザーは、有効なユーザー名ライセンスを持っている必要があります (つまり、実行者または標準など)。
-
プロセス参加者またはスイム レーン ユーザーを API リクエストで指定することはできません。これは、Studio Microsoft Excel アドインから Excel ファイルを送信するのと同じです。
-
ソリューション フィールドの同期機能をサポートしています。
-
Query Where 句をサポートしています (つまり、RTV 形式)。Excel プロセス API 経由の入力ファイルを持つ Query スクリプトの自動実行は、RTV 情報が提供されている場合に正常に機能します。
-
「ソリューション テンプレート Excel ファイル」から作成した Excel データ ファイルは、{API Route}/Template にルートして送信する必要があります。
-
「ソリューション テンプレート Excel ファイル」から作成していない Excel データ ファイルは、{API ルート}/ファイルにルートして送信する必要があります。
-
これは、データ テンプレートのバージョン管理をサポートしません。
-
送信された Excel ファイルの列/データ構造は、指定の Excel ソリューション スクリプトに対して定義されたマッピングに従う必要があります。間違ったファイルは、ワークフロー実行エラーまたはデータ投稿エラーを引き起こします。
-
-
テンプレートまたはファイルのいずれかが指定されていない場合、システムは「{API ルート}/ファイル」にルートされたとしてリクエストを処理します。
-
API を介して同名のデータ ファイルを再送信することはできません。
-
API から開始された Excel ワークフローが API ドキュメントとしてタグ付けされ、手動で再送信された場合、キャンセルされたプロセス ドキュメントは引き続き API ドキュメントと見なされます。この情報は、ライセンス課金の対象になります。
リクエストとレスポンスの本文
API 経由で指定の Excel テンプレートを使用して Excel プロセスを開始する場合、リクエストと応答の構造は次のようになります。
リクエスト データ コントラクト
| 名前 | タイプ | 制限 | 説明 |
|---|---|---|---|
| ExcelWorkflowObj | Jobject | 必須 | JSON オブジェクトとして送信されるデータ ファイルとサポート ドキュメント。JSON オブジェクト スキーマの詳細は、この表の最後に記載されています。データ ファイルとサポート ドキュメントは base64String でエンコードされている必要があります。 |
| UserName | 文字列 | 必須 | これは Evolve ユーザー名です。ユーザーは、テンプレートが送信されるソリューションに対する作成元権限を持っている必要があります。 |
| AppName | 文字列 | 必須 | この Excel プロセスを開始するアプリ名。Excel テンプレート ソリューションまたはライブラリは、このアプリにのみ存在する必要があります。 |
| LibName | 文字列 | 非ソリューション テンプレート Excel ファイルにのみ必要です。{API ルート}/ｆアカウント | Excel ソリューションのライブラリ名。 |
| TemplateName | 文字列 | 非ソリューション テンプレート Excel ファイルにのみ必要です。{API ルート}/ｆアカウント | 「Excel ソリューション」の名前。 |
ExcelWorkflowObj パラメーター JSON スキーマの詳細:
"ExcelWorkflowObj":{ "DataFile":[{ "Title": "ExcelDataFileName1.xlsx", "RTVInfo": "", "Description": "", "DataFileBlob": "<<Base64EncodedString>>" }], "SupportingFiles":[{ "Title": "SupportingFileName1.xlsx", "Description": "", "FileBlob": "<<supporting file blob>>"}, { "Title": "SupportingFileName2.txt", "Description": "", "FileBlob": "<<Base64EncodedString>>" }] }ExcelWorkflowObj.DataFile: これは配列型ですが、最初の配列要素のみがサポートされ、API によって使用されます。
ExcelWorkflowObj.SupportingFiles: 複数のサポート ファイルを送信できます。
レスポンス データ コントラクト:
| 名前 | タイプ | 制限 | 説明 |
|---|---|---|---|
| DocumentItemId | Guid | - | Excelドキュメントのリターン ID |
リクエストとレスポンスのサンプル
次のサンプルは、API の使用方法を示しています。
ペイロードのリクエスト
{ "LibName":"Excel Workbooks", "UserName":"wsdt\\centraluser", "ExcelWorkflowObj": { "DataFile": [ { "Description":"", "DataFileBlob":"UEsDBBQABgAIAAAAIQComKncbgEAAJUFAAATAAgCW0NvbnRlbnRfVHlw...", "RTVInfo":"", "Title":"publish10474.xlsx" } ] }, "TemplateName":"MM02_EPIM", "AppName":"Arpit App" }ペイロードのレスポンス
{ "DocumentItemId": "ea03a42e-7eca-4b5d-af8f-d8e778d75e84" }