dynamic-forms / Interface

HttpRequestConfig

Configuration for an HTTP request used by declarative HTTP validators, derivations, and conditions.

All string values in queryParams are treated as expressions evaluated by ExpressionParser. When evaluateBodyExpressions is true, top-level string values in body are also evaluated as expressions (shallow only).

Properties

NameTypeDescription
body
Record<string, unknown> | undefined

Request body (for POST/PUT/PATCH)

evaluateBodyExpressions
boolean | undefined

When true, top-level string values in body are treated as expressions and evaluated by ExpressionParser (shallow only — nested objects are passed through as-is).

headers
Record<string, string> | undefined

HTTP headers to include in the request

method
"GET" | "POST" | "PUT" | "PATCH" | "DELETE" | undefined

HTTP method. Defaults to 'GET'

params
Record<string, string> | undefined

URL path parameters. Keys correspond to :key placeholders in the URL. Values are expressions evaluated by ExpressionParser against the current EvaluationContext.

Example usage
{
  url: '/api/users/:userId/orders/:orderId',
  params: { userId: 'formValue.userId', orderId: 'fieldValue' }
}
// With userId=42 and fieldValue='abc' → '/api/users/42/orders/abc'
queryParams
Record<string, string> | undefined

Query parameters appended to the URL. Values are expressions evaluated by ExpressionParser against the current EvaluationContext.

url
string

URL to send the request to