Submit Batch PDF Request

Creates a new batch PDF generation job.

Endpoint: POST /pdf

Content-Type: application/json

 /pdf endpoint description
Description Creates a batch generation job to consolidate PDFs in Unified Command Platform
URL /pdf
Method POST
Parameters

  • items

  • headerfootertextalign

  • headertext

  • headerhtml

  • footertext

  • footerhtml

  • footerfontsize

  • headerfontsize

  • headerfloaty

  • footerfloaty

  • headerfloatx

  • footerfloatx

  • filename

Review the parameter definitions and examples of how to use the processpermission endpoint in JavaScript and C# calls.

Request Parameters - BatchPdfRequest Object
Field Type Required Description
items                      array      YES         Array of PDF items to include in the batch.
headerfootertextalign     string     No          Text alignment for headers and footers.
headertext                 string     No          Plain text to display in the header.
headerhtml                 string     No         

HTML content for the header (overrides headertext).
footertext                 string     No         

Plain text to display in the footer.
footerhtml string     No  

HTML content for the footer (overrides footertext).
footerfontsize             float      No          Font size for footer text.
headerfontsize             float     No         Font size for header text.
headerfloaty               float     No         Vertical offset for header positioning.
footerfloaty               float     No         Vertical offset for footer positioning.
headerfloatx               float     No         Horizontal offset for header positioning.
footerfloatx               float     No         Horizontal offset for footer positioning.
filename                   string No         File name for the generated PDF.
 

Header and footer settings for both text and HTML support the _currentpage and _pagecount variables.

Request Parameters - BatchPdfItem Object
Field Type Required Default Description

boardname 

 string     YES         -        

Name of the WebEOC board.
viewname string YES         -         Name of the view to render.
pagenumber                   integer     No         0         Page number for multi-page views.
dataid                       integer     No         -         Specific data record ID to render.
viewfilter                   string     No         -         Filter to apply to the view.
enablejs                     boolean     No         true       Enable JavaScript execution.
orientation                   string     No         portrait       Page orientation (portrait/landscape).
enablemediaquery             boolean     No         true       Enable CSS media queries.
manual                       boolean     No         false     Manual processing flag.
attachments-fields array No     -         Attachment field names to include.
child-attachments-fields array No         -         Child record attachment field names.
child-attachments-table array       No         -         Child tables for attachments.
viewerheight                 string     No         -         Height of PDF viewer viewport.
viewerwidth                   string     No         -         Width of PDF viewer viewport.
fitheight                     boolean     No         false     Fit content to page height.
fitwidth                     boolean     No         false     Fit content to page width.
optimizememory               boolean     No         false     Enable memory optimization.
conversiondelay               string     No 0    Delay before PDF conversion (ms).

 

Examples

Request Body

Copy Code 
{
  "items": [
    {
      "boardname": "string",
      "viewname": "string",
      "pagenumber": 0,
      "dataid": 0,
      "viewfilter": "string",
      "enablejs": true,
      "orientation": "string",
      "enablemediaquery": true,
      "manual": false,
      "attachments-fields": ["string"],
      "child-attachments-fields": ["string"],
      "child-attachments-table": ["string"],
      "viewerheight": "string",
      "viewerwidth": "string",
      "fitheight": false,
      "fitwidth": false,
      "optimizememory": false,
      "conversiondelay": "string"
    }
  ],
  "headerfootertextalign": "string",
  "headertext": "string",
  "headerhtml": "string",
  "footertext": "string",
  "footerhtml": "string",
  "footerfontsize": 0,
  "headerfontsize": 0,
  "headerfloaty": 0,
  "footerfloaty": 0,
  "headerfloatx": 0,
  "footerfloatx": 0,
  "filename": "string"
}

Response:

Copy Code 
Status Code: 200 OK

{
  "batchPdfId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Path Parameters
Field Type Description
batchPdfId GUID Unique identifier for the batch job.

Response:

Copy Code 
Status Code: 200 OK

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdTs": "2025-11-21T10:30:00Z",
  "completedTs": "2025-11-21T10:32:15Z",
  "waiting": 0,
  "inProcess": 0,
  "completed": 5,
  "errors": 0,
  "total": 5
}