SPA PDF Overlays

SPA: Creates a new PDF overlay

Creates a new PDF overlay for document comparison.

POST/api/spa/pdf-overlays

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Request Body

application/json
required

The new PdfOverlay resource

{
  "name": "DIN A4 letterhead overlay",
  "fileName": "letterhead.pdf",
  "file": "string",
  "subClient": {},
  "subClientDefault": false
}

Response

201application/json

PdfOverlay resource created

id
integer

Identifier generated by Output.Rocks.

Example: 12345

name
stringrequired

Name of the PDF overlay.

Example: "DIN A4 letterhead overlay"

fileName
stringrequired

Original PDF file name.

Example: "letterhead.pdf"

file
value
createdBy
string

User, created this entry

Example: "user1@company.com"

updatedBy
string

User, updated this entry

Example: "user1@company.com"

createdAt
string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt
string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

subClientDefault
boolean

Default for environmental tenants (sub-clients)

Available options: truefalse

Example: false

subClientId
integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription
string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"