Forms

Get a Form Field

Use this endpoint to get the form field with the specified ID from the document's default layer.

get/api/documents/{documentId}/form-fields/{formFieldId}

Request

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

Path parameters

documentIdstring required

The document ID

formFieldIdstring required

The ID of the form field

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 responded with the form field

idstring

An unique Instant JSON identifier of the record. Must be unique in a layer.

groupstring nullable

The resource group.

Group allows to grant access to resources via Collaboration Permissions.

createdBystring nullable

The user identifier.

Note that Nutrient Document Engine does not provide any kind of user management and accepts any string (or null) as a valid user ID.

For records created or updated in the browser, the user_id is extracted from the JSON Web Token (JWT) used for authentication.

updatedBystring nullable

The user identifier.

Note that Nutrient Document Engine does not provide any kind of user management and accepts any string (or null) as a valid user ID.

For records created or updated in the browser, the user_id is extracted from the JSON Web Token (JWT) used for authentication.

createdAtstring

Date and time in ISO8601 format with timezone.

updatedAtstring

Date and time in ISO8601 format with timezone.

Example response

{
  "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"
    ]
  },
  "widgetAnnotations": [
    {
      "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"
      }
    }
  ]
}

Changes

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