Skip to main content
POST
/
canvas
/
views
Create View
curl --request POST \
  --url https://api.example.com/canvas/views \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "search_query": "",
  "filters": [
    {
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "pinned_node_ids": [
    "<string>"
  ]
}
'
import requests

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

payload = {
    "name": "<string>",
    "search_query": "",
    "filters": [
        {
            "type": "<string>",
            "value": "<string>"
        }
    ],
    "pinned_node_ids": ["<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({
    name: '<string>',
    search_query: '',
    filters: [{type: '<string>', value: '<string>'}],
    pinned_node_ids: ['<string>']
  })
};

fetch('https://api.example.com/canvas/views', 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/views",
  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([
    'name' => '<string>',
    'search_query' => '',
    'filters' => [
        [
                'type' => '<string>',
                'value' => '<string>'
        ]
    ],
    'pinned_node_ids' => [
        '<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://api.example.com/canvas/views"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"search_query\": \"\",\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"pinned_node_ids\": [\n    \"<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://api.example.com/canvas/views")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"search_query\": \"\",\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"pinned_node_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"search_query\": \"\",\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"pinned_node_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "views": [
    {
      "name": "<string>",
      "id": "",
      "search_query": "",
      "filters": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "pinned_node_ids": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Request body for creating a saved canvas view.

Attributes: name: User-assigned name for this view. search_query: Text search query to persist. filters: Filter criteria to persist. pinned_node_ids: Resource IDs to pin when restoring.

name
string
required
search_query
string
default:""
filters
FilterCriteria · object[]
pinned_node_ids
string[]

Response

Successful Response

Response body for listing saved canvas views.

Attributes: views: List of saved canvas views.

views
CanvasView · object[]
required