v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Requests

Download request PDF

Generate and download a PDF of a request. The request template you specify determines the format of the PDF. This can be used to create quotes.

get/v1/Requests/{id}/pdf

Path parameters

idinteger required

Format - int32. The identifier for target request.

Query parameters

request.request_idinteger

Format - int32. Query by request identifier.

request.request_template_idinteger

Format - int32. Query by template identifier.

request.special_messagestring

Query by all or part of message text.

request.attach_pdf_to_requestboolean

Limit returns by whether a PDF should be attached.

Response

OK

file_namestring

Name of the file, including extension.

lengthinteger

Data length of the file, in Bytes.

file_idinteger

The primary key indicating the file that has been downloaded.