Digital Access API を使用すると、サード パーティのシステムを Evolve ワークフロー システムと統合できます。これらの API は、API Gateway とそのサポートされている認証メカニズムで保護されています。
必要条件
以下のデジタル アクセス API を活用するには、次の前提条件があります。
-
「プロセスのデジタル アクセス ライセンス」は、Evolve システムでアクティブ化する必要があります。
-
キー「ProcessExtensionEnable」の値は True に設定する必要があります。
管理者は、アプリケーション システム→インフラストラクチャ→詳細設定からこの機能を一時的に無効にすることができます。この機能は、キー ProcessExtensionEnable を削除することで無効にでき、この機能は、カテゴリ「システム」とキー「ProcessExtensionEnable」の値を True に追加することで再度アクティブにできます。
Composer ソリューションの API を有効/無効にする
デフォルトで、すべてのソリューション (Excel ソリューションとフォーム ソリューション) は、API からアクセスできるようになっています。したがって、ライセンスがアクティブ化されるとすぐに、既存のすべてのソリューションに API からアクセスできるようになります。ソリューションは API から明示的に除外できます。これにより、API からの特定のソリューションへのアクセスが制限されます。つまり、プロセスを開始できないか、除外されたソリューションの割り当てを完了できません。これは、ソリューションを選択し、ソリューション グリッドからそのソリューションの API プロパティを変更することで実行できます。[API プロパティ] ボタンを表示し、このプロパティの値を変更できるのは、アプリ管理者またはソリューション開発者のみです。
Composer ソリューションの API 使用状況の詳細
ユーザーは、ソリューションを選択し、オプションから [API 使用状況] ボタンをクリックすることで、ソリューションの API 使用状況を確認できます。フォーム ソリューションの場合、アプリ管理者は Query と Transaction の使用状況を確認できます。Excel ソリューションの場合、アプリ管理者は Transaction の使用状況のみを表示できます。
PayLoad の生成
ユーザーは、フォーム ソリューションと Excel ソリューションの両方のソリューション グリッドからペイロードをダウンロードできます。JSON 形式のフォーム ソリューションのペイロードをダウンロードするには、[JSON ペイロード] ボタンをクリックし、XML 形式のペイロードをダウンロードするには、[XML ペイロード] ボタンをクリックします。Excel ソリューションの場合、ユーザーは JSON 形式でのみペイロードをダウンロードできます。ペイロードをダウンロードするには、ソリューション グリッドでソリューションを選択し、[ペイロード] ボタンをクリックします。
- フォーム ソリューションからの XML\JSON のペイロードのダウンロード中にフォームを少なくとも 1 回展開する必要があります。ダウンロードされた XML\JSON ペイロードは、展開されたフォームの最新バージョンになります。
- XML\JSON ペイロードには、通常フィールドまたは繰り返しフィールドのフォームで提供されるデフォルト値が含まれます。
- getDocument API を使って実行中のプロセスの現在の XML\JSON ペイロードをダウンロードします: “<EvolveSiteUrl>/svr/api/v1/Processextn/GetDocumentDataByProcess/Form/{Process-Id}/XML" または “<EvolveSiteUrl>/svr/api/v1/Processextn/GetDocumentDataByProcess/Form/{Process-Id}/JSON"
- 上記の API は実行中のプロセスのデフォルト値または提供された値を持つ XML\JSON ペイロードを返します。
- JSON ペイロードのダウンロード中に、ユーザーがグローバル管理者またはアプリ管理者である場合、 AppName パラメータがダウンロード JSON ペイロードに追加されます。ユーザーが管理者でない場合、ユーザーはペイロードをダウンロードした後に AppName パラメータを手動で追加する必要があります。
Evolve URL の場合、デフォルトのポート番号でない限り、ユーザーはポート番号を指定する必要があります。たとえば、デフォルトのポート 80 に Evolve サイトがある場合、API にアクセスするために以下の両方の Evolve URL を使用できます。
-
http://cha-de-vstpnx1.wsdt.local:80/svr/api/v1/Processextn/GetAllAssignments
-
http://cha-de-vstpnx1.wsdt.local/svr/api/v1/Processextn/GetAllAssignments
3 つのセキュリティ オプションについて、API をヒットするために使用する必要がある次のルート プレフィックスがあります。
クライアント シークレット : “<Evolve URL>/svr”
セキュア トークン : “<Evolve URL>/svr”
証明書 : “<Evolve URL>/svrc”
以下は、さまざまなデジタル アクセス API です。
API 名 | HTTP メソッド | ルート | 説明 |
---|---|---|---|
CompleteAssignment | POST | <RoutePrefix>/api/v1/Processextn/CompleteAssignment | この API を使用すると、既存の開いている割り当てを完了することができます。 |
GetAllAssignments | GET | <RoutePrefix>/api/v1/Processextn/GetAllAssignments | この API は、OData フィルターのサポートが制限されているすべての開いている割り当てを返します。これにより、API URL で OData フィルターを渡すことにより、特定のユーザーまたはソリューションのデータをフィルター処理できます。 |
GetDocumentDataByProcess | GET |
<RoutePrefix>/api/v1/Processextn/GetDocumentDataByProcess/<document type>/<processid>/<format> ドキュメント タイプe: 「Excel」または「フォーム フォーマット: 「json」または「xml」。フォーム ドキュメントでのみ機能します。 |
この API は、指定されたプロセス ID のプロセスのドキュメントの最新のコピーを返します。 |
StartExcelProcess | POST |
|
この API は、Excel ワークフロー プロセスを開始します。送信された Excel ファイルはそれぞれのソリューション ライブラリに送信され、この新しいドキュメントで新しいプロセスが開始されます。 |
StartFormJsonProcess | POST | <RoutePrefix>/api/v1/Processextn/StartFormJsonProcess | この API は、フォーム ワークフロー プロセスを開始します。フォーム データは JSON 形式である必要があります。このフォーム データを保存するときにデータ検証が実行されていないか、フィールドのルールが実行されていないため、有効なフォーム JSON である必要があります。 |
StartFormProcess | POST |
<RoutePrefix>/api/v1/Processextn/StartFormProcess |
この API により、フォーム ワークフロー プロセスを開始できます。初期のフォーム データは XML 形式で送信される必要があります。このフォーム データの保存中にデータ検証が実行されていないか、ルールが実行されていないため、有効なフォーム XML である必要があります。 |