Inspect a schema journal using its journal ID or the originating schema job ID. Reports preserve recovery state and public business definitions without physical identifiers.
curl --request GET \
--url http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}', 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 => "4310",
CURLOPT_URL => "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"databaseId": "<string>",
"tableId": "<string>",
"kind": "<string>",
"state": "<string>",
"phase": "planned",
"expectedSchemaVersion": 1073741824,
"request": {
"kind": "database.create",
"name": "<string>",
"description": "<string>"
},
"before": {
"table": {
"id": "<string>",
"databaseId": "<string>",
"orgId": "<string>",
"name": "<string>",
"schemaVersion": 1073741824,
"rowCount": 2500000,
"state": "active",
"createdAt": "2024-01-01T12:30:00.000Z",
"updatedAt": "2024-01-01T12:30:00.000Z",
"description": "<string>"
},
"fields": [
{
"id": "<string>",
"name": "<string>",
"type": "text",
"required": true,
"default": true,
"order": 99,
"charLimit": 123
}
]
},
"verification": {
"transactional": true,
"fieldId": "<string>",
"nextField": {
"id": "<string>",
"name": "<string>",
"type": "text",
"required": true,
"default": true,
"order": 99,
"charLimit": 123
}
},
"createdAt": "2024-01-01T12:30:00.000Z",
"committedAt": "2024-01-01T12:30:00.000Z",
"change": {
"kind": "add_field",
"field": {}
},
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"jobId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}Get schema operation
Inspect a schema journal using its journal ID or the originating schema job ID. Reports preserve recovery state and public business definitions without physical identifiers.
GET
/
v1
/
orgs
/
{orgId}
/
databases
/
{databaseId}
/
tables
/
{tableId}
/
schema
/
operations
/
{id}
Inspect a schema journal using its journal ID or the originating schema job ID. Reports preserve recovery state and public business definitions without physical identifiers.
curl --request GET \
--url http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}', 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 => "4310",
CURLOPT_URL => "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"databaseId": "<string>",
"tableId": "<string>",
"kind": "<string>",
"state": "<string>",
"phase": "planned",
"expectedSchemaVersion": 1073741824,
"request": {
"kind": "database.create",
"name": "<string>",
"description": "<string>"
},
"before": {
"table": {
"id": "<string>",
"databaseId": "<string>",
"orgId": "<string>",
"name": "<string>",
"schemaVersion": 1073741824,
"rowCount": 2500000,
"state": "active",
"createdAt": "2024-01-01T12:30:00.000Z",
"updatedAt": "2024-01-01T12:30:00.000Z",
"description": "<string>"
},
"fields": [
{
"id": "<string>",
"name": "<string>",
"type": "text",
"required": true,
"default": true,
"order": 99,
"charLimit": 123
}
]
},
"verification": {
"transactional": true,
"fieldId": "<string>",
"nextField": {
"id": "<string>",
"name": "<string>",
"type": "text",
"required": true,
"default": true,
"order": 99,
"charLimit": 123
}
},
"createdAt": "2024-01-01T12:30:00.000Z",
"committedAt": "2024-01-01T12:30:00.000Z",
"change": {
"kind": "add_field",
"field": {}
},
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"jobId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}Authorizations
apiKeyoauth
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Response
Authorised operation result.
Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Required string length:
1 - 128Required string length:
1 - 64Available options:
planned, running, committed, failed, historical, unknown Required range:
1 <= x <= 2147483647- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
UTC instant with mandatory Z and at most three fractional digits.
Pattern:
^(?!0000)\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,3})?Z$Example:
"2024-01-01T12:30:00.000Z"
UTC instant with mandatory Z and at most three fractional digits.
Pattern:
^(?!0000)\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,3})?Z$Example:
"2024-01-01T12:30:00.000Z"
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Was this page helpful?
