LogoLogo
What's NewDeveloper CommunitySupportStatus
  • 🚀Get Started
    • What is JourneyApps Platform?
    • Tutorial: Build your First App
      • 1. Introduction
      • 2. Create a new App
      • 3. OXIDE IDE Overview
      • 4. Hello World app
      • 5. The Data Model
      • 6. View Components
      • 7. Queries and Data Sync
      • 8. Simple Navigation
      • 9. View Stack
      • 10. Input Validation
      • 11. View Parameters
      • 12. Data Manipulation
      • 13. Responsive Apps
      • 14. Styling
      • 15. Lists
      • 16. GPS Capturing
      • 17. Relationships
      • 18. Multiple User Roles
      • 19. Deployment and Users
      • 20. Version Control
      • 21. CSV and APIs
      • 22. Conclusion
    • JourneyApps Platform Fundamentals
      • Creating a New App
        • Git-enabled Apps
      • What are Views?
      • What is the Data Model?
      • JourneyApps Syntax Basics
      • Access the Database (DB)
        • Manipulate DB Objects
        • Query DB Objects
      • View Navigation
        • Deep Linking
      • CloudCode Overview
      • OXIDE (Online IDE)
  • 💻Build your App
    • JourneyApps Syntax
      • Syntax Basics
      • Access the DB
      • View Navigation
      • Async & Await
      • TypeScript Apps (Beta)
        • runtime-build package
        • TypeScript App Troubleshooting
      • What's New in V4
        • Updating to the V4 API
    • Configure your Data Model
      • What is the data model?
      • Reference: model
        • field
        • belongs-to
        • has-many
        • index
      • Data Rules
        • Data Buckets
        • Sync Rules - Limit data synced to devices
        • Data ACLs - Limit access to data
        • Real-world example for Data Rules
        • ❔FAQs
        • Migrate to Data Rules
      • App Indexes
      • Webhooks
    • UI Components
      • All UI Components
        • actionSheet
        • Attachments
        • button
        • button-group
        • capture-coordinates
          • marker
          • marker-query
        • capture-file
        • capture-photo
        • capture-signature
        • card
          • accent
          • action
        • columns
          • column
        • component
        • context-menu
          • divider
          • item
        • CSV
        • date-input
        • datetime-input
        • dialog
          • body
        • display-3d-model
          • 📖display-3d-model Guides
            • Guide 1: Initialize and layout a 3D model in a view
            • Guide 2: Control playback position
            • Guide 3: Troubleshooting controls
        • display-coordinates
        • display-file
        • display-image
        • display-photo
        • display-signature
        • heading
        • html
          • HTML Advanced Topics
          • ❔HTML FAQs
          • 📖Guide: HTML & JourneyApps iFrame Client
        • icons
        • info
        • info-table
          • row
        • journey.photos (capture multiple photos)
        • JourneyPrinter (print PDFs)
        • grid
          • cell
          • 📖grid Examples
        • list
          • list-item
            • accent
            • asset
            • pills
              • pill
            • action
        • multiple-choice-checklist
        • navigation (Navigation drawer)
          • general-section
            • item
          • section
            • item
              • item
          • ❔navigation FAQs
        • notification
        • object-dropdown
        • object-list
          • action
        • object-repeat
        • object-table
          • action
          • column
            • action
            • edit-boolean
            • edit-date
            • edit-datetime
            • edit-integer
            • edit-number
            • edit-select
            • edit-text
            • edit-time
            • edit-typeahead
              • action
            • header-action
          • column-group
          • empty-action
          • 📖object-table Guides
            • Actions
            • Cell callouts
            • Column groups
            • Columns
            • Controlled object-table
            • Controls
            • Copy & paste data
            • Edit cells
            • Filters
            • Frozen columns
            • Fullscreen object-table
            • Mode
            • State
            • Styles
        • optionList
        • PhotonSync (transfer data offline)
        • power-bi
          • 📖Guide: PowerBI Embedding
        • scan-barcode
        • shortcut
        • sidebar
        • single-choice-dropdown
        • single-choice-radio
        • template
        • text-input
        • time-input
        • toggle
        • view
      • JS/TS Events
      • Show / Hide UI Components
      • View Templates
      • XML Fields (Attributes)
        • align-content
        • align-controls
        • align-label
        • bind
        • clear-button-visibility
        • control-order
        • disabled
        • error-message
        • icon-position
        • id
        • hide-if
        • modifier-text
        • label
        • label-case
        • label-color
        • on-change
        • on-press
        • placeholder
        • required
        • show-if
    • JS / TS APIs
      • Attachment
      • Bluetooth (Beta)
      • Broadcast
      • component
      • CSV
      • DB
      • HardwareBarcode
      • journey
        • journey.config
        • journey.container
        • journey.device
        • journey.diagnostics
        • journey.dialog
        • journey.files
        • journey.hardware
        • journey.photos
        • journey.runtime
        • journey.sensors
        • journey.viewStack
      • JourneyPrinter
      • KeyboardBarcode
      • LocalDB
      • NFC
      • OnlineDB
      • PhotonSync
      • SerialPort
      • ShortcutManager
      • TCPSocket
      • user
    • Extend your App with Custom Code
      • App packages
        • App packages overview
        • PDF report package
        • TypeScript library & unit tests
        • Manage External Dependencies
      • Custom HTML
    • Style & Customize your App
      • Style & configure UI components
        • Overview
        • Understand extendable themes
        • Use themes on a view
        • Theme specific components on a view
        • Examples
        • Debugging
        • ❔FAQs
      • Change your App Font
      • Custom Branding
        • Custom Container Features
        • Special Requirements for iOS Containers
    • Integrate your App
      • Backend integrations with CloudCode
      • Barcode Scanning
        • Barcode Scanning using Keyboard Emulation
        • Hardware Barcode Scanning
        • scan-barcode
      • Bluetooth Low Energy (BLE)
      • Broadcast API
      • HTTP requests (Fetch API)
      • JourneyApps Print (Android)
      • Maps and navigation
      • NFC
      • Opening external links/apps
      • Serial Port
      • TCP Sockets
    • Design Intuitive Apps
      • UX Guidelines
      • Write Effective Copy
  • 📱App Features
    • RealWear® Voice Control
      • Automatic Voice Commands
        • Automatic Voice Commands - Advanced
      • Manual Voice Commands
    • App, Runtime and Container Updates
    • Batch Operations (App)
    • Call JS/TS Functions from XML
    • Capture GPS Locations
    • Push Notifications
    • Translations
    • XML Format Strings
    • Webhooks (External)
  • 🌐CloudCode
    • CloudCode Overview
    • Trigger a CloudCode Task
      • Trigger CC with a Schedule
      • Trigger CC via a Webhook
      • Trigger CC from an App
      • Trigger CC from Another Task
      • Trigger CC via HTTP
    • Attachments in CloudCode
    • Timezones
    • Advanced CloudCode Topics
      • Access Multiple DBs in CloudCode Tasks
      • Batch API (CloudCode)
      • CloudCode Dependencies
      • Configure HTTPS in CloudCode
      • Deployment environment variables
      • Local CloudCode Development
      • PDF Reports using CloudCode
      • Shared CloudCode Tasks
      • Translations in CloudCode
  • 📥Backend API
    • Introduction
    • API Reference
      • Retrieve All Objects
      • Query Objects
      • Sort Results
      • Limit and Skip
      • Count Objects
      • Create a New Object
      • Retrieve a Single Object
      • Update a Single Object
      • Delete a Single Object
      • Batch Operations (v4 API)
      • Oplog API
      • Retrieve the App Data Model
      • Manage App Users and Sessions
      • Field Representation
      • Error Responses
    • API Limits
    • Update to the V4 API
  • ⚙️Technical
    • Data Synchronization Priority
    • Device Diagnostics
    • JSON1 Query Engine
    • Improve App Performance
    • Security Measures
    • Supported Platforms
      • Web Container
      • Windows Installer
    • Domain Whitelist
  • 🖥️OXIDE
    • Get started with OXIDE
      • OXIDE Overview
      • Components of OXIDE
    • Configure Testing Deployments
    • Edit and Manage Files
      • How to Navigate to a Function
      • Manage External Dependencies
    • Create and Manage App Containers
    • Debugging & Troubleshooting
      • Common Troubleshooting Pointers
      • App Diagnostics Reports
      • Build Logs
    • OXIDE Workspaces
      • OXIDE Trees
  • ❕Deprecated Features
    • Deprecated Features and Components
Powered by GitBook
On this page
  • Parameters
  • Response
  • Polling
  • Obtaining the most recent entries
  • Examples
  1. Backend API
  2. API Reference

Oplog API

The JourneyApps Oplog API provides an ordered log of all create, update and delete operations that occurred on the cloud datastore for one of your JourneyApps applications. Polling the Oplog allows you to sync your own database with JourneyApps.

Relative URL
HTTP Request Method

/api/v4/backend-deployment-id/oplog.json?start=x

GET

/api/v4/backend-deployment-id/oplog.json?start=x&end=y&limit=z

GET

Parameters

start and end specify the range of sequence IDs (see below for explanation) of the Oplog to query. All entries with start <= sequence_id < end are returned.

limit is the limit of entries returned in a single API call. The default is 400, and the maximum is 1000 (subject to change).

Response

The response will contain a list of Oplog entries no more than the limit. If there are no entries in the specified range, an empty array is returned.

Each entry contains the following info:

Key
Description

sequence

Sequence ID — a strictly incrementing ID identifying the entry. Always greater than 0 and less than 2^63.

operation

create, update or delete.

object

The new state of the object. The updated_at timestamp is the time that the write was made to the database.

The response also contains a field called datamodel_hash, matching the value from datamodel.json. This can be used to detect changes to the data model (when deployed). Note that this hash is always for the current version of the data model, even when a historical oplog range is requested. Also note that the object is returned according to the current data model definition, not the historical one.

Polling

The Oplog may be polled to monitor changes to the database. Polling should be performed at most once per second. To poll, the client must keep track of the latest sequence id returned. For the next query, that sequence id + 1 should be used in the start parameter.

Obtaining the most recent entries

If you need to start syncing from a certain point in time, or if you simply want to obtain an app's most recent DB operations, you can do this by appending ?tail=true to your query. This will return the app's most recent DB operations (currently defaults to 400 operations).

Examples

BASE-URL

Retrieve the 5 first writes to the database:

GET BASE-URL/api/v4/533bda53027894f69b001055/oplog.json?limit=5&start=0
curl "BASE-URL/api/v4/533bda53027894f69b001055/oplog.json?limit=5&start=0" \
    -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/oplog.json"].get :params => {:start=>0, :limit=>5}

Response:

json
{
    "entries": [
        {
            "sequence": 6009123137931706000,
            "operation": "update",
            "events": [],
            "object": {
                "id": "42059e2e-d2a2-11e3-a9f3-001e6733fe3c",
                "type": "task",
                "updated_at": "2014-05-03T09:06:48Z",
                "name": "First Task",
                "instructions": "Update me",
                "status": null,
                "category_id": null
            }
        },
        {
            "sequence": 6112271540663878000,
            "operation": "create",
            "events": [],
            "object": {
                "id": "1e47acd2-ad0f-11e4-8513-001e6733fe3c",
                "type": "user",
                "updated_at": "2015-02-05T08:15:17Z",
                "name": "Joe Smith"
            }
        },
        {
            "sequence": 6112271738232373000,
            "operation": "update",
            "events": [],
            "object": {
                "id": "1e47acd2-ad0f-11e4-8513-001e6733fe3c",
                "type": "user",
                "updated_at": "2015-02-05T08:16:03Z",
                "name": "Bruce Wayne"
            }
        },
        {
            "sequence": 6112271772592112000,
            "operation": "create",
            "events": [],
            "object": {
                "id": "3e7e18b0-ad0f-11e4-9d6d-001e6733fe3c",
                "type": "user",
                "updated_at": "2015-02-05T08:16:11Z",
                "name": "Tony Stark"
            }
        },
        {
            "sequence": 6112271910031065000,
            "operation": "update",
            "events": [],
            "object": {
                "id": "71fafc16-ba4f-11e3-8de0-001e6733fe3c",
                "type": "category",
                "updated_at": "2015-02-05T08:16:43Z",
                "name": "Cleaning"
            }
        }
    ],
    "datamodel_hash": "d9cca721a735dac4efe709e0f3518373"
}

Retrieve the next 5 writes:

GET BASE-URL/api/v4/533bda53027894f69b001055/oplog.json?limit=5&start=6112271910031065000
curl "BASE-URL/api/v4/533bda53027894f69b001055/oplog.json?limit=5&start=6112271910031065000" \
    -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/oplog.json"].get :params => {:start=>6112271910031065000, :limit=>5}
PreviousBatch Operations (v4 API)NextRetrieve the App Data Model

Last updated 2 years ago

The below examples contain a BASE-URL placeholder. Please refer to the section to get the base URL relevant to your deployment.

📥
HTTP Endpoints