job

run script preview and wait for result

Changed on
post/w/{workspace}/jobs/run_wait_result/preview

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/jobs/run_wait_result/preview
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Request body

contentstring

The code to run

pathstring

The path to the script

script_hashstring

The hash of the script

argsScriptArgs required

The arguments to pass to the script or flow

language'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible' | 'csharp' | 'nu' | 'java' | 'ruby' | 'rlang' | 'duckdb' | 'bunnative' | 'dbt'
tagstring
kind'code' | 'identity' | 'http'
dedicated_workerboolean
lockstring
flow_pathstring
modulesobject nullable

Additional script modules keyed by relative file path

temp_script_refsobject nullable

Map of relative-import script path -> temp storage hash so the preview job resolves those imports from not-yet-deployed local content instead of the deployed script

on_behalf_ofstring nullable

Run the preview as this identity (an email, u/<username> or g/<group>) instead of the caller. Naming anyone other than yourself requires being an admin or a member of wm_deployers.

viewer_data_accessboolean nullable

Data table and object storage access as the caller rather than as the job's identity, as a full-code app's inline runnable flagged viewer_data_access does for its viewer.

Response

job result

unknown required

Changes

  • f2e3872552a4Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • 33c26da1e324Revision changes
    • info

      added the new dbt enum value to the request property

    • info

      added the new dbt enum value to the request property //