Fields Resource

This resource represents all fields in a PDF document.

DELETE /qoppapdf/v1/documents/{filePath}.pdf/fields

Reset all form fields.

Sample Request

DELETE http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
Response Body
media type data type description
application/json FieldsModel (JSON) The List of Fields.
application/xml Fields (XML)

GET /qoppapdf/v1/documents/{filePath}.pdf/fields

Get a list of Fields in the Document.

Sample Request

GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
Response Body
media type data type description
application/json FieldsModel (JSON) a List of Fields.
application/xml Fields (XML)

POST /qoppapdf/v1/documents/{filePath}.pdf/fields

This method has been deprecated. Use POST /qoppapdf/v1/documents/{filePath}.pdf/fields/content instead.

Import field values from an xfdf or fdf file. This endpoint will be removed in future versions, use /qoppapdf/v1/documents/{filePath}.pdf/fields/content instead.

The message body is an FDF or XFDF file.

Sample Request

 POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/content
 Content-Type: application/vnd.adobe.xfdf or application/vnd.fdf
 (xfdf or fdf file as message body)

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
content-type header application/vnd.adobe.xfdf
filePath path Path to the file to operate on. n/a
Request Body
media type data type description
application/vnd.adobe.xfdf (custom) The file to import.
application/vnd.fdf (custom)
Response Body
media type data type description
application/json FieldsModel (JSON) A List of Fields.
application/xml Fields (XML)

GET /qoppapdf/v1/documents/{filePath}.pdf/fields/content

Export Fields to XFDF (default) or FDF. By default the fields will be returned in the body of the response but can also be downloaded as an attachment.

Sample Request

GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/content?exportEmptyFields=true

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
accept header The desired response format. application/vnd.adobe.xfdf
filePath path Path to the file to operate on. n/a
attachment query Set to true to download the file as an attachment. false
exportEmptyFields query Flag to indicate whether empty or null fields should be exported. false
Response Body
media type data type description
application/vnd.adobe.xfdf (custom) The xfdf or fdf file.
application/vnd.fdf (custom)

POST /qoppapdf/v1/documents/{filePath}.pdf/fields/content

Import field values from an xfdf or fdf file.

The message body is an FDF or XFDF file.

Sample Request

 POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/content
 Content-Type: application/vnd.adobe.xfdf or application/vnd.fdf
 (xfdf or fdf file as message body)

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
content-type header application/vnd.adobe.xfdf
filePath path Path to the file to operate on. n/a
Request Body
media type data type description
application/vnd.adobe.xfdf (custom) The file to import.
application/vnd.fdf (custom)
Response Body
media type data type description
application/json FieldsModel (JSON) A List of Fields.
application/xml Fields (XML)