複数ページを含むバッチを POST リクエストで送信する際に、バッチの構造に関する説明を追加できます。現在のバージョンでは、次のシナリオをサポートしています。
- ページからのドキュメントの作成
- ドキュメントに対する目的の Document Definition の指定
現在のバージョンでは、1 レベルのドキュメントのみがサポートされています。
これらの機能を使用するには、multipart リクエストに BatchStructure という Name の отдельный テキスト field を追加します。この Name には、作成するバッチの構造を記述した JSON を含める必要があり、形式は次のとおりです。
{
"documents": [
{
"template": "Banking_eng",
"pages": ["file1.jpg", "file2.jpg"]
},
{ "pages": ["file3.jpg", "file4.jpg"] }
]
}
template field は省略可能で、バッチタイプ内の Document Definition の名前を 1 つ指定します。pages array には、リクエストで送信するファイル名 (filename の値) が含まれます。これらは document の構成に使用されます。
このサービスでは、1 つの画像を使って異なる document 内に複数のページを作成することも可能です。たとえば、この方法を使用するとリクエストのサイズを小さくできます。
バッチ構造に加えて、document および/またはバッチの登録パラメーターを記述するために json ファイルを使用することもできます。
{
"regParams": [
{"name":"batchParam1", "value":"param1value"},
{"name":"batchParam2", "value":"param2value"}
],
"documents": [
{
"template": "Banking_eng",
"pages": ["file1.jpg", "file2.jpg"],
"regParams": [
{"name":"param1", "value":"param1value"},
{"name":"param2", "value":"param2value"}
]
}
]
}