Download a Single Attached File in a BP

GET ws/rest/service/v1/bp/record/download/file/{file_id}

where the file_id is the file that you want to download.

Purpose

This web service enables the external application to download a specific attachment in a specific BP record, using the file id, in a:

Shell or project, based on the shell or project number.
Company, if the shell or project number is not available or has not been provided.

If there is a revision performed on any attached files, the list API returns the latest revised file details.

If any of the attached files are revised (at the record level, or at the line item level), the API list will contain all those revised files.

Notes:

Reference files are not downloaded, only the base file is downloaded when using this REST API.
By design, there are no web services available for the Request for Bid (RFB) business process.

All parameters should be URL encoded.

Path Parameter

file_id

Specify the file id.

Octet-stream of the file along with JSON object containing 'status', 'data', 'message'

If the file id is valid, then the file content will come as a zip file, as a part of the response. To get the file, you must save the response.

Note: The output is in octet-stream format, which only has arbitrary binary data.