PdfForm

The form of a PDF, whose fields /pdf/fill takes by these names.

typestringnullablerequired

acroform for an ordinary form, hybrid for an AcroForm with an XFA part, xfa for a form only XFA viewers fill (which /pdf/fill refuses), null for a PDF without a form.

Possible values: [acroform, hybrid, xfa]

signedbooleanrequired

A signature field holds a signature, or the form says signatures exist; /pdf/fill refuses such a file.

fields object[]required

Array [

namestringrequired

The full name, parts joined by dots.

labelstringnullablerequired

What the field is for, from its tooltip; null when it has none.

typestringrequired

Possible values: [text, checkbox, radio, dropdown, listbox, signature, button]

value objectnullablerequired

Text for a text field and a dropdown, a boolean for a check box with one on-value, an export value for a radio group and a check box with several on-values, a list for a list box; null when unset.

oneOf

• string
• boolean
• string[]

string

optionsstring[]nullablerequired

A choice's options, a radio group's export values, a check box's on-values when it has several: what /pdf/fill takes.

requiredbooleanrequired

readonlybooleanrequired

calculatedbooleanrequired

Its value comes from a calculation a viewer runs, which filling does not.

formatstringnullablerequired

The display format a viewer applies, such as AFNumber_Format(2, 2, 0, 0, " €", false); filling does not apply it.

pagesinteger[]required

Every page with a widget of the field.

]

PdfForm

{
  "type": "acroform",
  "signed": true,
  "fields": [
    {
      "name": "string",
      "label": "string",
      "type": "text",
      "value": "string",
      "options": [
        "string"
      ],
      "required": true,
      "readonly": true,
      "calculated": true,
      "format": "string",
      "pages": [
        0
      ]
    }
  ]
}