Forms

Get Widgets in a Layer

You can use this endpoint to fetch all widgets from a layer of the documents. The response will also contain details of the formField each widget is associated with, if it is associated with a form field.

get/api/documents/{documentId}/layers/{layerName}/form-field-widgets

Request

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

Path parameters

documentIdstring required

The document ID

layerNamestring required

The layer name

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.

Response

Document Engine returned the widgets on the specified layer of the document

Example response

{
  "data": [
    {
      "content": {
        "bbox": [
          255.10077620466092,
          656.7566095695641,
          145.91672653256705,
          18.390804597701162
        ],
        "action": {
          "relativePath": "/other_document.pdf"
        },
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
        "createdAt": "2019-09-16T15:05:03.712909Z",
        "updatedAt": "2019-09-16T15:05:03.712909Z",
        "customData": {
          "foo": "bar"
        },
        "formFieldName": "First-Name",
        "borderColor": "#ffffff",
        "font": "Helvetica",
        "fontSize": 10,
        "fontColor": "#ffffff",
        "backgroundColor": "#000000"
      },
      "formField": {
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
        "createdAt": "2019-09-16T15:05:03.712909Z",
        "updatedAt": "2019-09-16T15:05:03.712909Z",
        "content": {
          "id": "7KPSXX1NMNJ2WFDKN7BKQK9KZ",
          "name": "Form-Field",
          "label": "Form Field",
          "annotationIds": [
            "01DNEDPQQ22W49KDXRFPG4EPEQ",
            "7KPS6T4DKYN71VB7G5KBGB5R51"
          ],
          "flags": [
            "required"
          ]
        }
      }
    }
  ]
}

Changes

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