Read journal entries after an id

GET

/drives/{drive}/wal/since/{nodeWalEntryId}

const url = 'https://work.optidata.cloud/api/drives/1/wal/since/950294?page=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Entries newer than {nodeWalEntryId}, oldest first — the call a sync client repeats to stay current, passing the highest id it has processed.

By default a bare array is returned, capped at a server-side limit. Pass paginated (or any page) to get a paginator envelope instead, which is what you want when catching up after a long absence.

Authorizations

bearerAuth

Parameters

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

paginated

boolean

Return a paginator envelope instead of a plain array.

page

integer

default: 1 >= 1

1-based page number.

pageSize

integer

>= 1

Number of items per page.

Responses

200

Journal entries after the given id.

application/json

One of:

Array<object>
object

Array<object>

One entry of the write-ahead log. Every change to the drive appends an entry; clients replay the log from the last id they processed.

object

integer format: int64

node_id

integer | null format: int64

drive_id

integer format: int64

guid

string format: uuid

optiwork_session_id

Session that produced the change. Pass it back as optiwork_session_id to skip your own writes.

string | null

event_class

Fully qualified name of the domain event that produced the entry.

string

event_json

JSON-encoded payload of the event.

string

created_at

string format: date-time

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

integer | null

total

Absent on endpoints that use the simple paginator.

integer

data

required

Array<object>

One entry of the write-ahead log. Every change to the drive appends an entry; clients replay the log from the last id they processed.

object

integer format: int64

node_id

integer | null format: int64

drive_id

integer format: int64

guid

string format: uuid

optiwork_session_id

Session that produced the change. Pass it back as optiwork_session_id to skip your own writes.

string | null

event_class

Fully qualified name of the domain event that produced the entry.

string

event_json

JSON-encoded payload of the event.

string

created_at

string format: date-time

Example

{
  "current_page": 1,
  "per_page": 30,
  "data": [
    {
      "id": 950294,
      "event_class": "App\\Events\\Drive\\Share\\SharePermissionCreated"
    }
  ]
}

401

Missing, malformed or expired authentication key.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

missing

No bearer token sent

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

404

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

application/json

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

object

message

required

Human-readable description of the failure.

string

Examples

missing

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

429

Rate limit exceeded. Retry after the window resets.

application/json

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

object

message

required

Human-readable description of the failure.

string

Examples

throttled

{
  "message": "Too Many Attempts."
}