Create
Create a bookmark for an artifact version.
curl --request POST \
--url https://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks \
--header 'Content-Type: application/json' \
--data '
{
"artifactId": "<string>",
"execution": {
"domain": "<string>",
"name": "<string>",
"project": "<string>"
}
}
'import requests
url = "https://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks"
payload = {
"artifactId": "<string>",
"execution": {
"domain": "<string>",
"name": "<string>",
"project": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
artifactId: '<string>',
execution: {domain: '<string>', name: '<string>', project: '<string>'}
})
};
fetch('https://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks', 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://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks",
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([
'artifactId' => '<string>',
'execution' => [
'domain' => '<string>',
'name' => '<string>',
'project' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks"
payload := strings.NewReader("{\n \"artifactId\": \"<string>\",\n \"execution\": {\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks")
.header("Content-Type", "application/json")
.body("{\n \"artifactId\": \"<string>\",\n \"execution\": {\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"artifactId\": \"<string>\",\n \"execution\": {\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"artifactId": "<string>",
"bookmarked": true,
"createdAt": "2023-11-07T05:31:56Z",
"execution": {
"domain": "<string>",
"name": "<string>",
"project": "<string>"
},
"executionDetails": {
"workflowCreatedAt": "2023-11-07T05:31:56Z",
"workflowName": "<string>",
"workflowVersion": "<string>"
},
"exports": [
{
"createdAt": "2023-11-07T05:31:56Z",
"exportTargetId": "<string>",
"tags": {},
"type": "<string>",
"uri": "<string>",
"$schema": "https://example.com/schemas/ArtifactVersionExportInfo.json"
}
],
"files": [
{
"createdAt": "2023-11-07T05:31:56Z",
"format": "<string>",
"jobId": "<string>",
"name": "<string>",
"nodeId": "<string>",
"nodeVariable": "<string>",
"sizeBytes": 123,
"source": "<string>",
"taskName": "<string>",
"$schema": "https://example.com/schemas/ArtifactFileInfo.json"
}
],
"name": "<string>",
"type": "<string>",
"userId": "<string>",
"userName": "<string>",
"$schema": "https://example.com/schemas/ArtifactVersionExtendedDetails.json"
}{
"$schema": "https://example.com/schemas/ErrorModel.json",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Body
Response
OK
UUID such as d1a2dfd5-1050-4538-8b29-ec254af2f7a4. It identifies the artifact which contains this artifact version. It is a hash of project / domain / execution / name / type.
Whether or not this artifact version is bookmarked
Time of execution creation, for the workflow execution which created this artifact version
Workflow execution identifier
Show child attributes
Show child attributes
Workflow execution details
Show child attributes
Show child attributes
List of exports of this artifact, such as exports-to-datasets
Show child attributes
Show child attributes
Map of filename to ArtifactFile
Show child attributes
Show child attributes
Type: report, data, model
ID of the user who created the artifact
Username of the user who created the artifact
A URL to the JSON Schema for this object.
"https://example.com/schemas/ArtifactVersionExtendedDetails.json"
Was this page helpful?
curl --request POST \
--url https://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks \
--header 'Content-Type: application/json' \
--data '
{
"artifactId": "<string>",
"execution": {
"domain": "<string>",
"name": "<string>",
"project": "<string>"
}
}
'import requests
url = "https://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks"
payload = {
"artifactId": "<string>",
"execution": {
"domain": "<string>",
"name": "<string>",
"project": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
artifactId: '<string>',
execution: {domain: '<string>', name: '<string>', project: '<string>'}
})
};
fetch('https://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks', 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://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks",
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([
'artifactId' => '<string>',
'execution' => [
'domain' => '<string>',
'name' => '<string>',
'project' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks"
payload := strings.NewReader("{\n \"artifactId\": \"<string>\",\n \"execution\": {\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks")
.header("Content-Type", "application/json")
.body("{\n \"artifactId\": \"<string>\",\n \"execution\": {\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/flows/api/artifacts/v1/bookmarks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"artifactId\": \"<string>\",\n \"execution\": {\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"artifactId": "<string>",
"bookmarked": true,
"createdAt": "2023-11-07T05:31:56Z",
"execution": {
"domain": "<string>",
"name": "<string>",
"project": "<string>"
},
"executionDetails": {
"workflowCreatedAt": "2023-11-07T05:31:56Z",
"workflowName": "<string>",
"workflowVersion": "<string>"
},
"exports": [
{
"createdAt": "2023-11-07T05:31:56Z",
"exportTargetId": "<string>",
"tags": {},
"type": "<string>",
"uri": "<string>",
"$schema": "https://example.com/schemas/ArtifactVersionExportInfo.json"
}
],
"files": [
{
"createdAt": "2023-11-07T05:31:56Z",
"format": "<string>",
"jobId": "<string>",
"name": "<string>",
"nodeId": "<string>",
"nodeVariable": "<string>",
"sizeBytes": 123,
"source": "<string>",
"taskName": "<string>",
"$schema": "https://example.com/schemas/ArtifactFileInfo.json"
}
],
"name": "<string>",
"type": "<string>",
"userId": "<string>",
"userName": "<string>",
"$schema": "https://example.com/schemas/ArtifactVersionExtendedDetails.json"
}{
"$schema": "https://example.com/schemas/ErrorModel.json",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}