QIMA Logo
API Reference

8 categories • 44 endpoints

  • All APIs

    44

    • Quick Actions
    Getting StartedDocumentation
    Report
    v1.0.0

    Get inspection PDF report file info

    Request
    Query Parameters
    NameTypeLocationRequiredDescription
    userIdstringpathYesQIMA client user login ID.
    productIdstringpathYesInspection product id, please refer to product id returned in /user/{userId}/reports
    isSingleFilestringqueryNoSet to `true` to request a single merged PDF file. If omitted or `false`, separate files per report section may be returned.
    Responses
    200
    File meta info will be returned

    Content-Type: application/json

    message
    string
    FieldTypeDescription
    messagestring
    FieldTypeDescription
    idstringFile id
    srcIdstringSource id, related resource it
    fileTypestringFile type in QIMA, describe the file is used for what purpose
    fileNamestringFile name
    commentsstringComments saved by uploader
    objectKeystringFile path on S3
    fileSizeintegerFile size in bytes
    versionintegerVersion of the file, starts from 1
    s3UrlstringTemporary url of the file on S3
    createDatestringFile creation date, in `dd-MMM-yyyy` format (e.g. "02-Jul-2026").
    updateDatestringFile last-updated date, in `dd-MMM-yyyy` format (e.g. "02-Jul-2026").
    {
  "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"
    }
  ]
}

    Content-Type: application/json

    GET
    /user/{userId}/report/{productId}/pdf-info
    Request samples

    application/json

    {}
    Response samples

    application/json

    { "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" } ] }