Prepare a Run

Prepare a Run

curl --request POST \
  --url https://api.generalvalidation.com/api/v1/fabric/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pair_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.generalvalidation.com/api/v1/fabric/runs"

payload = {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pair_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    pair_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.generalvalidation.com/api/v1/fabric/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.generalvalidation.com/api/v1/fabric/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'pair_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.generalvalidation.com/api/v1/fabric/runs"

	payload := strings.NewReader("{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pair_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.generalvalidation.com/api/v1/fabric/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pair_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.generalvalidation.com/api/v1/fabric/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pair_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "config": {},
  "created_at": "<string>",
  "error_code": "submission_unknown",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pair_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payload_base64": "<string>",
  "result": {
    "pair_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "results": [
      {
        "function": "COUNT_ROWS",
        "reason_code": "equal",
        "status": "passed",
        "test_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "compared_count": 4503599627370495,
        "mismatch_count": 4503599627370495
      }
    ],
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "passed"
  },
  "settings": {
    "api_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lakehouse_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "spark_job_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "status": "prepared",
  "updated_at": "<string>",
  "provenance": "user_reported",
  "report": {
    "token": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

POST

api

fabric

runs

Prepare a Run

curl --request POST \
  --url https://api.generalvalidation.com/api/v1/fabric/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pair_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.generalvalidation.com/api/v1/fabric/runs"

payload = {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pair_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    pair_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.generalvalidation.com/api/v1/fabric/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.generalvalidation.com/api/v1/fabric/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'pair_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.generalvalidation.com/api/v1/fabric/runs"

	payload := strings.NewReader("{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pair_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.generalvalidation.com/api/v1/fabric/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pair_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.generalvalidation.com/api/v1/fabric/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pair_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "config": {},
  "created_at": "<string>",
  "error_code": "submission_unknown",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pair_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payload_base64": "<string>",
  "result": {
    "pair_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "results": [
      {
        "function": "COUNT_ROWS",
        "reason_code": "equal",
        "status": "passed",
        "test_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "compared_count": 4503599627370495,
        "mismatch_count": 4503599627370495
      }
    ],
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "passed"
  },
  "settings": {
    "api_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lakehouse_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "spark_job_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "status": "prepared",
  "updated_at": "<string>",
  "provenance": "user_reported",
  "report": {
    "token": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

{
  "code": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "diagnostics": {}
}

Authorizations

Authorization

string

header

required

Microsoft Entra application token issued by the caller's Organization tenant for this multitenant API. Request the .default scope and assign the application the required GV.APIReader, GV.APIContributor, or GV.APIOwner role.

Body

application/json

string<uuid>

required

A new UUID you choose for the Run. Repeating the request with the same ID returns the same Run.

pair_id

string<uuid>

required

The Table Pair to run. It needs at least one Test.

Response

Successful Response

config

RunConfig · object

required

The Table Pair and Tests this Run froze when it was prepared.

created_at

string

required

error_code

enum<string> | null

required

Why the Run has no Result. no_report means nothing recorded a Result or failure within 7 days of preparing the Run; a Result recorded later still replaces it.

Available options:

submission_unknown,

submission_rejected,

no_report,

fabric_job_failed,

fabric_job_cancelled,

invalid_arguments,

invalid_config,

run_reservation_failed,

artifact_write_failed,

summary_too_large,

execution_failed

string<uuid>

required

job_id

string<uuid> | null

required

The Fabric job instance that runs it, once recorded.

pair_id

string<uuid>

required

The Table Pair this Run validates.

payload_base64

string

required

Pass unchanged as the validation pipeline's payload_base64 parameter. Only POST /api/v1/fabric/runs returns it.

result

RunResult · object | null

required

The verdict and each Test's Result, once validation reports them.

Show child attributes

settings

FabricSettings · object

required

The Environment the Run was prepared for.

Show child attributes

status

enum<string>

required

prepared or submitted while the Run is on its way; passed, failed, or error once it ends.

Available options:

prepared,

submitted,

passed,

failed,

error

updated_at

string

required

provenance

string

default:user_reported

Reported by an authorized caller; the SaaS does not attest the Fabric computation.

Allowed value: "user_reported"

report

RunReportCredential · object | null

Pass token unchanged as the validation pipeline's report_token parameter. Returned only by the call that created the Run; a repeat with the same Run ID omits it.

Show child attributes

Using the API

Endpoints

Authorizations

Body

Response