Preview Adhesion Term
This endpoint allows previewing an Adhesion Term draft for a specific operation using a predefined template.
Request
ENDPOINT
/commercial_paper/operation/OPERATION-KEY/preview_adhesion_termMETHOD
POSTPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
OPERATION-KEY * | string | Unique operation key (UUID v4). | 36 |
Request Body
{
"template_key": "48e2c597-f2ca-487e-9f06-2b628ecb831e"
}
Request Body Params
| Field | Type | Description | Required |
|---|---|---|---|
template_key * | string | Unique key of the new template to be used (UUID v4). | Yes |
Response
STATUS
201Response Body
{
"operation_key": "a846cc4a-b542-4f66-9823-b6d5458bd127",
"document_type": "adhesion_term",
"document_base64": "dGVzdGVfZG9jdW1lbnRfYmFzZTY0"
}
Response Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
operation_key * | string | Unique operation key (UUID v4). | 36 |
document_type * | string | Type of generated document. Will always be adhesion_term. | 50 |
document_base64 * | string | Generated document content, encoded in Base64. | - |