Question

How to add registration parameters via the AddNewBatch API call?

Answer

The registration parameters are set in the batch parameter of the AddNewBatch request. The format for the registration parameters in the batch should be the following.

"Properties": [
  {"Name": "test", "Value": "test"}
]

The request body example is shown below.

{
    "MethodName": "AddNewBatch",
    "Params": 
    {
        "sessionId": {{session_id}},
        "projectId": {{project_id}},
        "batch": {
            "Id": 1,
            "Name": "TestBatch",
            "BatchTypeId": {{batch_type_id}},
            "ProjectId": {{project_id}},
            "Properties": [ 
                {"Name": "test", "Value": "test"} 
            ],
            "Priority": 0,
            "Description": null,
            "HasAttachments": null,
            "CreationDate": null,
            "DocumentsCount": null,
            "PagesCount": null,
            "RecognizedSymbolsCount": null,
            "VerificationSymbolsCount": null,
            "UncertainSymbolsCount": null,
            "AssembledDocumentsCount": null,
            "RecognizedDocumentsCount": null,
            "VerifiedDocumentsCount": null,
            "ExportedDocumentsCount": null,
            "StageExternalId": null,
            "ErrorText": null,
            "OwnerId": null,
            "CreatorId": null,
            "SLAStartDate": null,
            "SLAExpirationDate": null,
            "ElapsedProcessingSeconds": null
        },
        "ownerId": null
    }
}

The successful request will return a batch id of a new batch as a response.

Additional information

AddNewBatch

Batch