Creates and exports a batch.

POST {{baseUrl}}/session/batches?suppress_response_codes=in adipisicing

The Create and Export Batch operation is the last call required to create a batch and submit it to your backend server. First submit all image files to server, then you can use the returned file reference ids to reference files in the Batch nodal information. You can also use the same file reference ids returned by Real-Time service calls.

The batch name that you use to create a batch has to be unique when being imported into your backend server. To help you accomplish creating unique names you can supply for the batchName JSON property any Capture Services Format Expression function (see the Designer Documentation). There are also two additional format tokens you can use for providing unique names - {NextIndex} and {NextId}

{NextIndex} - This will provide a 64 bit integer number that is unique. Example: batchName:MyBatch_{NextIndex} produces on the server MyBatch_1026000000002

{NextId} - This will provide a valid Batch name string that is unique. Example: batchName:MyBatch_{NextId} produces on the server MyBatch3241

Any supported static function in the Capture Services Expression Language (see the Designer Documentation). []{[|]}[] - Using the expression language functions can allow the user of a GUID or unique time string to be a part of the Batch Name. Example: batchName:MyBatch_{Tddhhmmss|Now()}_{NextIndex} produces on the server, MyBatch090649341026000000003. Or batchName:MyBatch_{S|CreateGuid(0)} produces on the server, MyBatch_82fcd238-2fb7-44ac-9acc-a13ce406241d

Document type and UimData values in batch:

For composing export profile and exporting UimData values, Document type and UimData values must at batch level mentioned below with given names as below.

Batch – Level 7:

valueName = Profile

valueType = string

value = // Name of the profile.

Document – Level 1:

valueName = UimDocumentType

valueType = string

value = // This should be a string specifying the document type name.

valueName = UimData

valueType = uimdata

value = // This should be a UIM Data JSON Object

valueName = OutputFile

valueType = file

value = // File id for the original PDF to be available for export.

Page – Level 0:

valueName = OutputImage

valueType = file

value = // file id for the image to be exported

valueName = Backside

valueType = int

value = // 0 (front) or 1 (back) to indicate whether the image is a backside image.

Request Params

Request Body

{"captureFlow"=>"", "exportProfile"=>"", "batchName"=>"Batch_{NextId}", "batchRootLevel"=>3, "env"=>"D", "pdfGeneration"=>"None", "exportType"=>"AutoFormatLocal", "ftpConnection"=>"", "autoFormatExcludeImages"=>false, "dispatch"=>"S", "iAServerConnection"=>"", "nodes"=>[{"nodeId"=>1, "parentId"=>0}, {"nodeId"=>2, "parentId"=>1}, {"nodeId"=>3, "parentId"=>2}, {"nodeId"=>4, "parentId"=>2}, {"nodeId"=>5, "parentId"=>2}, {"nodeId"=>6, "parentId"=>2}, {"nodeId"=>7, "parentId"=>1}, {"nodeId"=>8, "parentId"=>7}, {"nodeId"=>9, "parentId"=>7}, {"nodeId"=>10, "parentId"=>7}, {"nodeId"=>11, "parentId"=>0}, {"nodeId"=>12, "parentId"=>11}, {"nodeId"=>13, "parentId"=>12}, {"nodeId"=>14, "parentId"=>12}, {"nodeId"=>15, "parentId"=>12}, {"nodeId"=>16, "parentId"=>12}, {"nodeId"=>17, "parentId"=>11}, {"nodeId"=>18, "parentId"=>17}, {"nodeId"=>19, "parentId"=>17}, {"nodeId"=>20, "parentId"=>17}], "values"=>[{"nodeId"=>1, "valueName"=>"BooleanFalse", "value"=>false, "valueType"=>"bool", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>1, "valueName"=>"FloatValue", "value"=>20002.2344, "valueType"=>"float", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>1, "valueName"=>"CurrentTime", "value"=>"2016-08-16T23:57:28.3956569Z", "valueType"=>"datetime", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>1, "valueName"=>"IntLevel", "value"=>3, "valueType"=>"int", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>1, "valueName"=>"DirectoryName", "value"=>"D:\\Temp\\BatchRoot\\Doc", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>2, "valueName"=>"BooleanTrue", "value"=>true, "valueType"=>"bool", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>2, "valueName"=>"FloatValue", "value"=>10002.2344, "valueType"=>"float", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>2, "valueName"=>"CurrentTime", "value"=>"2016-08-16T23:57:28.3956569Z", "valueType"=>"datetime", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>2, "valueName"=>"IntL54evel", "value"=>2, "valueType"=>"int", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>2, "valueName"=>"DirectoryName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\Pages", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>3, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\Pages\\AfterAnnotations.tif", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>3, "valueName"=>"OutputImage", "value"=>"F_83fe504ee8dd45a5ab726d76e55ebf0fDAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"tif"}, {"nodeId"=>4, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\Pages\\AnnotationsEIndex.tif", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>4, "valueName"=>"OutputImage", "value"=>"F_d486352f27b047e098388591cfb86d71DAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"tif"}, {"nodeId"=>5, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\Pages\\JPEG_24BitColor_ProgressiveJpeg-0001.jpg", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>5, "valueName"=>"OutputImage", "value"=>"F_63a204692bb34103966692a5cfe7e026DAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"jpg"}, {"nodeId"=>6, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\Pages\\JPEG_24BitColor_Sequential Jpeg-0001.jpg", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>6, "valueName"=>"OutputImage", "value"=>"F_ed397d5c08284795882e6e4eab7db97fDAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"jpg"}, {"nodeId"=>7, "valueName"=>"BooleanFalse", "value"=>false, "valueType"=>"bool", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>7, "valueName"=>"FloatValue", "value"=>10007.2344, "valueType"=>"float", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>7, "valueName"=>"CurrentTime", "value"=>"2016-08-16T23:57:28.6472619Z", "valueType"=>"datetime", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>7, "valueName"=>"IntLevel", "value"=>2, "valueType"=>"int", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>7, "valueName"=>"DirectoryName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\pages2", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>8, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\pages2\\NVC_JPEG_8Bit_Gray_Sequential Jpeg-0001.jpg", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>8, "valueName"=>"OutputImage", "value"=>"F_2cc8878d863c41c1b84b9b0fcb73c45fDAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"jpg"}, {"nodeId"=>9, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\pages2\\PNG_8bit_2color_transparent.png", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>9, "valueName"=>"OutputImage", "value"=>"F_944faeac690a462f920d3c4055815e4bDAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"png"}, {"nodeId"=>10, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc\\pages2\\TestUimBestBerryCompany.png", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>10, "valueName"=>"OutputImage", "value"=>"F_4cd72779dcf64257bb247542be90dbc9DAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"png"}, {"nodeId"=>11, "valueName"=>"BooleanFalse", "value"=>false, "valueType"=>"bool", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>11, "valueName"=>"FloatValue", "value"=>20022.2344, "valueType"=>"float", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>11, "valueName"=>"CurrentTime", "value"=>"2016-08-16T23:57:28.7252634Z", "valueType"=>"datetime", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>11, "valueName"=>"IntLevel", "value"=>3, "valueType"=>"int", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>11, "valueName"=>"DirectoryName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>12, "valueName"=>"BooleanTrue", "value"=>true, "valueType"=>"bool", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>12, "valueName"=>"FloatValue", "value"=>10012.2344, "valueType"=>"float", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>12, "valueName"=>"CurrentTime", "value"=>"2016-08-16T23:57:28.7252634Z", "valueType"=>"datetime", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>12, "valueName"=>"IntLevel", "value"=>2, "valueType"=>"int", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>12, "valueName"=>"DirectoryName55", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\Pages", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>13, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\Pages\\AfterAnnotations.tif", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>13, "valueName"=>"OutputImage", "value"=>"F_5c1387eb0db649ba986eb79c0da24060DAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"tif"}, {"nodeId"=>14, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\Pages\\AnnotationsEIndex.tif", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>14, "valueName"=>"OutputImage", "value"=>"F_d48cd08875ba4634b83aa8c4b3679351DAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"tif"}, {"nodeId"=>15, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\Pages\\JPEG_24BitColor_ProgressiveJpeg-0001.jpg", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>15, "valueName"=>"OutputImage", "value"=>"F_967cf342b1034596bffce852785a8301DAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"jpg"}, {"nodeId"=>16, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\Pages\\JPEG_24BitColor_Sequential Jpeg-0001.jpg", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>16, "valueName"=>"OutputImage", "value"=>"F_11fc88e5e3c24f8fb740dec20273b730DAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"jpg"}, {"nodeId"=>17, "valueName"=>"BooleanFalse", "value"=>false, "valueType"=>"bool", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>17, "valueName"=>"FloatValue", "value"=>10017.2344, "valueType"=>"float", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>17, "valueName"=>"CurrentTime", "value"=>"2016-08-16T23:57:28.9436676Z", "valueType"=>"datetime", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>17, "valueName"=>"IntLevel", "value"=>2, "valueType"=>"int", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>17, "valueName"=>"DirectoryName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\pages2", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>18, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\pages2\\NVC_JPEG_8Bit_Gray_Sequential Jpeg-0001.jpg", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>18, "valueName"=>"OutputImage", "value"=>"F_e81be699a67d4c4ebfb49408fc97c948DAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"jpg"}, {"nodeId"=>19, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\pages2\\PNG_8bit_2color_transparent.png", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>19, "valueName"=>"OutputImage", "value"=>"F_8fb7378bc6994095abdf7336a9dca3ddDAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"png"}, {"nodeId"=>20, "valueName"=>"FileName", "value"=>"D:\\Temp\\BatchRoot\\Doc 1\\pages2\\TestUimBestBerryCompany.png", "valueType"=>"string", "offset"=>0, "fileExtension"=>nil}, {"nodeId"=>20, "valueName"=>"OutputImage", "value"=>"F_338acd1e28ab4f98bc7df0b94fa9d6edDAT", "valueType"=>"file", "offset"=>0, "fileExtension"=>"png"}]}

HEADERS

RESPONSES

status: Created

{"returnStatus":{"status":201,"code":"OK0000","message":"","server":"WS-S9d85aaf9fd134654be88edc11906fd53IS"},"id":"https://{host}/cp-rest/v2/session/batches/B3K5_2SU3K4_1_pBiPrO","title":"Batch_3K5_11","updated":"2016-08-24T22:16:07.5331714Z","_links":{"self":{"href":"https://{host}/cp-rest/v2/session/batches/B3K5_2SU3K4_1_pBiPrO"}},"content":{"id":"B3K5_2SU3K4_1_pBiPrO","batchName":"Batch_3K5_11","status":"S","serverBatchId":"","captureFlow":"","batchRootLevel":3,"batchPriority":50,"lastUpdate":"2016-08-24T22:16:07.5331714Z","lastError":"","localExportFileId":"https://{host}/cp-rest/v2/session/files/Batch_3K5_11.zip"}}