Skip to main content
Version: 2508.1

Result File Download API

GEThttps://ondemand.sparrowcloud.ai/api/v2/analysis/{analysisId}/result

Description

This API is for downloading results after analysis is completed. This request can be made only for analyses that ended with SUCCESS. When you send a download request, you will receive the analysis results as a file.

Request​

The Analysis ID received in the response when you requested analysis using the analysis request API is required. To check the Analysis ID, send a Request Query API or check the ID of the previously requested analysis through the dashboard at Sparrow On-Demand Home.

Response​

When you send a result file download request, you will receive a zip file. For details, refer to Response.

Request

pathName :analysisIdapi 스펙과 일치하지 않는 pathName 입니다.

Response

✔️ Success Response​

If the result download request is successful, the result.zip file is downloaded along with 200 OK.

responses:
'200':
  description: File download
  content:
    application/download:
      schema:
        type: string
        format: binary
result.zip/
    /summary.json
    /asset
    /sbom
        SPDX.spdx
        CycloneDX.json
        SWID.zip
        ...
    /licenseNotice
        HTML.html
        MARKDOWN.md
        TXT.txt
    /issue
        1.json
        2.json
        ...
    /workMessage.json

The downloaded file is compressed in result.zip format. For details, check Downloaded Files.

❌ Failure Response​

Authentication Failure​

If authentication information is incorrect, you will receive a 401 Unauthorized response.

Invalid Request​

If the request is invalid, you will receive a 400 Bad Request response along with the following information.