Skip to main content
Version: 2.3.0

Create batch process

Updated date: 09/01/2025
Updated by: VNPT eContract's team

Purpose​

The function creates a new batch of documents from individual documents, aiming to facilitate batch processing operations from the Batch process document API

  • Request URL: /api/documents/create-batch-process
  • HTTP method: POST
  • HTTP content-type: application/json
  • Authorize: Bearer token
  • Parameter:
KeyTypeDescription
documentIdsArray[string][Required] Array of many Document Id
accessPermissionCodestring[Required] Access permissions
tip

accessPermissionCode is access permissions:

  • V is view only
  • D is digital sign (supported)
  • E is e-sign (supported)
  • EKYC is eKYC sign
  • DR is sign draw (supported)
  • A is approve (supported)
  • F is fill data
  • C is coordinate

Sample request​

{
    "documentIds": [
        "f184943f-e394-42e8-98b3-1e3d178ee62c",
        "9c7a4764-2b4b-4169-8be8-d528491af0cb"
    ],
    "accessPermissionCode": "DR"
}

Sample response body​

{
    "data": {
        "id": "673c0f4f-8744-4cf7-1061-08dc9a457201",
        "comId": 2211,
        "processes": [
            {
                "id": "2d446004-f560-40ba-3d78-08dc837a4c87",
                "createdDate": "2024-06-03T13:41:58.6093432",
                "comId": 2211,
                "isOrder": true,
                "orderNo": 1,
                "pageSign": 2,
                "position": "414,624,520,676",
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 2,
                    "description": "Sign draw"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 6199,
                "documentId": "f184943f-e394-42e8-98b3-1e3d178ee62c",
                "fillingItems": []
            },
            {
                "id": "c843fdf2-d2a3-405b-3ca6-08dc837a4c87",
                "createdDate": "2024-06-03T10:11:56.8206304",
                "comId": 2211,
                "isOrder": true,
                "orderNo": 1,
                "pageSign": 1,
                "position": "414,78,520,130",
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 2,
                    "description": "Sign draw"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 6199,
                "documentId": "9c7a4764-2b4b-4169-8be8-d528491af0cb",
                "fillingItems": []
            }
        ],
        "accessPermission": {
            "value": 2,
            "description": "Sign draw"
        },
        "status": {
            "value": 1,
            "description": "New"
        }
    },
    "success": true,
    "code": 0,
    "messages": [
        "Create batch process successfully"
    ]
}