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>"
  ]
}
'
{
  "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"
    }
  ]
}

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