Skip to content
calternal docs

Replace one view only at the client source revision (#731, DESIGN §2). The file hash check also rejects a concurrent Files write after the read.

PUT
/api/v1/notes/tasks/views/{id}
curl --request PUT \
  --url https://example.com/api/v1/notes/tasks/views/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'If-Match: example' \
  --data '{ "view": {} }'

Route: /api/v1/notes/tasks/views/{id}. Inputs: id, If-Match. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Header Parameters

Section titled “Header Parameters”
If-Match
required
string

Strong source ETag returned by the saved view read

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

A complete Obsidian Bases view object submitted for create or update (#430).

object
view
required

One Obsidian Bases view object. The route assigns or checks its stable ID.

object
Examplegenerated
{
  "view": {}
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

One stable saved view and its full Bases configuration (#430).

object
base_filters
One of:

File-wide Bases filters that are combined with this view’s own filters.

etag
required

Strong ETag of the complete source file. Required for replacement (#731).

string
id
required
string
view
required

Complete view configuration, including Obsidian and calternal extension fields.

object
Examplegenerated
{
  "base_filters": "example",
  "etag": "example",
  "id": "example",
  "view": {}
}

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

409

Section titled “409”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

412

Section titled “412”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

428

Section titled “428”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}