One version of a CodeGen script, with its text
curl --request GET \
--url http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version} \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"version": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"changeNote": "<string>",
"origin": "save",
"model": "<string>",
"commitSha": "<string>",
"fingerprintMatchesCurrent": true,
"isLive": true,
"kind": "dataQuality",
"script": "<string>",
"fingerprint": "<string>",
"generatedAt": "2023-11-07T05:31:56Z",
"contractVersion": 123,
"storage": "<string>",
"repoPath": "<string>"
}Pipelines
One version of a CodeGen script, with its text
Requires pipeline:read.
GET
/
api
/
v1
/
pipelines
/
{name}
/
codegen-scripts
/
{kind}
/
versions
/
{version}
One version of a CodeGen script, with its text
curl --request GET \
--url http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version} \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/pipelines/{name}/codegen-scripts/{kind}/versions/{version}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"version": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"changeNote": "<string>",
"origin": "save",
"model": "<string>",
"commitSha": "<string>",
"fingerprintMatchesCurrent": true,
"isLive": true,
"kind": "dataQuality",
"script": "<string>",
"fingerprint": "<string>",
"generatedAt": "2023-11-07T05:31:56Z",
"contractVersion": 123,
"storage": "<string>",
"repoPath": "<string>"
}Authorizations
Optional API key for authentication (enabled via application.yaml)
Path Parameters
Available options:
dataQuality, transformation Response
The version
One version of a pipeline's CodeGen script, without its text.
Key label or user that made the change; null for a run.
For example (seeded from pre-versioning state), restored from version 2, imported from catalog archive, adopted repository commit abc1234.
Available options:
save, run, regenerate, repository, restore, restore-version The CodeGen model that wrote this text.
Code repository only. The commit holding this text.
True when the version was written for the pipeline's current instruction and source schema (only those versions can be restored).
True for the version runs execute now.
Available options:
dataQuality, transformation The script text of this version.
