Skip to main content
PUT
/
canvas
/
positions
Save Positions
curl --request PUT \
  --url https://api.example.com/canvas/positions \
  --header 'Content-Type: application/json' \
  --data '
{
  "positions": {}
}
'
import requests

url = "https://api.example.com/canvas/positions"

payload = { "positions": {} }
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({positions: {}})
};

fetch('https://api.example.com/canvas/positions', 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://api.example.com/canvas/positions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'positions' => [
        
    ]
  ]),
  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://api.example.com/canvas/positions"

	payload := strings.NewReader("{\n  \"positions\": {}\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/canvas/positions")
  .header("Content-Type", "application/json")
  .body("{\n  \"positions\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/canvas/positions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"positions\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "positions": {}
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Request body for saving or updating node positions.

Positions are merged with existing state. Nodes not included in the request are left unchanged.

Attributes: positions: Map of resource ID to position to save (max 1000 entries).

​
positions
Positions · object
required

Response

Successful Response

Response body for canvas position queries.

Attributes: positions: Map of resource ID to node position.

​
positions
Positions · object