ExecuteQuery
GraphQl query will be executed after running this task.
Task version: 2.1.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Task Parameters
Query : String
GraphQl Query
Default: -
Example: query ($surname: String!) { users(surname: $surname) { id name } }
Variables : Variable[]
GraphQl variables for query
Default: -
Example: [{"key" : "surname", "value" : "Doe"}]
OperationName : String
The name of the operation to execute. Required if the query contains multiple operations.
Default: -
Example: GetUser
Extensions : Variable[]
Additional entries for protocol extensions. This is a map of additional metadata.
Default: -
Example: [{"key" : "persistedQuery", "value" : {"version": 1, "sha256Hash": "abc123"}}]
EndpointUrl : String
Url to GraphQl server.
Default: -
Example: http://localhost:4000
Authentication : Authentication
Method of authenticating a request
Possible values:
None: Method of authenticating a requestBasic: Method of authenticating a requestOAuth: Method of authenticating a requestClientCertificate: Method of authenticating a request
Default: -
Example: OAuth
Username : String
If Basic Authentication is selected, you should use a username
Default: -
Example: Username
🗝Password : String
Password for the username
Default: -
Example: Password123
🗝BearerToken : String
Bearer token to be used for request. Token will be added as an Authorization header.
Default: -
Example: Token123
CertificatePath : String
Path to the client certificate file (PFX/P12 format).
Default: -
Example: C:\certs\client.pfx
🗝CertificatePassword : String
Password for the client certificate file. Leave empty if the certificate has no password.
Default: -
Example: CertPassword123
Method : Method
The HTTP Method to be used with the request.
Possible values:
Get: The HTTP Method to be used with the request.Post: The HTTP Method to be used with the request.
Default: 1
Example: GET
Headers : Header[]
List of HTTP headers to be added to the request.
Default: -
Example: Name: Header, Value: HeaderValue
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure.
Default: True
Example: false
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
ConnectionTimeoutSeconds : Int32
Timeout in seconds to be used for the connection and operation.
Default: 30
Example: 30
AllowInvalidCertificate : Boolean
Do not throw an exception on a certificate error.
Default: False
Example: true
Task Result
Success : Boolean
Indicates if the task completed successfully.
Example: true
Data : JObject
Content of the returned response
Example: foobar,foobar
Headers : Header[]
Array of response headers
Example: Name: Header, Value: HeaderValue
Error : Error
Error that occurred during task execution.
Example: object { string Message, object { Exception exception } AdditionalInfo }
Task Changelog
Changelog for Task Frends.GraphQl.ExecuteQuery.
[2.1.0] - 2026-04-13
Added
Add a new ClientCertificate connection option
[2.0.0] - 2025-11-14
Changed
BREAKING: Variable values now support complex types (objects, arrays) instead of only strings. Variables are properly serialized without double-serialization.
GET method now uses JSON serialization for variables instead of manual string construction.
GraphQL response errors are now properly detected. Result.Success is set to false when the response contains errors, and an exception is thrown when ThrowErrorOnFailure is enabled.
Added
Support for operationName field to specify which operation to execute when a query contains multiple operations.
Support for extensions field for protocol extensions and additional metadata.
[1.1.0] - 2025-07-31
Changed
Make default error message empty by default
[1.0.0] - 2025-06-03
Added
Initial implementation
Last updated
Was this helpful?