Specify the structure of a batch - ABBYY Documentation

When you send a batch of several pages in a POST request, you can describe the structure of that batch. For more information, see Upload files to the server. The batch structure supports the following scenarios:

Creating documents from pages
Specifying a Document Definition for a document

Documents can have only one level.

Describe the batch structure

Add a text field named BatchStructure to the multipart request. The field holds a JSON description of the batch to create:

{
    "documents": [
        {
            "template": "Banking_eng",
            "pages": ["file1.jpg", "file2.jpg"]
        },
        {
            "pages": ["file3.jpg", "file4.jpg"]
        }
    ]
}

The template field is optional and holds the name of one Document Definition in the batch type. The pages array holds the names of the files sent in the request, using the values from filename. FlexiCapture forms a document from those files.

Use one image to create several pages in different documents. This reduces the size of a request.

Add registration parameters

The same JSON can also describe registration parameters for the documents, the batch, or both:

{
    "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"}
            ]
        }
    ]
}

​Describe the batch structure

​Add registration parameters

Describe the batch structure

Add registration parameters