Forms

Create Form Fields

This endpoint allows you to add a new form field to the document's default layer.

The id of each form field is optional, and will be generated by Document Engine if not provided. The user_id is set as the creator of the form field. The group of the form field will be inherited by the widgets and values associated with it.

post/api/documents/{documentId}/form-fields

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/form-fields
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

Headers

pspdfkit-pdf-passwordstring

The PDF document password.

The value can be either a plain-text password or a base64 encoded password in a form base64:<encoded-password>. Use the Base64 encoding if your password contains characters that are not allowed in HTTP header or would be otherwise mangled (e.g. trailing or leading spaces)

If the document is password protected, any operations performed on it require supplying a password.

Request body

Example request

{
  "formFields": [
    {
      "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
      "content": {
        "id": "7KPSXX1NMNJ2WFDKN7BKQK9KZ",
        "name": "Form-Field",
        "label": "Form Field",
        "annotationIds": [
          "01DNEDPQQ22W49KDXRFPG4EPEQ",
          "7KPS6T4DKYN71VB7G5KBGB5R51"
        ],
        "flags": [
          "required"
        ]
      }
    }
  ]
}

Response

The form fields have been added to the document.

detailsstring

A text summary of the status of the request

request_idstring
result'partial_failure' | 'success' | 'failure'

If all the items in the batch request were successful, then the status will be a success. A partial_failure will occur if only a few of the items in the batch request succeeded. Failure is when none of the items in the batch succeed.

status200 | 400 | 500

HTTP status code for the request. The status code is 200 if the request was processed. This does not have anything to do with the result - the status code will be 200 even if part of the request failed. In the case of total failures such as malformed JSON, or document not found, this status will be other than 200.

Example response

{
  "details": "Operation was partially successful",
  "failingPaths": [
    {
      "path": "$.property[0]",
      "details": "Missing required property"
    }
  ],
  "data": [
    {
      "id": "01DNEDPQQ22W49KDXRFPG4EPEQ"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.