DownloadSemanticResults

Updated at:

Returns the download URL of artifacts by job name and an optional run ID after a run completes. If JobRunId is not specified, the results of the most recent run of the job are returned.

Operation description

Scenarios

Retrieves temporary download URLs for result files of a submitted semantic job run, such as semantic model YAML artifacts. This operation returns download URLs and does not directly return file content.

Procedure

  1. Use the job name JobName to locate the job.

  2. To retrieve artifacts of a specific run, specify the JobRunId from the RunSemanticJob.Data.JobRunId or ListSemanticJobRuns response. If you do not specify this parameter, the artifacts of the most recent run are returned.

  3. Download the corresponding files from Data.Results[].DownloadUrl.

Before you begin

The download URL is a temporary credential. Use it only briefly on the client side. Do not write it to logs or store it for long-term use.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

JobName

string

Yes

The job name. You can obtain this value from Data.Name in the CreateSemanticJob response, Name in the ListSemanticJobs response, or JobName in the ListSemanticJobRuns response.

semantic-job-demo

JobRunId

string

No

The optional run ID. If you specify the JobRunId from the RunSemanticJob response (Data.JobRunId) or the ListSemanticJobRuns response, only the artifacts of the specified run are returned. If you do not specify this parameter, the artifacts of the most recent run of the job are returned.

01H00000000000000000000000

Construct the request parameters based on the description of each request field.

Response elements

Element

Type

Description

Example

object

The standard response for retrieving download URLs of run artifacts. Each item in Data.Results corresponds to a result file.

RequestId

string

The request ID. You can use this ID to locate logs and troubleshoot issues.

676271D6-53B4-57BE-89FA-72F7AE1418DF

Success

boolean

Indicates whether the request was successful.

Data

object

The collection of result files for the specified job run. Multiple items are returned if a single run generates multiple files.

Results

array<object>

The list of result files. Each item contains the associated job name, run ID, and a short-lived download URL.

object

A result file generated by a semantic job run.

JobName

string

The node name to which the artifact belongs. This value is the same as the JobName value in the request.

semantic-job-demo

JobRunId

string

The run ID to which the artifact belongs. You can compare this value with the Data.JobRunId value from the RunSemanticJob response or the JobRunId value from ListSemanticJobRuns.

01H00000000000000000000000

DownloadUrl

string

The temporary pre-signed download URL of the result file. Download the file by using an HTTP GET request as soon as possible. Do not log, share, or treat the full URL as a long-term address.

https://example.com/temporary-download-url

For the meaning of each response field and its relationship to subsequent calls, refer to the field descriptions.

Examples

Success response

JSON format

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "Results": [
      {
        "JobName": "semantic-job-demo",
        "JobRunId": "01H00000000000000000000000",
        "DownloadUrl": "https://example.com/temporary-download-url"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.