List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
[
"name",
"=",
"bob"
]
],
[
[
"name",
"=",
"larry"
]
]
]
]
]
Query options including pagination, ordering, and additional parameters.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
Force use of SQL for result filtering to reduce response time. May not work for all methods.
Unique identifier for this job.
Array of message IDs associated with this job.
No Additional ItemsName of the method/service being executed by this job.
Array of arguments passed to the job method.
No Additional ItemsWhether this is a temporary job that will be automatically cleaned up.
Human-readable description of what this job does. null if not provided.
Whether this job can be cancelled/aborted.
File system path to detailed job logs. null if no logs available.
Brief excerpt from job logs for quick preview. null if no logs available.
Current progress information for the job.
No Additional PropertiesCompletion percentage of the job. null if not available.
Human-readable description of the current progress. null if not available.
Additional progress information specific to the job type.
The result data returned by the job upon successful completion.
Encoding error information if result serialization failed.
Error message if the job failed. null if no error occurred.
Exception details if the job encountered an exception. null if no exception occurred.
Detailed exception information. null if no exception occurred.
String representation of the exception. null if no exception occurred.
Exception type name. null if no exception occurred.
System error number if applicable. null otherwise.
Additional exception information.
Current execution state of the job.
"WAITING"
"RUNNING"
"SUCCESS"
"FAILED"
"ABORTED"
Timestamp when the job started execution. null if not yet started.
Timestamp when the job completed execution. null if still running or not started.
Authentication credentials used for this job. null if no authentication required.
Authentication type used for the job.
Authentication data and credentials for the job.
Unique identifier for this job.
Array of message IDs associated with this job.
No Additional ItemsName of the method/service being executed by this job.
Array of arguments passed to the job method.
No Additional ItemsWhether this is a temporary job that will be automatically cleaned up.
Human-readable description of what this job does. null if not provided.
Whether this job can be cancelled/aborted.
File system path to detailed job logs. null if no logs available.
Brief excerpt from job logs for quick preview. null if no logs available.
Current progress information for the job.
The result data returned by the job upon successful completion.
Encoding error information if result serialization failed.
Error message if the job failed. null if no error occurred.
Exception details if the job encountered an exception. null if no exception occurred.
Detailed exception information. null if no exception occurred.
Current execution state of the job.
"WAITING"
"RUNNING"
"SUCCESS"
"FAILED"
"ABORTED"
Timestamp when the job started execution. null if not yet started.
Timestamp when the job completed execution. null if still running or not started.
Authentication credentials used for this job. null if no authentication required.