Create a snapshot of an entity's current state
curl --request POST \
--url http://10.2.4.166:8080/composer/api/snapshots \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"itemType": "SOURCE",
"itemId": "src-123",
"changeSummary": "Updated connection string"
}
'import requests
url = "http://10.2.4.166:8080/composer/api/snapshots"
payload = {
"itemType": "SOURCE",
"itemId": "src-123",
"changeSummary": "Updated connection string"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
itemType: 'SOURCE',
itemId: 'src-123',
changeSummary: 'Updated connection string'
})
};
fetch('http://10.2.4.166:8080/composer/api/snapshots', 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://10.2.4.166:8080/composer/api/snapshots",
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([
'itemType' => 'SOURCE',
'itemId' => 'src-123',
'changeSummary' => 'Updated connection string'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/snapshots"
payload := strings.NewReader("{\n \"itemType\": \"SOURCE\",\n \"itemId\": \"src-123\",\n \"changeSummary\": \"Updated connection string\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/snapshots")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"itemType\": \"SOURCE\",\n \"itemId\": \"src-123\",\n \"changeSummary\": \"Updated connection string\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/snapshots")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"itemType\": \"SOURCE\",\n \"itemId\": \"src-123\",\n \"changeSummary\": \"Updated connection string\"\n}"
response = http.request(request)
puts response.read_body{
"snapshotId": "<string>",
"itemType": "SOURCE",
"itemId": "src-123",
"snapshotNumber": 1,
"changeSummary": "Updated connection string",
"createdByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}Create a snapshot of an entity's current state
Fetches the entity from the database and stores an immutable snapshot. The snapshot_number is auto-incremented per entity. MVP 1 supports SOURCE only.
Create a snapshot of an entity's current state
curl --request POST \
--url http://10.2.4.166:8080/composer/api/snapshots \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"itemType": "SOURCE",
"itemId": "src-123",
"changeSummary": "Updated connection string"
}
'import requests
url = "http://10.2.4.166:8080/composer/api/snapshots"
payload = {
"itemType": "SOURCE",
"itemId": "src-123",
"changeSummary": "Updated connection string"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
itemType: 'SOURCE',
itemId: 'src-123',
changeSummary: 'Updated connection string'
})
};
fetch('http://10.2.4.166:8080/composer/api/snapshots', 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://10.2.4.166:8080/composer/api/snapshots",
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([
'itemType' => 'SOURCE',
'itemId' => 'src-123',
'changeSummary' => 'Updated connection string'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/snapshots"
payload := strings.NewReader("{\n \"itemType\": \"SOURCE\",\n \"itemId\": \"src-123\",\n \"changeSummary\": \"Updated connection string\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/snapshots")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"itemType\": \"SOURCE\",\n \"itemId\": \"src-123\",\n \"changeSummary\": \"Updated connection string\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/snapshots")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"itemType\": \"SOURCE\",\n \"itemId\": \"src-123\",\n \"changeSummary\": \"Updated connection string\"\n}"
response = http.request(request)
puts response.read_body{
"snapshotId": "<string>",
"itemType": "SOURCE",
"itemId": "src-123",
"snapshotNumber": 1,
"changeSummary": "Updated connection string",
"createdByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}Authorizations
HTTP Basic authentication using global administrator credentials (username and password).
Body
application/vnd.composer.v3+json
Request body for creating an entity snapshot
Entity type to snapshot. Supported: SOURCE
Available options:
SOURCE, VISUAL, DASHBOARD Example:
"SOURCE"
ID of the entity to snapshot
Minimum string length:
1Example:
"src-123"
Optional human-readable description of what changed
Maximum string length:
500Example:
"Updated connection string"
Response
The snapshot was created
Response body for a created entity snapshot
Unique identifier of the snapshot
Entity type that was snapshotted
Example:
"SOURCE"
ID of the entity that was snapshotted
Example:
"src-123"
Auto-incremented snapshot number within this entity's history
Example:
1
Optional human-readable description of what changed
Example:
"Updated connection string"
ID of the user who created the snapshot
Timestamp when the snapshot was created
Was this page helpful?