Smartapp.com

PDF Builder

Create, download, and get status of PDFs

Allows to generate pdf file for smart items

Request
query Parameters
smartItemUniqueIds
required
Array of strings <uuid>

Array of smart item unique ids

includeTableOfContents
boolean
includeItemMetadata
boolean
includeItemMarkups
boolean
includeItemComments
boolean
includeItemAttachments
boolean
includeAttachmentMarkups
boolean
itemPrintLayout
string

Cover sheet report template id

object (pdfAttachmentData)
callbackUrl
string

Url that gets called after a successful completion of the build pdf request

object (pdfEmailData)

email ids whom pdf file download link should be sent to after pdf file generation

coverPageText
string

text that should show up in the first page of the pdf file

required
object (pdfBuildOptions)

Allows to create single or multiple pdf files

downloadAsPDF
boolean

if passed in, then will generate the pdf file. Else, generates the zip

Responses
200

Returns a unique id which could be used to know the status of the request

post/pdf/buildpdf
Request samples
Response samples
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
gets the status of the build pdf request from the id that was returned upon build pdf request
Request
query Parameters
requestID
required
string <uuid> 
the request id that was returned upon build pdf request


 
 Example:  requestID=00000000-0000-0000-0000-000000000000
Responses
200
Returned the status of the build PDF Request


get/pdf/status
Request samples
Response samples
application/json
{
  • "progress": 100,
  • "status": {
    },
  • "message": "string",
  • "downloadUrl": "string"
}
Allows to download the file
Request
query Parameters
requestID
required
string <uuid> 
the request id that was returned upon build pdf request


 
 Example:  requestID=00000000-0000-0000-0000-000000000000
Responses
200
Returned a zip


get/pdf/download
Request samples
➔ Next to User Group