| AdminApplicationCheck |
Selects the \"application.xml\" contents and server resources, that shall be validated
|
| AdminApplicationConfiguration |
Defines settings for the server´s \"application.xml\".
|
| AdminBackgroundFileDataStore |
Defines a file that is used as background in the portal and is stored in the server's data store.
|
| AdminConfiguration |
Defines settings that reflect and can be used to manipulate and validate the state of the different server configuration files and resources.
|
| AdminConfigurationResult |
Defines an extended result object for administrative configuration operations when the configuration is updated.
|
| AdminConnectorKeyStore |
Lists all contents of the keystore (e.g. it´s certificates and raw data), that shall be used by theserver´s secured SSL connectors.
|
| AdminConnectorServerCheck |
Validates the configured connectors of the webPDF server, by checking whether or not they are responsive.
|
| AdminErrorCountServerState |
Stores statistic information about the number of occurred errors
|
| AdminExecutableApplicationCheck |
Checks if the selected external applications are found and can be executed by the server if required.
|
| AdminExecutableResult |
The result of a used executable application.
|
| AdminExecutableStatus |
Provides status information about the server´s used external applications.
|
| AdminFileDataStore |
Defines a structure, that lists the different grouped files from the server´s file data storage.
|
| AdminGenericFileDataStore |
Defines a generic data storage file, possibly a temporary file, without a predefined group or purpose and a customizable file name.
|
| AdminGlobalKeyStore |
Lists all contents of the keystore (e.g. it´s certificates and raw data), that shall be set as the server´s global user certificate keystore
|
| AdminJavaStatus |
Provides information about the used Java virtual machine and it´sexecution context.
|
| AdminJavaStatusContainer |
Information about the container plattform.
|
| AdminJavaStatusGC |
A single GC entry with the execution values.
|
| AdminJavaStatusOsDistro |
Information about the OS distribution.
|
| AdminJobServerState |
Stores statistic information about the executed jobs.
|
| AdminLicenseApplicationCheck |
Validates the configured webPDF server license and whether it matches the given server.
|
| AdminLogCheck |
Selects the \"log4j2.xml\" contents and server resources, that shall be validated.
|
| AdminLogConfiguration |
Defines settings for the server´s \"log4j2.xml\".
|
| AdminLogFileConfiguration |
Provides information and settings about the configured server logging.
|
| AdminLogoFileDataStore |
Defines a file that is used as a logo in the portal and is stored in the server's data store.
|
| AdminPoolEntryServerState |
AdminPoolEntryServerState
|
| AdminPoolServerState |
Stores statistic information about the instances
|
| AdminServerCheck |
Selects the \"server.xml\" contents and server resources, that shall be validated
|
| AdminServerConfiguration |
Defines settings for the server´s \"server.xml\".
|
| AdminServerState |
Stores statistic information about a server instance and the executed jobs
|
| AdminServerStatus |
Provides information about the status of the server, the JVM and the Web services
|
| AdminServerVersionInfo |
Provides the server´s license and version information
|
| AdminSignatureApplicationCheck |
Checks whether the server´s global keystore is present, accessible and could be used by webservices.
|
| AdminStatistic |
AdminStatistic
|
| AdminThemeFileDataStore |
Defines a CSS file that is used as a theme in the portal and is stored in the server's data store.
|
| AdminTimeEntryServerState |
AdminTimeEntryServerState
|
| AdminTimeFrameServerState |
AdminTimeFrameServerState
|
| AdminTrustStoreKeyStore |
Lists all contents of the keystore (e.g. it´s certificates and raw data), that shall be set as the server´s truststore.
|
| AdminTrustStoreServerCheck |
Validates the configured truststore, by attempting to access it.
|
| AdminTsaApplicationCheck |
Validates the configured TSA (Timestamp Authority), by attempting to request a valid timestamp.
|
| AdminUserCheck |
Selects the \"users.xml\" contents and server resources, that shall be validated.
|
| AdminUserConfiguration |
Defines settings for the server´s \"users.xml\".
|
| AdminUserServerCheck |
Validates the configured user storage (database, ldap or xml), by attempting to access it.
|
| AdminWebservices |
Provides status information about the Web services
|
| AdminWebserviceStatus |
Provides information about the status and availability of a webservice.
|
| ApplicationConfigApplication |
The application element defines settings for the web services and the portal page.
|
| ApplicationConfigBarcodeWebservice |
Defines a set of options specific for the \"Barcode\" web service.
|
| ApplicationConfigBridgesApplication |
The bridges element defines settings for the bridges (to other applications) used by the server.
|
| ApplicationConfigChromiumBridge |
Defines the settings for the Chromium bridge.
|
| ApplicationConfigChromiumBridgeCommandLine |
Allows you to define a list of command line switches that will be passed to the Chromium process.
|
| ApplicationConfigChromiumBridgeCommandLineSwitch |
Defines a single command line switch for the Chromium process.
|
| ApplicationConfigCompressPortalSettings |
ApplicationConfigCompressPortalSettings
|
| ApplicationConfigConverterWebservice |
Defines a set of options specific for the \"Converter\" web service.
|
| ApplicationConfigKeystore |
Defines settings for the global keystore used by the server.
|
| ApplicationConfigKeystoreEntry |
Defines information about one entry of a keystore.
|
| ApplicationConfigLicense |
Defines the license to be used for the server.
|
| ApplicationConfigNewsPanel |
Defines whether the portal displays a news page and where the content is loaded from.
|
| ApplicationConfigNewsPanelEntry |
Defines a source for the entries in the \"news panel\" of the portal page\".
|
| ApplicationConfigOcrWebservice |
Defines a set of options specific for the \"OCR\" web service.
|
| ApplicationConfigOfficeBridge |
Defines the settings for the MS Office Bridge.
|
| ApplicationConfigOfficeBridgeApp |
Defines settings specific for the MS Visio application in the office bridge.
|
| ApplicationConfigPdfaWebservice |
Defines a set of options specific for the \"PDFA\" web service.
|
| ApplicationConfigPortal |
The portal element defines settings for the portal page of the server.
|
| ApplicationConfigPortalAuth |
Defines which settings apply for authentication to the portal.
|
| ApplicationConfigPortalAuthTimeout |
Defines the timeout settings related to authentication and session.
|
| ApplicationConfigPortalFunctions |
Defines which portal functions are enabled or disabled.
|
| ApplicationConfigPortalSettings |
Defines global settings for the web service calls made from the portal page.
|
| ApplicationConfigPortalUserInterface |
Defines settings for the user interface of the portal.
|
| ApplicationConfigPortalUserInterfaceLimits |
ApplicationConfigPortalUserInterfaceLimits
|
| ApplicationConfigPortalUserInterfaceTooltips |
ApplicationConfigPortalUserInterfaceTooltips
|
| ApplicationConfigProxiesApplication |
Defines proxy servers that shall be known to and used by the server to access external resources.
|
| ApplicationConfigProxy |
Defines a proxy server that shall be known to and used by the server to access external resources.
|
| ApplicationConfigProxyNonHost |
This setting is currently unused.
|
| ApplicationConfigSharePointBridge |
Defines the settings for the MS SharePoint Bridge.
|
| ApplicationConfigSignaturePortalSettings |
ApplicationConfigSignaturePortalSettings
|
| ApplicationConfigSignatureWebservice |
Defines a set of options specific for the \"Signature\" web service.
|
| ApplicationConfigToolboxWebservice |
Defines a set of options specific for the \"Toolbox\" web service.
|
| ApplicationConfigTsa |
Defines a TSA (Time Stamp Authority which supports [RFC3161](https://www.ietf.org/rfc/rfc3161.txt)) that shall be used by the server.
|
| ApplicationConfigUrlConverterWebservice |
Defines a set of options specific for the \"URL Converter\" web service.
|
| ApplicationConfigWebservicesApplication |
The web services element defines settings for the web service endpoints.
|
| AuthAnonymousLimits |
Document limits for the anonymous user
|
| AuthLimits |
Limits for the user
|
| AuthLoginOptions |
Options for user authentication at logon
|
| AuthProvider |
Defines a general authorization provider
|
| AuthSessionToken |
Session token
|
| AuthUserCertificates |
Contains the list of certificates and keystores available for the user in the current session.
|
| AuthUserCredentials |
Returns details about a user in a session
|
| AuthUserLimits |
Document limits for the authenticated user
|
| CertificateEntry |
An actual X509 certificate entry.
|
| DocumentFile |
Contains the file information about a document in the document storage
|
| DocumentFileCompress |
Contains the instructions for creating the new archive document and the documents to be added to the archive.
|
| DocumentFileExtract |
Contains the instructions when an archive is to be extracted in the document storage.
|
| DocumentFileFilter |
Defines a file filter with a list of \"include\" and \"exclude\" filter rules.
|
| DocumentFileFilterRule |
Defines a single filter rule for a file filter.
|
| DocumentHistoryEntry |
A document history entry wrapping one manipulation state of a document.
|
| DocumentInfo |
Provides various information for the underlying document
|
| DocumentInfoForm |
Provides form information for the PDF document
|
| DocumentInfoFormField |
Provides field information for a single field in the form of the PDF document
|
| DocumentInfoFormXfaField |
Additional field information for a XFA field
|
| DocumentPassword |
Contains password information if it is a PDF document
|
| DocumentRecipient |
Contains recipient information
|
| KeyStoreEntry |
A user keystore entry
|
| KeyStorePassword |
Stores the password for a keystore and all passwords for accessing private keys in the keystore.
|
| MetadataAnnotation |
An element of this type describes an Annotation placed on a page of the document.
|
| MetadataAnnotationPoint |
MetadataAnnotationPoint
|
| MetadataAnnotationPointPoint |
Defines one Point of the shape positioning the annotation on the page.
|
| MetadataAnnotationRectangle |
MetadataAnnotationRectangle
|
| MetadataAnnotationRectangleRectangle |
An upright rectangle positioning the annotation on the page.
|
| MetadataAnnotationsDocument |
Lists the annotations, that have been found in the document.
|
| MetadataAttachment |
This type is used to describe an attachment, that has been embedded in a PDF file.
|
| MetadataAttachmentsDocument |
Lists the attachments embedded into this document.
|
| MetadataAuthor |
An element of this type is used to enumerate the persons, that created a document.
|
| MetadataBackgroundContent |
An element of this type defines a background for a page of the document.
|
| MetadataBackgroundsDocument |
Lists the background definitions for pages of the document.
|
| MetadataBorderStyle |
Selects a border style for a drawn shape's outline.
|
| MetadataBoxes |
This type is used to describe the boxes of a page.
|
| MetadataCommentRelation |
Adds a textual comment to the selected annotation.
|
| MetadataCustomDescription |
An element of this type defines some custom attribute to be listed in the document's metadata.
|
| MetadataDescription |
The document's description contains a number of metadata attributes, that further describe the author, creation, contents etc of the document.
|
| MetadataDocument |
A document element that describes the content and properties of the PDF document as metadata.
|
| MetadataDrawStyle |
Selects the draw style of an drawable shape.
|
| MetadataField |
Lists the properties of a PDF form field.
|
| MetadataFolder |
Defines a folder for a PDF collection (portfolio).
|
| MetadataFoldersDocument |
Lists the folders contained in a PDF collection (portfolio), that are used to structure the embedded attachments.
|
| MetadataFont |
Defines a font format for a displayable page content.
|
| MetadataFooterHeaderFooter |
Selects the values for a page footer.
|
| MetadataFormDocument |
Describes the properties of the document's form.
|
| MetadataFormValueStyle |
Selects parameters for the handling of a form fields values.
|
| MetadataGroupRelation |
Group with the selected annotation.
|
| MetadataHeaderFooter |
An element of this type defines header and footer values for a page of the document.
|
| MetadataHeaderHeaderFooter |
Selects the values for a page header.
|
| MetadataHeadersFootersDocument |
Lists the header/footer definitions for pages of the document.
|
| MetadataImage |
Defines an image resource of a PDF document.
|
| MetadataImagesDocument |
Lists the image resources used in the document.
|
| MetadataInformation |
Summarizes structural information and settings for the PDF document.
|
| MetadataKeyword |
An element of this type defines a keyword the document can be associated with.
|
| MetadataLine |
Defines a set of attributes for Line annotations.
|
| MetadataMargin |
Defines a margin for a displayble page content.
|
| MetadataMarkRelation |
Change the marked state of the selected annotation.
|
| MetadataMarkup |
Defines a set of attributes for text markup annotations.
|
| MetadataPagePages |
MetadataPagePages
|
| MetadataPagesDocument |
Lists and describes the properties of the document's pages.
|
| MetadataPassword |
An element of this type shall contain information concerning the used encryption and the used encryption key.
|
| MetadataPdfa |
The PDF/A standard the document claims to be conforming to.
|
| MetadataPieceInfoBackgroundContent |
Properties listed in the Adobe piece info.
|
| MetadataPopup |
Defines a set of attributes concerning the annotation's popup.
|
| MetadataPositions |
Used to define some sort of position on a PDF page.
|
| MetadataRectangle |
Defines a rectangular area/box.
|
| MetadataRelationMarkup |
Selects the relation of this annotation to other annotations.
|
| MetadataReplyStateRelation |
Changes the reply state of the selected annotation.
|
| MetadataSecurity |
An element of this type shall contain information concerning the security settings, manipulation protection and used password of a PDF document.
|
| MetadataSignature |
An element of this type represents the properties of a signature.
|
| MetadataSignaturesDocument |
Lists a document's signatures.
|
| MetadataTransition |
Defines a page transition for the full screen mode of the document.
|
| MetadataTransitionsDocument |
Lists the page transitions for the full screen mode of the document.
|
| MetadataViewerPreferences |
Lists a set of further settings and definitions, that a Reader may honor, when displaying the document.
|
| OAuthOIDCMetadata |
OpenID configuration provider metadata
|
| OperationActionEvent |
A common base type for action events, that shall be triggered by selecting the outline entry.
|
| OperationAddBackground |
Adds a background image or a solid colour background layer to the document (the \"colorBackground\" and \"imageBackground\" elements are mutually exclusive, i.e., you must select one or the other).
|
| OperationAddBarcode |
Used to add a new barcode to the document.
|
| OperationAddComment |
Used to add comments to existing annotations.
|
| OperationAddHeaderFooter |
Adds a header and footer to the document .
|
| OperationAddPageTransitions |
OperationAddPageTransitions
|
| OperationAddSignature |
Used to add a new signature to the PDF document.
|
| OperationAddToolboxAnnotation |
The add element can be used to define one or multiple annotations, that shall be added to the document.
|
| OperationAddToolboxAttachment |
Used to add an attachment to the document.
|
| OperationAddToolboxOutline |
Can be used to add entries to the content structure of a PDF document (its bookmarks/outline).
|
| OperationAnalyzePdfa |
Used to define the parameters for the PDF/A conversion.
|
| OperationAnnotationSelection |
The annotation element can be used to select document annotations that should be modified.
|
| OperationAppearanceAdd |
Used to define the signature's visual appearance.
|
| OperationAppearanceFileData |
Used to define a resource as the source for an annotation's appearance generation.
|
| OperationAppearanceImage |
Used to define an image resource for an annotation's appearance generation.
|
| OperationAppearancePdf |
Used to define a PDF page as the resource for an annotation's appearance generation.
|
| OperationAppearanceSource |
Used to set the data source for the visible appearance of an annotation.
|
| OperationAppearanceSvg |
Used to define a svg resource for an annotation's appearance generation.
|
| OperationAttachmentFileData |
Contains the file to be attached in \"Base64 encoded\" format.
|
| OperationAztecBarcode |
A aztec barcode.
|
| OperationBackgroundBaseSettings |
Defines basic configuration settings for generating background layers.
|
| OperationBackgroundFileData |
Used to define an image for generating a background.
|
| OperationBackgroundToolboxOptions |
Adds a background layer to the document or removes it (the \"add\" and \"remove\" elements are mutually exclusive, i.e., you must select one or the other).
|
| OperationBarcode |
The \"Barcode\" web service can be used to generate and recognize barcodes in PDF documents.
|
| OperationBarcodeOperation |
OperationBarcodeOperation
|
| OperationBarcodeSelection |
This section is used to control the recognition process and configure settings that apply only to specific barcode types.
|
| OperationBaseToolbox |
The base type for all Toolbox webservice operations.
|
| OperationBilling |
The `billing` element can be used to affect the values that are written to the server's statistics logs (called \"billing logs\") for the web service call.
|
| OperationBlacken |
If this element is set, all redact annotations placed in the document will be converted into actual content redactions.
|
| OperationBmp |
Defines a target BMP image format.
|
| OperationBorder |
Defines a border for a rendered geometrical element.
|
| OperationBoxesResize |
Used to change the dimensions of a specific box in a specific page range in the document.
|
| OperationBoxesToolboxOptions |
Can be used to modify the document's boxes.
|
| OperationCertificateFileData |
Allows the transfer of a certificate (as a PEM file), for the en-/decryption of an asymmetrically encrypted document.
|
| OperationCircleAnnotation |
An annotation that draws a circle on a page.
|
| OperationClearSignature |
Used to remove all existing signatures from the PDF document.
|
| OperationClearToolboxAnnotation |
Used to remove the annotations of the selected pages.
|
| OperationCodabarBarcode |
A Codabar barcode.
|
| OperationCode128Barcode |
A Code128 barcode.
|
| OperationCode39Barcode |
A Code39 barcode.
|
| OperationColorBackground |
Adds a solid-color background layer to the document.
|
| OperationCommentToolboxAnnotation |
Used to add/edit comment/replies to and of existing annotations.
|
| OperationCompressObjects |
Combines object definitions of the document into so-called \"object streams\" and compresses them.
|
| OperationCompressSettings |
The `compress` element can be used to automatically compress the contents of the PDF document when saving it.
|
| OperationConverter |
Performs the conversion of a document.
|
| OperationConverterFooter |
Defines the content that will be used as a footer.
|
| OperationConverterHeader |
Defines the content that will be used as a header.
|
| OperationConverterHtml |
These settings are only used for HTML (e.g. websites) and HTML-based documents (e.g. e-mails).
|
| OperationConverterImage |
The settings are used when converting images if the source file is an image.
|
| OperationConverterMail |
These settings are only used for e-mail documents.
|
| OperationConverterOperation |
OperationConverterOperation
|
| OperationConverterPage |
Sets the page size, margins, and headers and footers for the converted document in the PDF document.
|
| OperationConverterReport |
Can be used to enable expanded error reporting for text-based documents (e.g., Word).
|
| OperationConverterTemplate |
Can be used to define settings for file formats for which a template is required for conversion.
|
| OperationConverterText |
The settings are used in purely text-based files that can contain source code that would make syntax highlighting advisable.
|
| OperationConverterTransform |
This element defines a set of transformations to be applied to the document before further converter operations are performed.
|
| OperationConvertPdfa |
Used to convert a PDF document to PDF/A.
|
| OperationDataMatrixBarcode |
A DataMatrix barcode.
|
| OperationDescriptionCustom |
If you add another (optional) `<custom
|
| OperationDestinationEvent |
A common base type for destination events, that shall target some location or content of the document.
|
| OperationDetectBarcode |
This operation is used to define the barcode recognition parameters.
|
| OperationDimensionsBoxesResize |
Used to define the position and dimensions of a containing element.
|
| OperationEan13Barcode |
An EAN13 barcode.
|
| OperationEan8Barcode |
An EAN8 barcode.
|
| OperationEditComment |
Used to edit existing comments.
|
| OperationEditToolboxAnnotation |
Used to change properties of selected, already existing annotations.
|
| OperationEncrypt |
These parameters can be used to set encryption for a PDF document.
|
| OperationEncryptCertificate |
These parameters can be used to set the asymmetric encryption of a PDF document.
|
| OperationExtractionImages |
Extract the PDF document's image contents Generates a ZIP file that is returned as a result when the web service is called.
|
| OperationExtractionInfo |
Extract general and structure information about the PDF document Generates an XML or JSON file that will be returned as a result when the web service is called.
|
| OperationExtractionLinks |
Extract links from thePDF document Generates an ASCII text, XML, or JSON file that will be returned as a result when the web service is called and that will contain all selected supported links in the PDF document.
|
| OperationExtractionParagraphs |
Extract text content of the PDF document, separated by paragraphs Generates an ASCII text, XML, or JSON file that will be returned as a result when the web service is called and that will contain all texts in the PDF document separated by paragraphs.
|
| OperationExtractionText |
Extract the PDF document's text content.
|
| OperationExtractionWords |
Extract all the words from the PDF document, with page and position information.
|
| OperationExtractToolboxAttachment |
Used to extract one or more attachments from the document.
|
| OperationFileAnnotation |
Used to define the annotation element that should be linked to the file attachment.
|
| OperationFileAttachment |
Used to define an individual file attachment that should be added to the PDF document.
|
| OperationFileSpecification |
Used to specify the location and additional parameters for running an application or opening a document.
|
| OperationFitBoundingBoxDestination |
OperationFitBoundingBoxDestination
|
| OperationFitBoundingBoxDestinationFitBoundingBox |
The fitBoundingBox element is used to specify a location within the document.
|
| OperationFitBoundingBoxWidthDestination |
OperationFitBoundingBoxWidthDestination
|
| OperationFitBoundingBoxWidthDestinationFitBoundingBoxWidth |
The fitBoundingBoxWidth element is used to specify a location within the document.
|
| OperationFitHeightDestination |
OperationFitHeightDestination
|
| OperationFitHeightDestinationFitHeight |
The fitHeight element is used to specify a location within the document.
|
| OperationFitPageDestination |
OperationFitPageDestination
|
| OperationFitPageDestinationFitPage |
The fitPage element is used to specify a location within the document.
|
| OperationFitRectangleDestination |
OperationFitRectangleDestination
|
| OperationFitRectangleDestinationFitRectangle |
The fitRectangle element is used to specify a location within the document.
|
| OperationFitWidthDestination |
OperationFitWidthDestination
|
| OperationFitWidthDestinationFitWidth |
The fitWidth element is used to specify a location within the document.
|
| OperationFormFieldSelection |
Selects a form field.
|
| OperationFormsExport |
Used to export data from the form fields.
|
| OperationFormsFileData |
Selects a source for form data.
|
| OperationFormsImport |
Used to import data into the form fields.
|
| OperationFreeTextAnnotation |
An annotation that adds a textual comment directly to a page.
|
| OperationFreeTextFont |
A font definition for textual annotation types.
|
| OperationGif |
Defines a target GIF image format.
|
| OperationGoTo3DViewAction |
OperationGoTo3DViewAction
|
| OperationGoTo3DViewActionGoTo3DView |
When activated, the goTo3DView action will jump to a specific view of a 3D object (a 3D annotation).
|
| OperationGoToDestinationAction |
OperationGoToDestinationAction
|
| OperationGoToDestinationActionGoTo |
The goTo element jumps to a specific place (destination) in the document.
|
| OperationHeaderFooter |
Used to define the header and footer that will be added to a document.
|
| OperationHeaderFooterDate |
Sets a date for inclusion in the added header/footer element.
|
| OperationHeaderFooterPositions |
The header/footer consists of three parts (left margin, centre, right margin).
|
| OperationHeaderFooterToolboxOptions |
Adds a header and footer to the document or removes them (the \"add\" and \"remove\" elements are mutually exclusive, i.e., you must select one or the other).
|
| OperationHideAction |
OperationHideAction
|
| OperationHideActionHideAnnotation |
When activated, the hide element will show or hide the selected annotations.
|
| OperationHtmlTranscribe |
Converts the given document into a HTML representation.
|
| OperationHttpBasicAuth |
Used to define the appropriate login information if access to the resource requires a login using the \"Basic Authentication\" method.
|
| OperationHttpProxy |
Used to define the proxy and the access information if the resource must be fetched through a proxy.
|
| OperationImageBackground |
Adds an image as a background layer to the document.
|
| OperationImageOptimization |
The optimization element allows to correct the images of the pages to optimize them for OCR.
|
| OperationImportDataAction |
OperationImportDataAction
|
| OperationImportDataActionImportSchema |
The importSchema action replaces the values in all form fields with the values in a matching form file.
|
| OperationItem |
Used to specify all the properties you want for a content structure entry that is to be created, including the actions it will trigger.
|
| OperationItemReference |
Used to select an outline item.
|
| OperationItfBarcode |
An ITF barcode.
|
| OperationJavaScriptAction |
OperationJavaScriptAction
|
| OperationJavaScriptActionExecuteJavaScript |
The executeJavaScript action runs passed JavaScript code.
|
| OperationJpeg |
Defines a target JPEG image format.
|
| OperationKeyPair |
Allows the private key for decrypting an asymmetrically encrypted document to be handed over and the associated rights holder (recipient) to be selected by means of the certificate assigned to him.
|
| OperationLaunchApplicationAction |
OperationLaunchApplicationAction
|
| OperationLaunchApplicationActionLaunchApplication |
The launchApplication element will open another application or document when activated.
|
| OperationLaunchParameter |
Used to specify additional arguments for running an application and selecting the file in a platform-specific way (as of this writing, operating systems other than Microsoft Windows are not supported when it comes to passing these arguments).
|
| OperationLayerStateSetOCGStateAction |
OperationLayerStateSetOCGStateAction
|
| OperationLineAnnotation |
An annotation that draws a simple line on a page.
|
| OperationMarkedStateAnnotation |
An annotation, that provides a \"marked state\" for a selected annotation.
|
| OperationMarkupAnnotation |
An annotation that adds a text markup to a page.
|
| OperationMergeFileData |
Contains the BASE64 encoded file that should be inserted or appended.
|
| OperationNamedAction |
OperationNamedAction
|
| OperationNamedActionExecuteNamed |
The executeNamed action executes a prepared action that is known to the reader application with a specific name.
|
| OperationNamedDestination |
OperationNamedDestination
|
| OperationNamedDestinationGoToNamed |
The goToNamed element is used to specify a location within the document.
|
| OperationObjectKeyReplyToAnnotationEdit |
Selects the \"reply to\" annotation by object ID.
|
| OperationObjectKeySelectionAnnotation |
Selects the annotation by object ID.
|
| OperationOCGSelection |
A \"layerState\" element can contain 1 to n \"referencedLayer\" elements that activate one document layer each.
|
| OperationOcr |
The \"OCR\" web service can be used to run character recognition in PDF documents or images.
|
| OperationOcrOperation |
OperationOcrOperation
|
| OperationOcrPage |
If images are converted to PDF documents during the character recognition process, the size of the page will be computed based on the size of the image and the DPI resolution.
|
| OperationOptionsFont |
Used to specify the font and formatting for the header and footer.
|
| OperationOptionsMargin |
Defines the outer offsets between an inner element and an outer element.
|
| OperationPaddedRectangle |
Used to select a rectangle and define a padding for it's contents.
|
| OperationPageInterval |
Used to define the document page range to which new elements should be added.
|
| OperationPagesBackgroundBaseSettings |
Selects the pages to which backgrounds shall be applied.
|
| OperationPagesHeaderFooter |
Selects the pages, to which header/footer elements shall be applied.
|
| OperationPageTransitionsToolboxOptions |
Can be used to change the document's page transition animations.
|
| OperationPasswordEncrypt |
Used to set the password for encryption and the encryption key length.
|
| OperationPdf417Barcode |
A PDF417 barcode.
|
| OperationPdfa |
When using the \"Pdfa\" web service, both the `<convert>` and `<analyze>` operations can be used.
|
| OperationPdfaErrorCorrection |
This parameter can be used to optionally activate automatic error correction.
|
| OperationPdfaOperation |
OperationPdfaOperation
|
| OperationPdfaSettings |
The `pdfa` element allows to make settings for automatic handling of PDF/A documents.
|
| OperationPdfPassword |
The `password` element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected.
|
| OperationPng |
Defines a target PNG image format.
|
| OperationPoint |
Used to select a point.
|
| OperationPortfolioAdd |
Adds a document to the portfolio.
|
| OperationPortfolioExtract |
Extracts one or more documents from the portfolio.
|
| OperationPortfolioFile |
Used to define an individual document that should be added to the portfolio.
|
| OperationPortfolioFileData |
Contains the file to be attached in \"Base64 encoded\" format.
|
| OperationPortfolioFolder |
Used to define an individual folder that should be added to the portfolio.
|
| OperationPortfolioRemove |
Removes one or more documents from the portfolio.
|
| OperationPortfolioSelection |
Used to select documents that match the selection rules and that should be processed (extracted / deleted) accordingly.
|
| OperationPositionBackgroundBaseSettings |
Used to define the position of the background layer.
|
| OperationPositionFreeTextAnnotation |
Used to select the bounds within which the shape shall be positioned.
|
| OperationPositionMarkupAnnotation |
Used to define the pathelements in which the annotation shall be positioned.
|
| OperationPositionRedactAnnotation |
Used to define the pathelements in which the annotation shall be positioned.
|
| OperationPositionRubberStampAnnotation |
Used to select the bounds within which the shape shall be positioned.
|
| OperationPositionSimpleShapeAnnotation |
Used to select the bounds within which the shape shall be positioned.
|
| OperationPrivateKeyFileData |
Allows the private key to be passed (as a PEM file), for decryption of an asymmetrically encrypted document.
|
| OperationQrBarcode |
A QR barcode.
|
| OperationQrSwissPaymentBarcode |
A swiss QR payment barcode.
|
| OperationQrSwissPaymentContent |
Used to select the content encoded in the barcode.
|
| OperationQrSwissPaymentPdf |
Used to position the barcode in a PDF document.
|
| OperationQuadrilateral |
Selects a rectangular area via it's 4 determining corner points.
|
| OperationRecipient |
Defines a rights recipient (Recipient) for the document to be encrypted.
|
| OperationRectangle |
Used to select a rectangle.
|
| OperationRedactAnnotation |
An annotation that marks page content for redaction.
|
| OperationRemoveBackground |
Removes a background layer from a document.
|
| OperationRemoveBoxes |
OperationRemoveBoxes
|
| OperationRemoveHeaderFooter |
Removes a header and footer definition from a document.
|
| OperationRemovePageTransitions |
OperationRemovePageTransitions
|
| OperationRemoveToolboxAnnotation |
Used to select annotations for removal.
|
| OperationRemoveToolboxAttachment |
Used to remove one or more attachments from the document.
|
| OperationRemoveToolboxOutline |
Selects outline entries for removal.
|
| OperationReplyStateAnnotation |
An annotation, that provides a \"reply state\" for a selected annotation.
|
| OperationReplyToAnnotation |
An annotation, that represents a textual reply to another annotation.
|
| OperationReplyToAnnotationEdit |
Allows editing the content and properties of a textual reply to another annotation.
|
| OperationResetFormAction |
OperationResetFormAction
|
| OperationResetFormActionResetForm |
The resetForm action clears the values in all selected form fields.
|
| OperationResizeBoxes |
OperationResizeBoxes
|
| OperationRubberStampAnnotation |
An annotation that either uses an custom image or text as a stamp, or that adds a prepared \"named\" stamp to the page.
|
| OperationSanitize |
Simplifies document structures, deletes metadata, and flattens page contents in order to remove confidential information that could be hidden in the document structure.
|
| OperationSanitizeActions |
If this element is set, all actions shall be removed from the document - including specifically links and javascript triggers, elements and definitions.
|
| OperationSanitizeAnnotations |
If this function is enabled, all comments and annotations will be removed from the document.
|
| OperationSanitizeAttachments |
If this function is enabled, all attachments will be removed from the document.
|
| OperationSanitizeForms |
If this function is enabled, all the forms in the document will be flattened.
|
| OperationSanitizeLayers |
If this function is enabled, all layers will be removed from the document.
|
| OperationSanitizeMetadata |
If this function is enabled, info structures and XMP metadata will be removed from the document.
|
| OperationSanitizeOutlines |
If this function is enabled, the outline will be removed from the document.
|
| OperationSanitizePages |
If this function is enabled, all the selected pages in the document will be flattened.
|
| OperationSanitizeTags |
If this function is enabled, all tags will be removed from the document.
|
| OperationScalePagesToolboxScale |
Used to define page scaling operations.
|
| OperationSelectionAnnotation |
Defines criteria for the selection of annotations.
|
| OperationSelectionAttachment |
Used to set an area from which attachments that meet the selection rules will be removed.
|
| OperationSelectionBox |
Selects a specific box of a given page range of a PDF document.
|
| OperationSelectionEdit |
Selects the annotations, that shall be edited.
|
| OperationSelectionRemove |
Selects specific annotations for removal.
|
| OperationSelectionTransition |
Used to select a page range from which all transition animations should be removed.
|
| OperationSetOCGStateAction |
OperationSetOCGStateAction
|
| OperationSetOCGStateActionSetLayerState |
setLayerState switches the visibility of the selected document layers to the desired value.
|
| OperationSettings |
Used to configure global settings that should be respected when running the web service operation.
|
| OperationSignature |
The \"Signature\" web service can be used to digitally sign documents or to remove all signatures from a PDF documents.
|
| OperationSignatureFileData |
An image that will be placed in the field's background.
|
| OperationSignatureIdentifier |
Used to define the elements that are part of the visual signature.
|
| OperationSignatureImage |
Used to define an image, for the visual signature, that will be drawn in the signature's background.
|
| OperationSignatureOperation |
OperationSignatureOperation
|
| OperationSignaturePosition |
Used to define the position of the visual signature.
|
| OperationSignatureSettings |
The `signature` element allows to set settings for automatic signature handling and verification.
|
| OperationSignerAdd |
Contains a key pair (`<keyPair>`) consisting of the certificate (with public key) and the private key that identifies the signer (`<signer>`) who performs the signature.
|
| OperationSizeOptimization |
If you use a JPEG \"image type element,\" the file size can be automatically optimized.
|
| OperationSoundAction |
OperationSoundAction
|
| OperationSoundActionPlaySound |
When activated, the playSound Element plays the specified audio data.
|
| OperationSquareAnnotation |
An annotation that draws a rectangle on a page.
|
| OperationSubmitFormAction |
OperationSubmitFormAction
|
| OperationSubmitFormActionSubmitForm |
When activated, the submitForm action will send the names and values of all selected form fields to the specified URL (Uniform Resource Locator).
|
| OperationSvg |
Defines a target SVG image format.
|
| OperationSvgFormat |
Selects parameters for the creation of SVGs, possibly contained in resulting documents.
|
| OperationSyntaxHighlight |
This element is used to configure language detection and the representation of syntax elements in recognized programming/script languages.
|
| OperationTemplateData |
Contains the Base64-encoded JSON structure that is used as variables in the HTML template if \"useAsTemplate\" has a value of \"true\".
|
| OperationTemplateFile |
The template is passed as Base64-encoded content in the \"file\" element.
|
| OperationTextAnnotation |
An annotation that adds a note icon to a page.
|
| OperationTextExtractionLinks |
OperationTextExtractionLinks
|
| OperationTextHighlight |
This element is used to configure the display of contents for which the syntax highlighter was unable to identify a known language.
|
| OperationThreadAction |
OperationThreadAction
|
| OperationThreadActionGoToThread |
When activated, the goToThread action jumps to a specific thread defined in the document.
|
| OperationTiff |
Defines a target TIFF image format.
|
| OperationToolboxAnnotation |
OperationToolboxAnnotation
|
| OperationToolboxAnnotationAnnotation |
The annotation operation can be used to remove, edit or add markup annotations of/to a document.
|
| OperationToolboxAttachment |
OperationToolboxAttachment
|
| OperationToolboxAttachmentAttachment |
The attachment operation element can be used to add, remove, and extract file attachments to and from the PDF document.
|
| OperationToolboxCompress |
OperationToolboxCompress
|
| OperationToolboxCompressCompress |
The compress operation element can be used to reduce the document size by compression.
|
| OperationToolboxDelete |
OperationToolboxDelete
|
| OperationToolboxDeleteDelete |
The delete operation element can be used to delete pages from the document.
|
| OperationToolboxDescription |
OperationToolboxDescription
|
| OperationToolboxDescriptionDescription |
The description operation element can be used to change the description for documents.
|
| OperationToolboxExtraction |
OperationToolboxExtraction
|
| OperationToolboxExtractionExtraction |
The extraction operation element can be used to extract various contents.
|
| OperationToolboxForms |
OperationToolboxForms
|
| OperationToolboxFormsForms |
The forms operation element can be used to import and export PDF forms.
|
| OperationToolboxImage |
OperationToolboxImage
|
| OperationToolboxImageImage |
The image operation element can be used to export a document as an image.
|
| OperationToolboxMerge |
OperationToolboxMerge
|
| OperationToolboxMergeMerge |
The merge operation element can be used to merge documents.
|
| OperationToolboxMove |
OperationToolboxMove
|
| OperationToolboxMoveMove |
The move operation element can be used to change the order of the document's pages.
|
| OperationToolboxOperation |
OperationToolboxOperation
|
| OperationToolboxOptions |
OperationToolboxOptions
|
| OperationToolboxOptionsOptions |
The options operation element can be used to change the way documents are displayed.
|
| OperationToolboxOutline |
OperationToolboxOutline
|
| OperationToolboxOutlineOutline |
The outline operation element can be used to change the outline in the document.
|
| OperationToolboxPortfolio |
OperationToolboxPortfolio
|
| OperationToolboxPortfolioPortfolio |
The portfolio operation element can be used to merge documents into a portfolio, as well as to remove or extract documents from it.
|
| OperationToolboxPrint |
OperationToolboxPrint
|
| OperationToolboxPrintPrint |
The print operation element can be used to print documents.
|
| OperationToolboxRedact |
OperationToolboxRedact
|
| OperationToolboxRedactRedact |
You can use the redact operation element to redact the contents of a document and remove metadata.
|
| OperationToolboxRotate |
OperationToolboxRotate
|
| OperationToolboxRotateRotate |
The rotate operation element can be used to rotate pages in the document.
|
| OperationToolboxScale |
OperationToolboxScale
|
| OperationToolboxScaleScale |
The scale operation element can be used to scale pages in the document.
|
| OperationToolboxSecurity |
OperationToolboxSecurity
|
| OperationToolboxSecuritySecurity |
The security operation element can be used to encrypt and decrypt documents.
|
| OperationToolboxSplit |
OperationToolboxSplit
|
| OperationToolboxSplitSplit |
The split operation element can be used to split documents.
|
| OperationToolboxTranscribe |
OperationToolboxTranscribe
|
| OperationToolboxTranscribeTranscribe |
The transcribe operation element can be used to convert a PDF document into other document formats.
|
| OperationToolboxWatermark |
OperationToolboxWatermark
|
| OperationToolboxWatermarkWatermark |
The watermark operation element can be used to add watermarks to the PDF document.
|
| OperationToolboxXmp |
OperationToolboxXmp
|
| OperationToolboxXmpXmp |
The xmp operation element can be used to add XMP metadata to the document.
|
| OperationTransition |
Creates a page transition animation for a PDF full screen presentation.
|
| OperationTransitionAction |
OperationTransitionAction
|
| OperationTransitionActionSetTransition |
The setTransition action shows the changes that result from the actions with the use of the defined transition animation.
|
| OperationUpcaBarcode |
An UPCA barcode.
|
| OperationURIAction |
OperationURIAction
|
| OperationURIActionResolveURI |
When activated, the resolveURI element will open a specified URI in a suitable program.
|
| OperationUrlConverter |
The \"URLConverter\" web service van be used to convert URL resources (websites) to a PDF document.
|
| OperationUrlConverterFooter |
Defines the content that will be used as a footer.
|
| OperationUrlConverterHeader |
Defines the content that will be used as a header.
|
| OperationUrlConverterOperation |
OperationUrlConverterOperation
|
| OperationUrlConverterPage |
Sets the page size, margins, and headers and footers for the converted document in the PDF document.
|
| OperationViewerPreferences |
Allows to change PDF reader specific settings and dialog defaults.
|
| OperationVisibilityBackgroundBaseSettings |
Used to define the element's visibility in various use contexts.
|
| OperationWatermarkFileData |
Contains the watermark image file in \"Base64 encoded\" format.
|
| OperationWatermarkFont |
Used to specify the font used for a watermark.
|
| OperationWatermarkImage |
Used to add an image as a watermark.
|
| OperationWatermarkPosition |
Used to set the position of the watermark in the PDF document.
|
| OperationWatermarkText |
Used to add a text watermark.
|
| OperationWindowsLaunchParameter |
OperationWindowsLaunchParameter
|
| OperationXmpFileData |
Contains the XMP metadata that needs to be added, Base64 encoded.
|
| OperationXmpNamespace |
Used to set the namespace for XMP metadata.
|
| OperationXRechnung |
This element defines one \"XRechnung\" transformation and the resources and parameters necessary for it.
|
| OperationXRechnungResources |
This element defines a transformation and the resources and parameters needed for it.
|
| OperationXslTransformation |
This element defines one XSLT transformation and the resources and parameters necessary for it.
|
| OperationXslTransformationFile |
This element defines a file necessary for the transformation, which is passed \"Base64 encoded\".
|
| OperationXslTransformationResources |
This element defines all resources necessary for the transformation.
|
| OperationZoomDestination |
OperationZoomDestination
|
| OperationZoomDestinationZoomPage |
The zoomPage element is used to specify a location within the document.
|
| OperationZugferd |
This element can be optionally used to integrate a ZUGFeRD document.
|
| OperationZugferdFileData |
ZUGFeRD file (XML) in \"Base64 encoded\" format.
|
| PortalEnvironment |
PortalEnvironment
|
| PortalFunctions |
PortalFunctions
|
| PortalInformation |
Provides information for building and controlling the portal page.
|
| PortalLocalAuth |
PortalLocalAuth
|
| PortalNews |
PortalNews
|
| PortalSettings |
PortalSettings
|
| PortalUserInterface |
Provides information for the user interface of the portal page.
|
| PortalUserInterfaceResources |
Provides information about the (file) resources used in the portal page user interface.
|
| RestOperationData |
|
| ServerConfigApr |
Configures an [APR Lifecycle Listener](https://tomcat.apache.org/tomcat-10.0-doc/config/listeners.html) for the underlying tomcat server.
|
| ServerConfigCiphersSSL |
Selects encryption algorithms (ciphers) used by the TLS connector.
|
| ServerConfigConnector |
A [connector](https://tomcat.apache.org/tomcat-9.0-doc/config/http.html) defines the properties of a port the server can be accessed by.
|
| ServerConfigConnectorAttribute |
Defines a single configuration setting via a name-value pair.
|
| ServerConfigConnectorConfiguration |
Allows setting the configuration values for the \"HTTP Connector\" as described in the [Tomcat manual](https://tomcat.apache.org/tomcat-10.1-doc/config/http.html)
|
| ServerConfigConnectorsServer |
Defines a set of connectors on which the server listens.
|
| ServerConfigHost |
Defines the host name and context path of the server.
|
| ServerConfigKeystore |
Defines a certificate keystore.
|
| ServerConfigKeystoreSSL |
Sets the keystore information for the server key and certificate to be used to cipher the connection.
|
| ServerConfigLocalAuth |
Defines the local authorization provider that authenticates users and provides authorization tokens for API access.
|
| ServerConfigLocalAuthRest |
Defines the settings for accessing the server's REST API (web services).
|
| ServerConfigLocalAuthSoap |
Defines the settings for accessing the server's SOAP API (web services).
|
| ServerConfigOAuth |
Defines settings for external OAuth2 providers that issue authorization tokens to clients required for API access.
|
| ServerConfigOAuthProvider |
Defines an Oauth2 authorization provider.
|
| ServerConfigOAuthProviderLogout |
Specifies the settings required to perform an OAuth2 logout.
|
| ServerConfigOAuthProviders |
Defines the settings for an OAuth2 provider that are required to validate the provider's tokens.
|
| ServerConfigProtocolsSSL |
Lists the protocols, that are accepted by the TLS connector.
|
| ServerConfigProxy |
Defines proxy configuration for the connector.
|
| ServerConfigServer |
The server element defines settings for the server such as the ports, user sources or authorization settings.
|
| ServerConfigSessionAccessToken |
Defines the setting for access tokens provided by the server.
|
| ServerConfigSessionLimits |
Defines the restrictions and limits that apply when using the REST API and user sessions on the server.
|
| ServerConfigSessionRefreshToken |
Defines the setting for refresh tokens provided by the server.
|
| ServerConfigShutdown |
Defines the port and command for the server shutdown.
|
| ServerConfigSSL |
Defines settings for an SSL (TLS) connector.
|
| ServerConfigTruststoreServer |
Defines the access information for the server's truststore, which contains all third-party certificates that the server should trust.
|
| ServerConfigUserAzureAd |
Defines an Azure Active Directory as user source.
|
| ServerConfigUserCertificateLdap |
Defines the location of the user's certificate stored in the Active Directory.
|
| ServerConfigUserDb |
Defines a relational user database as user source.
|
| ServerConfigUserKeepAliveLdap |
When these settings are present, the server sends a ping to the configured LDAP server to keep the connection alive.
|
| ServerConfigUserLdap |
Defines an LDAP dictionary or Active Directory as user source.
|
| ServerConfigUserPKCS12 |
Defines the location of the user's keystore stored in the active directory.
|
| ServerConfigUserStorage |
Defines settings for the server's user storage.
|
| ServerConfigValveHost |
A component to insert into the request processing pipeline of the underlying tomcat server.
|
| SessionTable |
General information about the sessions and detailed information about each session.
|
| SessionTableEntry |
Stores detailed information about a single session entry in the session table.
|
| UserConfigUser |
Defines the attributes of a user.
|
| UserConfigUsers |
Lists users of the webPDF server.
|
| WebserviceException |
Defines the error object that is returned in the response to a REST web service call when an error has occurred
|
| WebserviceResult |
Defines the result of the execution of a web service operation.
|
| WebserviceResultStackTrace |
The Java stack trace of an exception that occurred.
|
| WebserviceResultStackTraceCause |
WebserviceResultStackTraceCause
|
| WebserviceResultStackTraceCauseStackTraceInner |
WebserviceResultStackTraceCauseStackTraceInner
|
| WebserviceResultStackTraceSuppressedInner |
WebserviceResultStackTraceSuppressedInner
|