Requests

Download request PDF

Changed on

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

Request

Path parameters

idinteger required

The identifier for target request.

Query parameters

request.request_idinteger

Query by request identifier.

request.request_template_idinteger

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.

Changes

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • info

      api operation id GETv1_Requests_id_pdf-request_id-request_id-request_template_id-request_temp removed and replaced with GETv1_Requests_id_pdf?request_id=request_id&request_template_id=request_template_id&special_message=special_message&attach_pdf_to_request=attach_pdf_to_request