Skip to content
Optiwork API Docs

Read the nodes touched after an id

GET
/drives/{drive}/wal/nodes/since/{nodeWalEntryId}
curl --request GET \
  --url 'https://work.optidata.cloud/api/drives/1/wal/nodes/since/950294?page=1' \
  --header 'Authorization: Bearer <token>'

The nodes mentioned in the journal after {nodeWalEntryId}, each already carrying its content, locks and owner — everything needed to reconcile, without a second round trip per node. Each node is reported once, however many entries touched it, and the highest journal id covered by the page is returned as latest_node_wal_entry_id. Each node also lists, in event_classes, the kinds of change that touched it in the range, so a client can tell a share or permission change from a content change without reading GET /drives/{drive}/wal/since/{nodeWalEntryId}.

Each node’s content.base_content_hash says which version its current content was written from, so a client can tell an edit of its own last committed version from an overwrite of it.

Pass optiwork_session_id to skip the changes your own session made.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
drive
required
integer format: int64

Numeric id of the drive. Read it from GET /drives/config.json.

nodeWalEntryId
required
integer format: int64

Journal id to read from. Entries after this id are returned; pass the highest id you have already processed.

Query Parameters

Section titled “Query Parameters”
optiwork_session_id
string

Your session identifier. Entries produced by it are filtered out, so a client does not process its own writes.

pageSize
integer
>= 1

Number of items per page.

page
integer
default: 1 >= 1

1-based page number.

Responses

Section titled “ Responses ”

200

Section titled “200”

A page of changed nodes.

Media typeapplication/json
object
latest_node_wal_entry_id
required

Highest journal id covered by this page. Use it as the next {nodeWalEntryId}.

integer | null format: int64
nodes
required
object
current_page
required
integer
data
required
Array
first_page_url
string | null format: uri
from
integer | null
last_page

Absent on endpoints that use the simple paginator.

integer
last_page_url
string | null format: uri
links
Array<object>

Navigation links of a paginated envelope.

object
url
string | null format: uri
label
string
page
integer | null
active
boolean
next_page_url
string | null format: uri
path
string format: uri
per_page
required
integer
prev_page_url
string | null format: uri
to
integer | null
total

Absent on endpoints that use the simple paginator.

integer
data
required
Array
object
id
required
integer format: int64
parent_id

Parent folder id. null marks a company folder (top level).

integer | null format: int64
drive_id
required
integer format: int64
user_id

Owner of the node.

integer format: int64
uuid
string
cuid
string
type
required

1 = folder, 2 = file.

integer
Allowed values: 1 2
name
required
string
is_folder
boolean
is_file
boolean
is_coeditable

Whether the file can be co-edited in the online editor.

boolean
is_cold

Whether the node lives in cold storage. Present only on detail reads.

boolean
is_delete_target

true when this node was the explicit target of a delete; null when it was removed only because an ancestor was deleted.

boolean | null
ltree_path

Materialised ancestor path, dot separated ids.

string | null
group_id
integer | null format: int64
node_content_id

Current content version of the file.

integer | null format: int64
oldest_node_content_id
integer | null format: int64
guest_data_id
integer | null format: int64
content_path
string | null
content_mime_type
string | null
content_size_bytes
integer | null format: int64
content_thumbnail_url
string | null format: uri
content
One of:

One stored version of a file’s bytes.

object
id
integer format: int64
node_id
integer format: int64
path

Opaque storage path of this content version.

string
mime_type
string
size_bytes
integer format: int64
hash_sha256

SHA-256 of this version, the value a caller sends back as base_content_hash.

string | null
base_content_hash

The hash_sha256 of the version this one was written from, as sent in base_content_hash and accepted by the server. null when the write carried no base. Equal to the hash a sync client last committed: the other side edited that version. Different, or null: the client cannot tell, and should keep a conflict copy.

string | null
created_at
string format: date-time
updated_at
string format: date-time
actions

The caller’s effective permission level on this node. Present on listings derived from shares.

string
Allowed values: none view edit share owner manage
user
One of:

A user of the tenant.

object
id
integer format: int64
uuid
string format: uuid
cuid

Identifier of the company (tenant) the user belongs to.

string
username
string
email
string format: email
name
string
full_name
string
company_name
string
role

Role of the user inside the tenant.

string
status
string
Allowed values: active inactive blocked
avatar_url
string | null format: uri
created_at
string format: date-time
updated_at
string format: date-time
deleted_at
string | null format: date-time
profile

Profile extras (avatar, job title). Loaded only where noted.

object | null
groups

Groups the user belongs to. Loaded only where noted.

Array<object>

A group of users inside the tenant.

object
id
integer format: int64
guid

Tenant-wide identifier of the group; used in paths.

string format: uuid
name
string
description
string | null
email
string | null format: email
cuid
string
memberships

Members of the group, each with its embedded user.

Array<object>
object
key
additional properties
any
userStatus

Presence status of the user. Loaded only where noted.

object | null
status_details

Rendered presence details (type, icon, message). Present on dashboard listings.

object | null
customization

Per-node presentation settings (colour, shared flag).

object | null
markers
Array<object>

A per-user flag on a node.

object
id
integer format: int64
node_id
integer format: int64
user_id
integer format: int64
type

Kind of marker.

string
Allowed values: favorite important
created_at
string format: date-time
tags
Array<object>
object
key
additional properties
any
lock
One of:

An advisory lock held on a file while it is being edited. Take one before replacing the content of a file another user could be working on.

object
id
integer format: int64
node_id
integer format: int64
user_id
integer format: int64
note

Free-text reason shown to other users.

string | null
origin

Free-text label naming the client that took the lock.

string | null
user_hash

Opaque per-installation identifier of the lock holder.

string | null
expires_at
string | null format: date-time
created_at
string format: date-time
updated_at
string format: date-time
user
One of:

A user of the tenant.

object
id
integer format: int64
uuid
string format: uuid
cuid

Identifier of the company (tenant) the user belongs to.

string
username
string
email
string format: email
name
string
full_name
string
company_name
string
role

Role of the user inside the tenant.

string
status
string
Allowed values: active inactive blocked
avatar_url
string | null format: uri
created_at
string format: date-time
updated_at
string format: date-time
deleted_at
string | null format: date-time
profile

Profile extras (avatar, job title). Loaded only where noted.

object | null
groups

Groups the user belongs to. Loaded only where noted.

Array<object>

A group of users inside the tenant.

object
id
integer format: int64
guid

Tenant-wide identifier of the group; used in paths.

string format: uuid
name
string
description
string | null
email
string | null format: email
cuid
string
memberships

Members of the group, each with its embedded user.

Array<object>
object
key
additional properties
any
userStatus

Presence status of the user. Loaded only where noted.

object | null
status_details

Rendered presence details (type, icon, message). Present on dashboard listings.

object | null
locks
Array<object>

An advisory lock held on a file while it is being edited. Take one before replacing the content of a file another user could be working on.

object
id
integer format: int64
node_id
integer format: int64
user_id
integer format: int64
note

Free-text reason shown to other users.

string | null
origin

Free-text label naming the client that took the lock.

string | null
user_hash

Opaque per-installation identifier of the lock holder.

string | null
expires_at
string | null format: date-time
created_at
string format: date-time
updated_at
string format: date-time
user
One of:

A user of the tenant.

object
id
integer format: int64
uuid
string format: uuid
cuid

Identifier of the company (tenant) the user belongs to.

string
username
string
email
string format: email
name
string
full_name
string
company_name
string
role

Role of the user inside the tenant.

string
status
string
Allowed values: active inactive blocked
avatar_url
string | null format: uri
created_at
string format: date-time
updated_at
string format: date-time
deleted_at
string | null format: date-time
profile

Profile extras (avatar, job title). Loaded only where noted.

object | null
groups

Groups the user belongs to. Loaded only where noted.

Array<object>

A group of users inside the tenant.

object
id
integer format: int64
guid

Tenant-wide identifier of the group; used in paths.

string format: uuid
name
string
description
string | null
email
string | null format: email
cuid
string
memberships

Members of the group, each with its embedded user.

Array<object>
object
key
additional properties
any
userStatus

Presence status of the user. Loaded only where noted.

object | null
status_details

Rendered presence details (type, icon, message). Present on dashboard listings.

object | null
created_at
string format: date-time
updated_at
string format: date-time
deleted_at

Non-null while the node is in the trash.

string | null format: date-time
latest_node_wal_entry_id
required

Id of the newest journal entry that touched this node after {nodeWalEntryId}, among those not skipped by optiwork_session_id.

integer
event_classes
required

Distinct event_class values of the journal entries that touched this node after {nodeWalEntryId}, sorted ascending. The same fully qualified names GET /drives/{drive}/wal/since/{nodeWalEntryId} returns in event_class. Entries skipped by optiwork_session_id contribute nothing. Never empty: a node appears only when an entry touched it.

Array<string>
Example
{
  "nodes": {
    "current_page": 1,
    "per_page": 30,
    "data": [
      {
        "id": 300754,
        "drive_id": 1,
        "type": 1,
        "name": "Contracts",
        "ltree_path": "300754.665198",
        "content_mime_type": "application/pdf",
        "content_size_bytes": 148213,
        "content": {
          "id": 613488,
          "mime_type": "application/pdf",
          "size_bytes": 148213
        },
        "actions": "none",
        "user": {
          "id": 15,
          "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
          "cuid": "a1b2c3d4-2226-46c1-91b2-a9e9ba4c2d5b",
          "username": "jane.doe@acme.example",
          "email": "jane.doe@acme.example",
          "name": "Jane Doe",
          "full_name": "Jane Doe",
          "company_name": "Acme",
          "role": "super-admin",
          "status": "active",
          "groups": [
            {
              "id": 560,
              "guid": "a19d5670-335d-4285-8ee4-fcb54cb70faf",
              "name": "Finance"
            }
          ]
        },
        "markers": [
          {
            "type": "favorite"
          }
        ],
        "lock": {
          "user": {
            "id": 15,
            "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
            "cuid": "a1b2c3d4-2226-46c1-91b2-a9e9ba4c2d5b",
            "username": "jane.doe@acme.example",
            "email": "jane.doe@acme.example",
            "name": "Jane Doe",
            "full_name": "Jane Doe",
            "company_name": "Acme",
            "role": "super-admin",
            "status": "active",
            "groups": [
              {
                "id": 560,
                "guid": "a19d5670-335d-4285-8ee4-fcb54cb70faf",
                "name": "Finance"
              }
            ]
          }
        },
        "locks": [
          {
            "user": {
              "id": 15,
              "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
              "cuid": "a1b2c3d4-2226-46c1-91b2-a9e9ba4c2d5b",
              "username": "jane.doe@acme.example",
              "email": "jane.doe@acme.example",
              "name": "Jane Doe",
              "full_name": "Jane Doe",
              "company_name": "Acme",
              "role": "super-admin",
              "status": "active",
              "groups": [
                {
                  "id": 560,
                  "guid": "a19d5670-335d-4285-8ee4-fcb54cb70faf",
                  "name": "Finance"
                }
              ]
            }
          }
        ],
        "event_classes": [
          "App\\Events\\Drive\\Node\\NodeUpdated",
          "App\\Events\\Drive\\Share\\SharePermissionUpdated"
        ]
      }
    ]
  }
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

404

Section titled “404”

The resource does not exist, or does not belong to the given drive.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplemissing
{
  "message": "No query results for model [App\\Models\\Node] 99999999"
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}