Document Generator API

DeleteDocumentTemplateFile

delete
/v1/documentTemplates/{documentTemplateRID}/file

Path Parameters

documentTemplateRIDstringrequired

Response

No Content

/v1/documentTemplates/{documentTemplateRID}/file/uploadComplete

post
/v1/documentTemplates/{documentTemplateRID}/file/uploadComplete

Path Parameters

documentTemplateRIDstringrequired

Body

UploadedFileItem

* Additional properties are NOT allowed.
fileNamestringrequired
fileIdstringrequired
overwriteboolean
isSystemFileboolean
shouldAppendVersionboolean

Response

No Content

SyncUserToFBP

post
/v1/documentTemplates/{documentTemplateRID}/userSync

Path Parameters

documentTemplateRIDstringrequired

Body

array[string]

Response

Accepted

/v1/documentTemplates/{documentTemplateRID}/file/editUrl

get
/v1/documentTemplates/{documentTemplateRID}/file/editUrl

Path Parameters

documentTemplateRIDstringrequired

Response

application/json

Success

FBPGetEditUrlResponse

* Additional properties are NOT allowed.
editUrlstring | null(uri)
application/json

CreateResourceAsync

post
/v1/documentTemplates/packaging/createResource

Body

CreateResourceRequest

* Additional properties are NOT allowed.
containerRIDstringrequired
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Success

CreateResourceResponse

* Additional properties are NOT allowed.
RIDstringrequired
staterequired
application/json