Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Query

Query JSON string/token.

Task version: 1.4.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

Json : Object

Json input needs to be of type string or JToken

Default: - Example: {"key":"value"}

Query : String

The query is of type JSONPath.

More details: http://goessner.net/articles/JsonPath/

Default: - Example: "$.key"

Name
Description

ErrorWhenNotMatched : Boolean

A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.

Default: - Example: true

ThrowErrorOnFailure : Boolean

If true, exceptions are thrown on failure. If false, errors are returned as part of the result.

Default: True Example: true

ErrorMessageOnFailure : String

Custom error message to use when an error occurs. Leave empty to use the original exception message.

Default: - Example: -

Task Result

Name
Description

Success : Boolean

Operation complete without errors. Example: true

Data : IEnumerable<Object>

Result data. Example: [ { Foo }, { Bar } ]

Error : Error

Error information, populated when the task fails and ThrowErrorOnFailure is false. Example: null

Error.Message : String

Error message. Example: Query failed: invalid JSONPath expression

Error.AdditionalInfo : Exception

The exception that caused the error. Example: System.Exception: Query failed

Task Changelog

Changelog is not available for this Task.

Last updated

Was this helpful?