パラメーターの取得

ABBYY FlexiCapture Mobile API に GET リクエストを送信し、モバイルクライアント向けに利用可能なプロジェクト、バッチタイプ、登録パラメーターを JSON として取得します。

利用可能なパラメーターを取得するには、次の URI に GET リクエストを送信します:

https://localhost/flexicapture12/Server/MobileApp

テナントを使用する場合は、追加でテナント名をパラメーターとして渡す必要があります:

https://localhost/flexicapture12/Server/MobileApp?Tenant=[tenant name]

ユーザーには Scanning Operator 権限が必要です。

​

レスポンスの構造

サーバーは、UTF-8 でエンコードされた JSON 形式のレスポンスを返します。レスポンスのルートには、サーバー上で Administrator によって設定されている場合、projectName パラメーターと batchType パラメーターの値が含まれます。

続いて、ユーザーが利用できるすべてのプロジェクトのリストが返されます。各プロジェクトには、バッチタイプと、Administrator がサーバー上で指定した文書タイプおよび登録パラメーターが一覧表示されます。

​

JSON レスポンスの例

次の例は、利用可能なプロジェクト、バッチタイプ、登録パラメーターを含む JSON レスポンスを示しています。

{
    "batchType": "",
    "projectName": "<project name>",
    "projects": [
        {
            "name": "<available project>",
            "batchTypes": [
                {
                    "name": "<Default>"
                },
                {
                    "name": "<batch type 1>",
                    "regParams": [
                        {
                            "name": "<registration parameters 1>",
                            "isRequired": "true"
                        },
                        {
                            "name": "<registration parameters 2>",
                            "isRequired": "false"
                        }
                    ]
                }
            ]
        }
    ]
}