Document Resources API
Endpoint Index
Action | Endpoint |
---|---|
Fetch a Document Resource by Name | GET /resource/{tenantLocator}/documents/{name} |
Create a New Document Resource | POST /resource/{tenantLocator}/documents |
Update a Document Resource | PATCH /resource/{tenantLocator}/documents/{name} |
Fetch a Template | GET /resource/{tenantLocator}/templates/{name} |
Upload a Velocity Template | POST /resource/{tenantLocator}/templates/velocity |
Update a Velocity Template | PATCH /resource/{tenantLocator}/templates/velocity |
Upload a Liquid Template | POST /resource/{tenantLocator}/templates/liquid |
Update a Liquid Template | PATCH /resource/{tenantLocator}/templates/liquid |
Document Resources
GET /resource/{tenantLocator}/documents/{name}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
name | path | string | required |
byStaticName | query | boolean? | optional |
date | query | datetime? | optional |
Response:StreamingResponseBody<string>
Security Group:documents  Permission:read
POST /resource/{tenantLocator}/documents
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Content-Type | header | string | required |
name | query | string | required |
staticName | query | string | required |
Request:file
Response:BasicResourceResponse
Security Group:documents  Permission:upload
PATCH /resource/{tenantLocator}/documents/{name}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Content-Type | header | string | required |
name | path | string | required |
Request:file
Response:BasicResourceResponse
Security Group:documents  Permission:update
Document Templates
GET /resource/{tenantLocator}/templates/{name}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
name | path | string | required |
byStaticName | query | boolean? | optional |
date | query | datetime? | optional |
Response:StreamingResponseBody<string>
Security Group:templates  Permission:read
POST /resource/{tenantLocator}/templates/velocity
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
name | query | string | required |
staticName | query | string | required |
Request with text/plain:TemplateResponse
Request with multipart/form-data:TemplateResponse
Response:BasicResourceResponse
Security Group:templates  Permission:upload
PATCH /resource/{tenantLocator}/templates/velocity
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
name | query | string | required |
Request with text/plain:TemplateResponse
Request with multipart/form-data:TemplateResponse
Response:BasicResourceResponse
Security Group:templates  Permission:upload
POST /resource/{tenantLocator}/templates/liquid
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
name | query | string | required |
staticName | query | string | required |
Request with text/plain:TemplateResponse
Request with multipart/form-data:TemplateResponse
Response:BasicResourceResponse
Security Group:templates  Permission:upload
PATCH /resource/{tenantLocator}/templates/liquid
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
name | query | string | required |
Request with text/plain:TemplateResponse
Request with multipart/form-data:TemplateResponse
Response:BasicResourceResponse
Security Group:templates  Permission:upload
Note
Document templates are limited to 5MB in size.
StreamingResponseBody
¶no fields