Search
K
Document Generator API

/v1/documentTemplates/{documentTemplateRID}/file/upload

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

Path Parameters

documentTemplateRIDstringrequired

Response

application/json

Success

FBPUploadSpecResponse

* Additional properties are NOT allowed.
methodstring | null
chunkUristring | null(uri)
finishUristring | null(uri)
canAcceptParamsInHeadersboolean | null
isDuplicateFileNameboolean | null
application/json

/v1/documentTemplates/{documentTemplateRID}/file

post
/v1/documentTemplates/{documentTemplateRID}/file

Path Parameters

documentTemplateRIDstringrequired

Body

UploadedFileItem

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

Response

No Content

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