Skip to main content
Version: 2608.1

Download Result File API

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

Description

This API downloads the results after an analysis has ended. This request can be made only for analyses that ended successfully. When you send a download request, you receive the analysis results as a file.

Request​

You need the analysis ID that you received in the response when you requested the analysis with the analysis request API. To check the analysis ID, send the Request Inquiry API or check the ID of the analysis you requested earlier on the dashboard of the Sparrow On-Demand home.

Response​

When you send the result file download request, you receive a zip file. For details, see Response.

Request

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

Response

✔️ Success response​

If the result download request succeeds, you receive 200 OK and the result.zip file is downloaded.

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 as result.zip. For details, see The downloaded file.

❌ Failure response​

Authentication failure​

If the credentials are incorrect, you receive a 401 Unauthorized response.

Bad request​

For a bad request, you receive a 400 Bad Request response together with the following information.

  • resultCode: indicates the result of the request as a code. For details, see API result codes.