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
  • Queries
  • Parameters
  • Response
  • Examples
  • Searching Across All Fields
  • Parameters
  • Example
  1. Backend API
  2. API Reference

Query Objects

PreviousRetrieve All ObjectsNextSort Results

Last updated 1 year ago

Queries

This function allows you to retrieve a list of objects matching specified criteria.

Relative URL
HTTP Request Method

/api/v4/backend-deployment-id/objects/model.json?query[field]=value

GET

/api/v4/backend-deployment-id/objects/model.json?q[field]=value

GET

/api/v4/backend-deployment-id/objects/model.json?query[field]=value1&query[other_field]=value2

GET

  • Replace model with the type of object that you wish to retrieve (as defined in your app's Data Model), for example person, job or asset.

  • Multiple query criteria can be specified.

  • Certain "hidden" fields are prefixed with an underscore, for example: to query on the updated_at hidden field, use _updated_at.

Parameters

Query parameters are specified as a URL-encoded query or q hash. Valid keys for this hash are the names of the fields in that model. The format for the values is the same as for creating objects. Please refer to the same section at

You can specify your criteria with logic such as 'equals', 'not equal to', 'greater than', 'less than', etc. as follows:

Comparison
Syntax
Allowed Values

Equals

query[field]=value

is Not Equal To

query[field.ne]=value

is Less Than

query[field.lt]=value

is Less Than or Equal To

query[field.lte]=value

is Greater Than

query[field.gt]=value

is Greater Than or Equal To

query[field.gte]=value

Contains

query[field.contains]=value

is Null (or Not Null)

query[field.null]=value

Specify true for the value to check for "Is Null" or false to check for "Is Not Null"

The contains operator is case-sensitive.

Response

Examples

BASE-URL

When using curl with queries you have to either escape the square brackets with a backslash \ or add the -g option to turn off curl's globbing functionality.

Match a text field:

GET BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[serial_number]=123456
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[serial_number]=123456" \
    -g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"l
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/assets.json"].get :params => {:q=>{:serial_number=>"123456"}}

Match multiple fields, including human-readable dates:

GET BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[make]=Acme&q[registration_date]=2012-09-19
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[make]=Acme&q[registration_date]=2012-09-19" \
    -g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/assets.json"].get :params => {:q=>{:make=>"Acme", :registration_date=>"2012-09-19"}}

Query with datetime in ISO8601 format:

GET BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[updated_at]=2012-09-18T10%3A27%3A46Z
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[updated_at]=2012-09-18T10%3A27%3A46Z" \
    -g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/assets.json"].get :params => {:q=>{:updated_at=>"2012-09-18T10:27:46Z"}}
GET BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[make]=Acme&q[verified]=no
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[make]=Acme&q[verified]=no" \
    -g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/assets.json"].get :params => {:q=>{:make=>"Acme", :verified=>"no"}}

Query on a relationship - Find all assets related to the specified room:

GET BASE-URL/api/v4/533bda53027894f69b001055/objects/assets.json?q[room_id]=8af9f570-017b-11e2-84c8-b88d120322de
curl "https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/assets.json?q[room_id]=8af9f570-017b-11e2-84c8-b88d120322de" \
    -g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "https://run-testing-us.journeyapps.com/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/assets.json"].get :params => {:q=>{:room_id=>"8af9f570-017b-11e2-84c8-b88d120322de"}}

Searching Across All Fields

You can also search through all the fields of all objects of a given type for a partial text match. This can be useful for implementing basic search functions.

Relative URL
HTTP Request Method

/api/v4/backend-deployment-id/objects/model/search.json

POST

Parameters

The search text must be specified as a URL-encoded parameter named query.

Example

BASE-URL

Search task objects for the text "site":

POST BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks/search.json
query=site
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks/search.json" \
    -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V" \
    -d "query=site"
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/tasks/search.json"].post :query=>"site"

Response:

json
{
    "objects": [
      {
          "id": "7b44dcf4-b02d-11e4-b450-001e6733fe3c",
          "type": "task",
          "updated_at": "2015-02-09T07:30:11Z",
          "display": "Confirm that site rules are documented and distributed",
          "name": "Confirm that site rules are documented and distributed",
          "instructions": null,
          "status": {
            "key": 1,
            "display": "Closed"
          },
          "category_id": null
        },
        {
          "id": "fd3b75e2-b02d-11e4-a034-001e6733fe3c",
          "type": "task",
          "updated_at": "2015-02-09T07:33:49Z",
          "display": "Confirm that supervisor is on site",
          "name": "Confirm that supervisor is on site",
          "instructions": null,
          "status": {
            "key": 1,
            "display": "Closed"
          },
          "category_id": null
        },
    ],
    "count": 2,
    "total": 2,
    "more": false
}

The response includes a list of all the objects of the given type which match all of the query criteria. The format of the objects is the same as for listing all objects (please refer to the section.)

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

Match a value (as a string) from a :

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

📥
Retrieve All Objects
single-choice field
Creating a New Object.
HTTP Endpoints
HTTP Endpoints