プロセス API によるドキュメント データの取得 - Automate_Evolve - Automate_Studio_Manager - 20.3

Automate Evolve ユーザー ガイド

Product type
ソフトウェア
Portfolio
Integrate
Product family
Automate
Product
Automate > Automate Evolve
Version
20.3
Language
日本語
Product name
Automate Evolve
Title
Automate Evolve ユーザー ガイド
Topic type
管理
概要
リファレンス
First publish date
2018

Get Document Data By Process API は、指定されたプロセス ID のプロセスのドキュメントの最新のコピーを返します。この API は、GET メソッドを使用して、プロセス ドキュメントの最新のコピーを返します。

API の概要

  1. フォーム ベースのプロセスの場合、フォーム ドキュメントは、パラメーター Format に指定された値に従って json または xml 形式で返されます。形式が指定されていない場合、アプリケーションは json 形式をデフォルトの形式と見なします。

  2. Excel ワークフローの場合、ドキュメントは常に Excel 形式で返されます。

リクエストとレスポンスのサンプル

この API は、指定されたプロセス ID のプロセスのドキュメントの最新のコピーを返します。リクエストと応答の構造は次のようになります。

リクエスト データ コントラクト:

リクエスト ボディは必要ありません

リクエスト URL のパラメーターは次のとおりです。

  • ドキュメント タイプ: これは Excel/フォームにすることができます。

  • プロセス ID: これはプロセスの GUID です。

  • 結果の形式 (オプション): 「json」または「xml」にすることができます。フォーム ドキュメントでのみ機能します。

以下はリクエストのサンプルです。

サンプル 1

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Excel/EDE8CF75-248C-407D-A5B8-0209759003D4

サンプル 2

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Form/DC135B5A-DE73-4D84-BCB5-01CB5A0EBFC0

サンプル 3

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Form/DC135B5A-DE73-4D84-BCB5-01CB5A0EBFC0/xml

レスポンス データ コントラクト:

  1. フォーム ソリューション (JSON 形式):

    フォーム フィールド (フォーム ソリューションで追加した通り) のデータは、以下に示すように JSON 形式で返されます。

    {     "my:myFields":      {         <<Form Data in json as per Form solution feilds added to the Form solution.>>           } }
  2. フォーム ソリューション (XML 形式):

    フォーム フィールド (フォーム ソリューションで追加した通り) のデータは、以下に示すように XML 形式で返されます。

    "<my:myFields xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"  xmlns:xhtml=\"http://www.w3.org/1999/xhtml\"  xmlns:pc=\"http://schemas.microsoft.com/office/infopath/2007/PartnerControls\"  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\">

    フォーム ソリューションに追加されたフォーム ソリューションのフィールドに従った、XML 形式のフォーム データ。

    </my:myFields>
  3. Excel ソリューション:

    これにより、base64 のデータが返されます。

    {   “Title”:”DocumentName”,   “content”:”base64string” }