Report PDF Info Guide

Latest Update Time: 2026-07-02 00:00:00

Use this API to retrieve file metadata (file ID, name, size) for the PDF report(s) associated with an inspection product. Use the returned file id with Download a File by ID to download the actual PDF.

See the Report Introduction for base URL, authentication, and required headers.

Endpoint

GET https://ppapi.qima.com/user/{userId}/report/{productId}/pdf-info

Prerequisites

In addition to the required headers and authentication setup:

Permission to view inspection reports for the target client
A productId obtained from Search Inspection Reports

Path Parameters

Parameter	Required	Description
`userId`	Yes	QIMA client user login ID.
`productId`	Yes	Inspection product ID, from Search Inspection Reports.

Query Parameters

Parameter	Required	Description
`isSingleFile`	No	Set to `true` to request a single merged PDF file. If omitted or `false`, separate files per report section may be returned.

Request Example

curl --location --request GET 'https://ppapi.qima.com/user/<qima-user-id>/report/<product-id>/pdf-info' \
  --header 'Ai-Api-Access-Token: {your api access token}' \
  --header 'Ai-User-Id: {your user ID}' \
  --header 'Authorization: Bearer {your token}' \
  --header 'Referer: https://preprodmy.qima.com/'

Successful Response

content is an array of file metadata objects — one per PDF file (there can be more than one when isSingleFile isn't set to true).

{
    "message": null,
    "content": [
        {
            "id": "914F770452884174955B967809049B5F",
            "srcId": "1CD16979CD0A4947BE42610D02EAE5D2",
            "fileType": "PROD_FINAL_REPORT",
            "fileName": "R-Cloud-PP-25004672_SP2.pdf",
            "comments": "",
            "objectKey": "1CD16979CD0A4947BE42610D02EAE5D2/PROD_FINAL_REPORT/2186A27751F34806BD92E15E55524FF2/R-Cloud-PP-25004672_SP2.pdf",
            "fileSize": 95415,
            "version": 0,
            "s3Url": null,
            "createDate": "25-Aug-2025",
            "updateDate": "25-Aug-2025"
        }
    ]
}

Response Field Notes

Same ApiFileMetaBean shape as File Upload's response.

Field	Notes
`content[].id`	The file ID. Pass this to Download a File by ID to get the PDF content.
`content[].srcId`	Matches the `productId` you requested.
`content[].fileType`	`"PROD_FINAL_REPORT"` for the final inspection report PDF.
`content[].fileName`	Suggested filename, including the order number and product name.

Common Errors

See common authentication errors for 401 and 403 responses.

Status	Meaning	Recommended Action
`500 Internal Server Error`	Lookup failed on the server, e.g. an invalid `productId` or no report available yet.	Confirm `productId` is correct and the report has been issued.

Next Steps

Pass a result's id to Download a File by ID to retrieve the PDF binary.

Documents