Start Form Process API を使用すると、フォーム ワークフロー プロセスを開始できます。この API は、POST メソッドを使用してワークフロー プロセスを開始します。初期のフォーム データは XML 形式で送信される必要があります。フォーム データを保存するときには、データが検証されないか、ルールが実行されないため、有効なフォーム XML である必要があります。
API の概要
以下は、Start Process API の概要です。
-
名前テンプレート機能をサポートしています。名前テンプレートは、フォーム名コントロールで構成する必要があります。フォーム名コントロールの Run At のプロパティは Endに設定する必要があります。Digital Access API の呼び出し中、 フォーム名 コントロールのフィールド名プロパティにマップされたフォーム フィールドは空である必要があります。
-
フォーム 送信者として指定されている Evolve ユーザーは、開始する必要のある新しいフォーム プロセスのソリューションに対する作成元の役割を持っている必要があります。
-
オプションとして、プロセス参加者またはスイム レーン ユーザーも、API リクエストで指定できます。
-
API から開始されたフォーム ワークフローが API ドキュメントとしてタグ付けされ、手動で再送信された場合、キャンセルされたプロセス ドキュメントは引き続き API ドキュメントと見なされます。この情報は、ライセンス課金の対象になります。
-
フォーム ドキュメントをコピーすると、システムに新しいドキュメントが作成されます。API ドキュメントからコピーされ、Web UI から手動で開始/送信されたドキュメントは、非 API ドキュメントと見なされます (つまり、手動送信ドキュメント)。
リクエストとレスポンスの本文
API を介してフォーム プロセスを開始する場合、リクエストの構造と応答は次のようになります。
リクエスト データ コントラクト:
名前 | タイプ | 制限 | 説明 |
---|---|---|---|
AppName | 文字列 | 必須 | 「フォーム ソリューション」のアプリ名。 |
コメント | 文字列 | - | 開始ノードへのコメント。 |
FormXML | 文字列 | - | これは、新しいフォーム プロセスのフォーム データです。これは、フォーム ソリューションの有効なフォーム XML である必要があります。 |
LibName | 文字列 | 必須 | 「フォーム ソリューション」のライブラリ名。 |
ParticipantsInfoArray | { “SwimlaneName” : ”abc”, “UserName”: ”xyz” } の Jarray | - |
これはスイム レーン名である必要があり、特定のユーザーで解決する必要があります。
このパラメーターが空白のままであるか、特定のスイム レーンの詳細が提供されていない場合、アプリケーションはワークフローで定義された動作に従ってこれらのスイム レーンを解決します。 フォーム ワークフローの個人タイプ スイム レーンの場合は、API を介してフォームを開始するときに、スイム レーン ユーザー値を上書きすることはできません。 |
TemplateName | 文字列 | 必須 | 「フォーム ソリューション」の名前。 |
UserName | 文字列 | 必須 | プロセス作成元として設定されるユーザーのユーザー名。ユーザーは、開始する必要のある新しいフォーム プロセスのソリューションに対する作成元の役割を持っている必要があります。 |
レスポンス データ コントラクト:
名前 | タイプ | 制限 | 説明 |
---|---|---|---|
processId | Guid | - | プロセスの ID を返します。 |
FormItemId | Guid | - | フォーム ドキュメントのリターン ID。 |
リクエストとレスポンスのサンプル
次のサンプルは、API の使用方法を示しています。
ルート: http://Winshuttle.EvolveUrl/svr/api/v1/Processextn/StartFormProcess
ペイロードのリクエスト
{ "AppName":"My API", "LibName": "Form Process Ext", "TemplateName": "API Product Example", "UserName": "mydomain\\user1", "Comments": "Process from API2", "FormXml": "<my:myFields xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xhtml=\"http://www.w3.org/1999/xhtml\" xmlns:d=\"http://schemas.microsoft.com/office/infopath/2003/ado/dataFields\" xmlns:dfs=\"http://schemas.microsoft.com/office/infopath/2003/dataFormSolution\" xmlns:my=\"http://schemas.microsoft.com/office/infopath/2003/myXSD\" xmlns:xd=\"http://schemas.microsoft.com/office/infopath/2003\" xmlns:msxsl=\"urn:schemas-microsoft-com:xslt\"> <my:Product_Name>Evolve</my:Product_Name><my:Product_Description>Evolve product desc</my:Product_Description></my:myFields>", "ParticipantsInfoArray": [ { "SwimLaneName": "PersonSwimlane", "UsersName": "mydomain\\user1" }, { "SwimLaneName": "TeamSwimlane", "UsersName": "mydomain\\user1,mydomain\\user2" } ] }
ペイロードのレスポンス
{ "ProcessId": "93ae1e24-366e-4e54-af5c-dbf34ec15797", "FormItemId": "0e6c9998-3e3d-4e89-9fd4-e8086312cb32" }