Openi DeveloperDeveloper

Preview JSONata transform for a field

Always returns 200; failure is reflected in `ok=false` with `error` populated.

POST
/v1/datasets/preview-jsonata-field

Authorization

ApiKeyAuth
x-api-key<token>

Tenant API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expr*string
Length1 <= length <= 65536
value?unknown

Source value to feed the expression. Any JSON value.

row?

Optional surrounding record body; bound as row in JSONata.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/datasets/preview-jsonata-field" \  -H "Content-Type: application/json" \  -d '{    "expr": "string"  }'
{  "ok": true,  "result": null,  "error": "string"}