Using ZigiOps REST Query for On-Demand System Data Retrieval
Why use ZigiOps REST Query for efficient, on-demand system data retrieval?
ZigiOps REST Query is designed for situations where you need to retrieve data directly from a connected system—without triggering an integration or automation. Whether you're verifying a system state, performing a manual check, or building custom reporting outside of ZigiOps, this feature gives you a controlled, read-only way to request and return live data using a simple API call.
It’s a practical tool for gaining insight into integrated systems without involving any workflows or transformation logic.
What is REST Query in ZigiOps?
ZigiOps REST Query is a feature that allows users to perform on-demand data retrieval from any system integrated with ZigiOps. This capability is independent of ZigiOps' regular integration workflows. When a REST Query is executed, the requested data is returned in the HTTP response, but no further processing, transformation, or action is performed on the data by ZigiOps.
This functionality provides a flexible and lightweight method for querying data from connected systems, giving users full control over what data they want to retrieve and how it should be filtered or presented.
Filtering Format Consistency
REST Query uses the same filtering format as the one used in the ZigiOps UI. This consistent format remains unchanged regardless of which system is being queried.
For example, you can create a filter for collecting tickets from Jira and use that same filter structure to query tickets from ServiceNow or any other supported system. The only variation is in the field names, which may differ from system to system depending on their schema.
How It Works?
The REST Query operates as a standalone request:
- A user sends a REST API call to ZigiOps, targeting a specific system that supports querying.
- ZigiOps validates the request and forwards the query to the appropriate system.
- The external system returns the data.
- ZigiOps responds with the full dataset in the REST API response.
- No integration action (like create, update, or delete) is performed afterward.
(alt attr: cycle-like figure with some icons in it
This is different from standard workflows, where collected data would be mapped, transformed, and sent to a target system. REST Query only reads and returns — it does not act on the data.
Simple Rest Query Use Case Example
Suppose a user wants to retrieve all open tickets from a Jira instance named "Production". They would configure and send a REST Query through ZigiOps, which would return a JSON response containing the details of all open Jira tickets.
This operation is particularly useful for reporting, monitoring, custom dashboarding, or validation purposes — situations where you need current data without triggering actions or transformations.
Key Capabilities
- Query any supported system configured in ZigiOps.
- Filter definition control, allowing precise targeting of the data.
- Return field selection, giving users the ability to define which fields they need in the response.
- No dependency on active workflows — REST Queries can be used even when no active integration exists for the queried system.
Prerequisites
To use REST Query, the following conditions must be met:
- The system you want to query is already added and configured in ZigiOps.
- The schema of the system has been properly discovered and is available.
- A valid ZigiOps license exists that includes the system type being queried.
- For example, if a customer has a Jira–Remedy integration license, they can query any Jira or Remedy system.
- A valid ZIGI-API-TOKEN must be provided in the request headers.
Conclusion
ZigiOps REST Query offers a simple yet powerful way to fetch real-time data from any connected system without triggering downstream actions. It’s ideal for users who need on-demand access to specific datasets for monitoring, reporting, or verification—without the complexity of building a full integration workflow.
If you want to know more about ZigiOps, do not hesitate to book a personalized demo with our team or directy start your free ZigiOps trial.
You might be interested in other functionalities of ZigiOps: