---
title: "Document Generator API"
url: "https://devportal.jilson.dev/apis/document-generator-pkce-flow-1/versions/c7bf5731-4982-4310-bcfe-512415c7d543"
---

# Document Generator API

OpenAPI specification document.

```json
{"openapi":"3.0.1","info":{"title":"Document Generator API","description":"","version":"1.0"},"paths":{"/v1/compliance/delete":{"delete":{"tags":["Compliance"],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/PermanentDeleteRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/PermanentDeleteRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/PermanentDeleteRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/PermanentDeleteRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermanentDeleteResponse"}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/v1/documents":{"post":{"tags":["Documents"],"operationId":"CreateDocumentFromTemplateAsync","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateDocumentRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateDocumentRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateDocumentRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateDocumentRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/documents/{documentRID}":{"get":{"tags":["Documents"],"operationId":"GetDocumentByIdAsync","parameters":[{"name":"documentRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}},"patch":{"tags":["Documents"],"operationId":"PartialUpdateDocumentAsync","parameters":[{"name":"documentRID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/JsonPatchDocument"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}},"delete":{"tags":["Documents"],"operationId":"DeleteDocumentAsync","parameters":[{"name":"documentRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documents/{documentRID}/merge":{"post":{"tags":["Documents"],"operationId":"MergeFileAndUpdateDocument","parameters":[{"name":"documentRID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/MergePayload"}},"application/json":{"schema":{"$ref":"#/components/schemas/MergePayload"}},"text/json":{"schema":{"$ref":"#/components/schemas/MergePayload"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/MergePayload"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/documents/{documentRID}/file/download":{"get":{"tags":["Documents"],"parameters":[{"name":"documentRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadSpecification"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documents/{documentRID}/file/thumbnail":{"get":{"tags":["Documents"],"parameters":[{"name":"documentRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documentTemplates":{"get":{"tags":["DocumentTemplates"],"operationId":"GetDocumentTemplatesAsync","parameters":[{"name":"Take","in":"query","schema":{"maximum":20,"minimum":0,"type":"integer","format":"int32"}},{"name":"Search","in":"query","schema":{"type":"string"}},{"name":"ContinuationToken","in":"query","schema":{"type":"string"}},{"name":"Filters","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateSearchResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}},"post":{"tags":["DocumentTemplates"],"operationId":"CreateDocumentTemplateAsync","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documentTemplates/{documentTemplateRID}":{"get":{"tags":["DocumentTemplates"],"operationId":"GetDocumentTemplateAsync","parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}},"put":{"tags":["DocumentTemplates"],"operationId":"UpdateDocumentTemplateAsync","parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}},"patch":{"tags":["DocumentTemplates"],"operationId":"PartialUpdateDocumentTemplateAsync","parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/JsonPatchDocument"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}},"delete":{"tags":["DocumentTemplates"],"operationId":"DeleteDocumentTemplateAsync","parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documentTemplates/{documentTemplateRID}/file/download":{"get":{"tags":["DocumentTemplates"],"parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadSpecification"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documentTemplates/{documentTemplateRID}/file/thumbnail":{"get":{"tags":["DocumentTemplates"],"parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documentTemplates/{documentTemplateRID}/file/upload":{"post":{"tags":["DocumentTemplates"],"parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FBPUploadSpecResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documentTemplates/{documentTemplateRID}/file":{"post":{"tags":["DocumentTemplates"],"parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UploadedFileItem"}},"application/json":{"schema":{"$ref":"#/components/schemas/UploadedFileItem"}},"text/json":{"schema":{"$ref":"#/components/schemas/UploadedFileItem"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UploadedFileItem"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}},"delete":{"tags":["DocumentTemplates"],"operationId":"DeleteDocumentTemplateFile","parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/documentTemplates/{documentTemplateRID}/file/uploadComplete":{"post":{"tags":["DocumentTemplates"],"parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UploadedFileItem"}},"application/json":{"schema":{"$ref":"#/components/schemas/UploadedFileItem"}},"text/json":{"schema":{"$ref":"#/components/schemas/UploadedFileItem"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UploadedFileItem"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documentTemplates/{documentTemplateRID}/userSync":{"post":{"tags":["DocumentTemplates"],"operationId":"SyncUserToFBP","parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"string"}}},"application/json":{"schema":{"type":"array","items":{"type":"string"}}},"text/json":{"schema":{"type":"array","items":{"type":"string"}}},"application/*+json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/documentTemplates/{documentTemplateRID}/file/editUrl":{"get":{"tags":["DocumentTemplates"],"parameters":[{"name":"documentTemplateRID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FBPGetEditUrlResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Server Error"}}}},"/v1/documentTemplates/packaging/createResource":{"post":{"tags":["Packaging"],"operationId":"CreateResourceAsync","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateResourceRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateResourceRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateResourceRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceResponse"}}}},"401":{"description":"Unauthorized"}}}},"/v1/documentTemplates/packaging/deleteResource":{"post":{"tags":["Packaging"],"operationId":"DeleteResourceAsync","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/DeleteResourceRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResourceRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeleteResourceRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/DeleteResourceRequest"}}}},"responses":{"401":{"description":"Unauthorized"}}}},"/v1/documentTemplates/packaging/enumerateResources":{"post":{"tags":["Packaging"],"operationId":"EnumerateResourcesAsync","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/EnumerateResourcesRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/EnumerateResourcesRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/EnumerateResourcesRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/EnumerateResourcesRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnumerateResourcesResponse"}}}},"401":{"description":"Unauthorized"}}}},"/v1/documentTemplates/packaging/readResource":{"post":{"tags":["Packaging"],"operationId":"ReadResourceAsync","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ReadResourceRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/ReadResourceRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/ReadResourceRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ReadResourceRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadResourceResponse"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/documentTemplates/packaging/updateResource":{"post":{"tags":["Packaging"],"operationId":"UpdateResourceAsync","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateResourceRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResourceRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateResourceRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateResourceRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/dataSources":{"get":{"tags":["Schemas"],"operationId":"GetAvailableDataSources","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataSource"}}}}},"401":{"description":"Unauthorized"}}}},"/v1/dataSources/{dataSource}/entities":{"get":{"tags":["Schemas"],"operationId":"GetEntitiesByDataSource","parameters":[{"name":"dataSource","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized"}}}},"/v1/dataSources/{dataSource}/entities/{entityId}/schema":{"get":{"tags":["Schemas"],"operationId":"GetSchemaByEntity","parameters":[{"name":"dataSource","in":"path","required":true,"schema":{"type":"string"}},{"name":"entityId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized"}}}},"/v1/template-provider/readTemplates":{"get":{"tags":["TemplateProvider"],"operationId":"GetDocumentTemplatesForListingPage","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateProviderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Server Error"}}}},"/v1/template-provider/deleteTemplate":{"post":{"tags":["TemplateProvider"],"operationId":"DeleteDocumentTemplateFromListingPage","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/DeleteResourceRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResourceRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeleteResourceRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/DeleteResourceRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoContentResult"}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Server Error"}}}}},"components":{"schemas":{"CreateDocumentRequest":{"type":"object","properties":{"documentTemplateRID":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"containerRID":{"type":"string","nullable":true},"settings":{"$ref":"#/components/schemas/DocumentSettings"},"signatureSettings":{"$ref":"#/components/schemas/SignatureSettings"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"},"nullable":true},"variableData":{"type":"object","additionalProperties":{},"nullable":true},"mergeFieldValues":{"type":"array","items":{"$ref":"#/components/schemas/MergeFieldKeyValuePair"},"nullable":true}},"additionalProperties":false},"CreateDocumentRequestJsonPatchDocument":{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/CreateDocumentRequestOperation"},"nullable":true,"readOnly":true},"contractResolver":{"$ref":"#/components/schemas/IContractResolver"}},"additionalProperties":false},"CreateDocumentRequestOperation":{"type":"object","properties":{"operationType":{"$ref":"#/components/schemas/OperationType"},"path":{"type":"string","nullable":true},"op":{"type":"string","nullable":true},"from":{"type":"string","nullable":true},"value":{"nullable":true}},"additionalProperties":false},"CreateResourceRequest":{"required":["containerRID","data"],"type":"object","properties":{"containerRID":{"type":"string"},"data":{"$ref":"#/components/schemas/DocumentTemplateRequest"}},"additionalProperties":false},"CreateResourceResponse":{"required":["RID","state"],"type":"object","properties":{"RID":{"type":"string"},"state":{}},"additionalProperties":false},"DataPreFilledType":{"enum":["None","Manual","SourceMapped"],"type":"string"},"DataSource":{"type":"object","properties":{"connectionName":{"type":"string","nullable":true},"connectionRID":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"provider":{"type":"string","nullable":true}},"additionalProperties":false},"DeleteResourceRequest":{"required":["rid"],"type":"object","properties":{"rid":{"type":"string"}},"additionalProperties":false},"DocumentResponse":{"type":"object","properties":{"rid":{"type":"string","nullable":true},"containerRID":{"type":"string","nullable":true},"templateRID":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"creator":{"$ref":"#/components/schemas/User"},"parentId":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"file":{"$ref":"#/components/schemas/File"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"nullable":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"},"nullable":true},"settings":{"$ref":"#/components/schemas/DocumentSettings"},"signatureSettings":{"$ref":"#/components/schemas/SignatureSettings"},"signerSequencing":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"},"nullable":true}},"additionalProperties":false},"DocumentSettings":{"type":"object","properties":{"isKbaEnabled":{"type":"boolean","nullable":true},"isPasscodeEnabled":{"type":"boolean","nullable":true}},"additionalProperties":false},"DocumentTemplateRequest":{"type":"object","properties":{"name":{"type":"string","nullable":true},"rsTemplateId":{"type":"string","nullable":true},"rsTemplateParentId":{"type":"string","nullable":true},"status":{"$ref":"#/components/schemas/DocumentTemplateStatus"},"file":{"$ref":"#/components/schemas/FileDTO"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"nullable":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"},"nullable":true},"templateType":{"$ref":"#/components/schemas/TemplateType"},"esignSettings":{"$ref":"#/components/schemas/EsignSettings"},"workflowSettings":{"$ref":"#/components/schemas/WorkflowSettings"},"description":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"},"nullable":true},"isKbaEnabled":{"type":"boolean","nullable":true},"isPasscodeEnabled":{"type":"boolean","nullable":true},"isShared":{"type":"boolean","nullable":true},"signerSequencing":{"type":"boolean","nullable":true},"containerRID":{"type":"string","nullable":true},"base64EncodedFile":{"type":"string","nullable":true},"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"},"nullable":true}},"additionalProperties":false},"DocumentTemplateRequestJsonPatchDocument":{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTemplateRequestOperation"},"nullable":true,"readOnly":true},"contractResolver":{"$ref":"#/components/schemas/IContractResolver"}},"additionalProperties":false},"DocumentTemplateRequestOperation":{"type":"object","properties":{"operationType":{"$ref":"#/components/schemas/OperationType"},"path":{"type":"string","nullable":true},"op":{"type":"string","nullable":true},"from":{"type":"string","nullable":true},"value":{"nullable":true}},"additionalProperties":false},"DocumentTemplateResponse":{"type":"object","properties":{"id":{"type":"string","nullable":true},"rid":{"type":"string","nullable":true},"containerRID":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"creator":{"$ref":"#/components/schemas/User"},"rsTemplateId":{"type":"string","nullable":true},"rsTemplateParentId":{"type":"string","nullable":true},"status":{"$ref":"#/components/schemas/DocumentTemplateStatus"},"file":{"$ref":"#/components/schemas/File"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"nullable":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"},"nullable":true},"templateType":{"$ref":"#/components/schemas/TemplateType"},"esignSettings":{"$ref":"#/components/schemas/EsignSettings"},"workflowSettings":{"$ref":"#/components/schemas/WorkflowSettings"},"permissions":{"$ref":"#/components/schemas/PermissionSet"},"description":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"},"nullable":true},"isKbaEnabled":{"type":"boolean","nullable":true},"isPasscodeEnabled":{"type":"boolean","nullable":true},"isShared":{"type":"boolean","nullable":true},"signerSequencing":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"},"nullable":true}},"additionalProperties":false},"DocumentTemplateSearchResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTemplateResponse"},"nullable":true},"continuationToken":{"type":"string","nullable":true}},"additionalProperties":false},"DocumentTemplateStatus":{"enum":["Draft","Live","Expired"],"type":"string"},"DownloadSpecification":{"type":"object","properties":{"metadataUrl":{"type":"string","nullable":true},"__type":{"type":"string","nullable":true},"id":{"type":"string","nullable":true},"url":{"type":"string","format":"uri","nullable":true},"downloadToken":{"type":"string","nullable":true},"prepareXmlInfo":{"type":"string","nullable":true},"downloadUrl":{"type":"string","format":"uri","nullable":true},"downloadPrepStartURL":{"type":"string","format":"uri","nullable":true},"downloadPrepStatusURL":{"type":"string","format":"uri","nullable":true}},"additionalProperties":false},"EnumerateResourcesRequest":{"required":["containerRID"],"type":"object","properties":{"containerRID":{"type":"string"}},"additionalProperties":false},"EnumerateResourcesResponse":{"required":["resources"],"type":"object","properties":{"resources":{"type":"array","items":{"$ref":"#/components/schemas/ResourceState"}}},"additionalProperties":false},"EsignSettings":{"type":"object","properties":{"expiresInDays":{"type":"integer","format":"int32"}},"additionalProperties":false},"FBPGetEditUrlResponse":{"type":"object","properties":{"editUrl":{"type":"string","format":"uri","nullable":true}},"additionalProperties":false},"FBPUploadSpecResponse":{"type":"object","properties":{"method":{"type":"string","nullable":true},"chunkUri":{"type":"string","format":"uri","nullable":true},"finishUri":{"type":"string","format":"uri","nullable":true},"canAcceptParamsInHeaders":{"type":"boolean","nullable":true},"isDuplicateFileName":{"type":"boolean","nullable":true}},"additionalProperties":false},"Field":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/FieldType"},"x":{"type":"number","format":"double","nullable":true},"y":{"type":"number","format":"double","nullable":true},"height":{"type":"number","format":"double","nullable":true},"width":{"type":"number","format":"double","nullable":true},"isRequired":{"type":"boolean","nullable":true},"groupRequirement":{"$ref":"#/components/schemas/GroupRequirement"},"fontSize":{"type":"integer","format":"int32","nullable":true},"multiline":{"type":"boolean","nullable":true},"transparent":{"type":"boolean","nullable":true},"textAlign":{"$ref":"#/components/schemas/TextAlignment"},"selectOptions":{"type":"array","items":{"type":"string"},"nullable":true},"chargeAfterExecuted":{"type":"boolean","nullable":true},"paymentAmount":{"type":"integer","format":"int32","nullable":true},"helpText":{"type":"string","nullable":true},"page":{"type":"integer","format":"int32","nullable":true},"name":{"type":"string","nullable":true},"isDateSigned":{"type":"boolean","nullable":true},"dateFormat":{"type":"string","nullable":true},"signatureImage":{"type":"string","nullable":true},"signatureText":{"type":"string","nullable":true},"signatureType":{"$ref":"#/components/schemas/SignatureType"},"signatureJsonData":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"signatureId":{"type":"string","nullable":true},"assignedTo":{"$ref":"#/components/schemas/Role"},"dataPreFilledType":{"$ref":"#/components/schemas/DataPreFilledType"},"variableId":{"type":"string","nullable":true},"attributePath":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"fullyQualifiedPath":{"type":"string","nullable":true}},"additionalProperties":false},"FieldType":{"enum":["SignatureComponent","InitialsComponent","DateComponent","TextComponent","SelectComponent","CheckComponent","CheckGroupComponent","AttachmentComponent","SignatureAnnotationComponent","TextAnnotationComponent","CheckmarkAnnotationComponent","PaymentComponent"],"type":"string"},"File":{"type":"object","properties":{"fileRID":{"type":"string","nullable":true},"fileContainerRID":{"type":"string","nullable":true},"fileId":{"type":"string","nullable":true},"fileName":{"type":"string","nullable":true},"eTag":{"type":"string","nullable":true},"fileSource":{"$ref":"#/components/schemas/FileSource"},"shareFileStreamId":{"type":"string","nullable":true},"createdById":{"type":"string","nullable":true},"createdOnUtc":{"type":"string","format":"date-time"},"deletedOnUtc":{"type":"string","format":"date-time","nullable":true},"deletedById":{"type":"string","nullable":true}},"additionalProperties":false},"FileDTO":{"type":"object","properties":{"fileRID":{"type":"string","nullable":true},"fileContainerRID":{"type":"string","nullable":true},"fileId":{"type":"string","nullable":true},"fileName":{"type":"string","nullable":true},"eTag":{"type":"string","nullable":true},"fileSource":{"$ref":"#/components/schemas/FileSource"},"shareFileStreamId":{"type":"string","nullable":true},"createdById":{"type":"string","nullable":true},"createdOnUtc":{"type":"string","format":"date-time"},"deletedOnUtc":{"type":"string","format":"date-time","nullable":true},"deletedById":{"type":"string","nullable":true},"base64EncodedFile":{"type":"string","nullable":true},"remoteUrl":{"type":"string","nullable":true}},"additionalProperties":false},"FileSource":{"enum":["ShareFile","Base64String","RemoteUrl"],"type":"string"},"GroupRequirement":{"enum":["OnlyOne","OneOrMore"],"type":"string"},"IContractResolver":{"type":"object","additionalProperties":false},"JsonPatchDocument":{"type":"array","items":{"$ref":"#/components/schemas/Operation"},"description":"Array of operations to perform"},"MergeFieldKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"nullable":true}},"additionalProperties":false},"MergePayload":{"type":"object","properties":{"mergeFieldData":{"type":"object","additionalProperties":{"nullable":true},"nullable":true},"mergeFieldValues":{"type":"array","items":{"$ref":"#/components/schemas/MergeFieldKeyValuePair"},"nullable":true},"mergeAction":{"$ref":"#/components/schemas/MergeStepAction"}},"additionalProperties":false},"MergeStepAction":{"enum":["MergeData","MergeVariableData","GenerateSignerFields","MergeDataAndGenerateSignerFields","MergeVariableDataAndGenerateSignerFields"],"type":"string"},"NoContentResult":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"}},"additionalProperties":false},"Operation":{"type":"object","properties":{"op":{"type":"string"},"value":{"type":"string","nullable":true},"path":{"type":"string"}}},"OperationType":{"enum":["Add","Remove","Replace","Move","Copy","Test","Invalid"],"type":"string"},"PermanentDeleteRequest":{"type":"object","properties":{"resourceId":{"type":"string","nullable":true}},"additionalProperties":false},"PermanentDeleteResponse":{"type":"object","additionalProperties":false},"PermissionSet":{"type":"object","properties":{"canRead":{"type":"boolean","nullable":true},"canCreate":{"type":"boolean","nullable":true},"canDelete":{"type":"boolean","nullable":true},"canShare":{"type":"boolean","nullable":true},"canModify":{"type":"boolean","nullable":true}},"additionalProperties":false},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"ReadResourceRequest":{"required":["rid"],"type":"object","properties":{"rid":{"type":"string"}},"additionalProperties":false},"ReadResourceResponse":{"required":["RID","state"],"type":"object","properties":{"RID":{"type":"string"},"state":{}},"additionalProperties":false},"Recipient":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"roleId":{"type":"string","nullable":true}},"additionalProperties":false},"ResourceState":{"required":["RID","state"],"type":"object","properties":{"RID":{"type":"string"},"state":{}},"additionalProperties":false},"Role":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"sequence":{"type":"integer","format":"int32"},"isSender":{"type":"boolean"}},"additionalProperties":false},"SignatureSettings":{"type":"object","properties":{"expiresInDays":{"type":"integer","format":"int32","nullable":true},"storageLocation":{"type":"string","nullable":true},"signerMessage":{"type":"string","nullable":true},"passcode":{"type":"string","nullable":true},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"},"nullable":true}},"additionalProperties":false},"SignatureType":{"enum":["Typed","Drawn"],"type":"string"},"Template":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"RID":{"type":"string","nullable":true},"rootType":{"type":"string","nullable":true},"containerRID":{"type":"string","nullable":true},"creator":{"type":"string","nullable":true},"created":{"type":"string","format":"date-time","nullable":true},"policies":{"$ref":"#/components/schemas/TemplatePermissions"}},"additionalProperties":false},"TemplatePermissions":{"type":"object","properties":{"CanRead":{"type":"boolean","nullable":true},"CanWrite":{"type":"boolean","nullable":true},"CanDelete":{"type":"boolean","nullable":true},"CanShare":{"type":"boolean","nullable":true}},"additionalProperties":false},"TemplateProviderResponse":{"type":"object","properties":{"actions":{"$ref":"#/components/schemas/UIAction"},"resources":{"type":"array","items":{"$ref":"#/components/schemas/Template"},"nullable":true}},"additionalProperties":false},"TemplateType":{"enum":["Static","Dynamic"],"type":"string"},"TextAlignment":{"enum":["Left","Right","Center"],"type":"string"},"UIAction":{"type":"object","properties":{"details":{"type":"string","nullable":true}},"additionalProperties":false},"UpdateResourceRequest":{"required":["rid","state"],"type":"object","properties":{"rid":{"type":"string"},"state":{"$ref":"#/components/schemas/DocumentTemplateRequest"}},"additionalProperties":false},"UploadedFileItem":{"required":["fileId","fileName"],"type":"object","properties":{"fileName":{"type":"string"},"fileId":{"type":"string"},"overwrite":{"type":"boolean"},"isSystemFile":{"type":"boolean"},"shouldAppendVersion":{"type":"boolean"}},"additionalProperties":false},"User":{"type":"object","properties":{"id":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true}},"additionalProperties":false},"Variable":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"provider":{"type":"string","nullable":true},"entity":{"type":"string","nullable":true},"connectionRID":{"type":"string","nullable":true},"entityId":{"type":"string","nullable":true},"version":{"type":"string","nullable":true}},"additionalProperties":false},"WorkflowSettings":{"type":"object","properties":{"needApproval":{"type":"boolean"}},"additionalProperties":false}},"securitySchemes":{"https://auth.sharefiletest.io":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.sharefiletest.io/connect/authorize","tokenUrl":"https://auth.sharefiletest.io/connect/token","scopes":{"docgen:all.full":"Full access to Doc Gen APIs.","docgen:doctemplate.packaging":"Doc Template Packaging APIs Access","docgen:doctemplate.template-provider":"Document Templates full access to template provider","docgen:doctemplate.permanentdelete":"Access to permanently delete document template and metadata"}}}}}},"security":[{"https://auth.sharefiletest.io":["docgen:all.full","docgen:doctemplate.packaging","docgen:doctemplate.template-provider","docgen:doctemplate.permanentdelete"]}]}
```