EQTY LabDocs

Register manifest

Registers all statements and blobs from a manifest into a new graph under parent_id, and returns the new graph's UUID. The manifest can be sent as an object, a JSON string, base64 JSON, or gzip-compressed base64 JSON; an object that is not a valid manifest is refused before it is read. The caller needs create_declarations on the parent graph's project. The graph is created before its blobs and statements are written, so a request that fails part way leaves a partly filled graph, and retrying it creates another graph.

posthttps://<host>/manifest/v1
bash
curl --request POST \
  --url 'https://<host>/manifest/v1' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"manifest":{},"name":"Manifest Registration","parent_id":"00000000-0000-0000-0000-000000000000"}'
javascript
const response = await fetch("https://<host>/manifest/v1", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "manifest": {},
    "name": "Manifest Registration",
    "parent_id": "00000000-0000-0000-0000-000000000000"
  })
});

const data = await response.json();
typescript
interface ManifestRegistrationResponse {
  graph_id: string;
}

const response = await fetch("https://<host>/manifest/v1", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "manifest": {},
    "name": "Manifest Registration",
    "parent_id": "00000000-0000-0000-0000-000000000000"
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: ManifestRegistrationResponse = await response.json();
python
import requests

response = requests.post(
    "https://<host>/manifest/v1",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "manifest": {},
        "name": "Manifest Registration",
        "parent_id": "00000000-0000-0000-0000-000000000000",
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	body := strings.NewReader(`{
	  "manifest": {},
	  "name": "Manifest Registration",
	  "parent_id": "00000000-0000-0000-0000-000000000000"
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://<host>/manifest/v1", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://<host>/manifest/v1"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "manifest": {},
                  "name": "Manifest Registration",
                  "parent_id": "00000000-0000-0000-0000-000000000000"
                }
                """))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://<host>/manifest/v1");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "manifest": {},
      "name": "Manifest Registration",
      "parent_id": "00000000-0000-0000-0000-000000000000"
    }
    """, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://<host>/manifest/v1');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "manifest": {},
      "name": "Manifest Registration",
      "parent_id": "00000000-0000-0000-0000-000000000000"
    }
    JSON,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://<host>/manifest/v1")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "manifest": {},
    "name": "Manifest Registration",
    "parent_id": "00000000-0000-0000-0000-000000000000"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .post("https://<host>/manifest/v1")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "manifest": {},
            "name": "Manifest Registration",
            "parent_id": "00000000-0000-0000-0000-000000000000"
        }))
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · HTTP bearer (JWT)

Request bodyrequired

application/json
  • manifestobjectrequired

    Manifest payload to import. Accepts a manifest object, a JSON string, base64 JSON, or gzip+base64 JSON.

  • namestringrequired

    Human-readable name for the new graph created from this manifest import.

  • parent_idstringrequired

    UUID of the parent graph that the imported graph will be attached to.

Examplejson
{
  "manifest": {},
  "name": "Manifest Registration",
  "parent_id": "00000000-0000-0000-0000-000000000000"
}

Responses

200Manifest registered

application/json
  • graph_idstringrequired

    UUID of the graph created for the imported manifest.

Examplejson
{
  "graph_id": "00000000-0000-0000-0000-000000000000"
}

400A string manifest payload does not decode to a manifest, a blob is not valid base64 or does not hash to the CID it is listed under, or (only without authentication) the parent graph does not exist

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}

401Missing or invalid bearer token

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}

403Caller lacks create_declarations on the parent's project, or the parent graph is unknown (with authentication an unknown parent is a 403, so callers cannot probe for graph ids)

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}

500Internal error

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}

503Auth Service or blob storage unavailable or misconfigured

application/json
  • callstackobject
    Show properties

    object | null

  • errorstringrequired
Examplejson
{
  "callstack": {},
  "error": "string"
}