Document Resources API

Document Resources

Fetch a Document Resource by Name
fetchDocumentResourceByName
GET /resource/{tenantLocator}/documents/{name}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    namepathstringrequired
    byStaticNamequeryboolean?optional
    datequerydatetime?optional
    Response:StreamingResponseBody<string>
    Security Group:documents   Permission:read
Create a New Document Resource
createDocumentResource
POST /resource/{tenantLocator}/documents
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Content-Typeheaderstringrequired
    namequerystringrequired
    staticNamequerystringrequired
    Request:file
    Security Group:documents   Permission:upload
Update a Document Resource
updateDocument
PATCH /resource/{tenantLocator}/documents/{name}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Content-Typeheaderstringrequired
    namepathstringrequired
    Request:file
    Security Group:documents   Permission:update

Document Templates

Fetch a Template
fetchDocumentTemplate
GET /resource/{tenantLocator}/templates/{name}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    namepathstringrequired
    byStaticNamequeryboolean?optional
    datequerydatetime?optional
    Response:StreamingResponseBody<string>
    Security Group:templates   Permission:read
Upload a Velocity Template
createVelocityDocumentTemplate
POST /resource/{tenantLocator}/templates/velocity
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    namequerystringrequired
    staticNamequerystringrequired
    Request with text/plain:TemplateResponse
    Request with multipart/form-data:TemplateResponse
    Security Group:templates   Permission:upload
Update a Velocity Template
updateVelocityDocumentTemplate
PATCH /resource/{tenantLocator}/templates/velocity
Upload a Liquid Template
createLiquidDocumentTemplate
POST /resource/{tenantLocator}/templates/liquid
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    namequerystringrequired
    staticNamequerystringrequired
    Request with text/plain:TemplateResponse
    Request with multipart/form-data:TemplateResponse
    Security Group:templates   Permission:upload
Update a Liquid Template
updateLiquidDocumentTemplate
PATCH /resource/{tenantLocator}/templates/liquid

Note

Document templates are limited to 5MB in size.

StreamingResponseBody
no fields