Jump to main content

# PDF

An object containing a document (binary) and location information about the attached document. Object containing the display name and file name for an instance of a document.

Parameter | Type | Description
--- | --- | ---
InstanceDisplayName | string | The document display name associated with the document. This is authored as part of REQ authoring (Document > Properties). The InstanceDisplayName, with any spaces and special characters removed, is used as the file name in the returned document.
InstanceFileName | string | The instance file name associated with the document instance. This is generated as a conversion of the dispay name (converting the display name to a file name) in a maner that replaces any special characters or spaces in the display name with an underscore (_).
DocData | Data | Container object for transaction data inputs and outputs in binary (base64), text, or xml format. It will include all documents in the current packet.
BeginningOrEnd | enumeration | Indicates whether the added PDF will be returned at the beginning or end of the API response; default is "End."
Passwords | Password | Object containing the user and owner to submit on a request.