For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTActivate task worker
        • POSTActivate the job worker
        • GETCheck staterator state
        • POSTCreate task mock
        • POSTDeactivate task worker
        • POSTDeactivate the job worker
        • DELDelete a task mock
        • POSTdiff to HTML
        • POSTEvaluation
        • POSTEvaluation group
        • GETGet aggregate job metrics
        • GETGet aggregate task metrics
        • GETGet task mock
        • GETGet the current task rate limit settings
        • GETGet worker status
        • POSTQuery data using 'json-query' format
        • PUTReplace a task mock
        • GETReturn a list of all IANA defined timezones
        • GETSearch task mocks
        • PUTUpdate the task rate limit settings at runtime
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceWorkflow Engine

Query data using ‘json-query’ format

POST
http://localhost:3000/workflow_engine/query
POST
/workflow_engine/query
$curl -X POST http://localhost:3000/workflow_engine/query \
> -H "Content-Type: application/json" \
> -u "<username>:<password>" \
> -d '{}'
1"Cisco"

Query data using a dot/bracket notation string and a matching key/value pair.

Was this page helpful?
Previous

Replace a task mock

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

request body
job_idstringOptionalformat: "^[0-9a-f]{24}$"
String representation of a MongoDB ObjectId
pass_on_nullbooleanOptional
querystringOptional
objobjectOptional

Response

Returned data from the match query
string
OR
double
OR
map from strings to any
OR
list of any
OR
boolean

Errors

500
Internal Server Error