Script

Execute a script

post

Executes a script expression against a record, with writes and trigger cascades enabled — requires the records:write grant. do as database is confined to the module named here.

Authorizations

AuthorizationstringRequired

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Path parameters

workspaceIdstring · min: 12 · max: 12Required

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$

Body

moduleNamestring · min: 1 · max: 100Required

Module name — do as database is confined to this module

Pattern: ^[a-z0-9_]+$

rowIdinteger · min: 1 · max: 9007199254740991Optional

Record the script evaluates against

scriptstringRequired

Script to execute (system format)

tableNamestring · min: 1 · max: 100Optional

Table name

Pattern: ^[a-z0-9_]+$

Responses

200

Script executed successfully

application/json

dataanyRequired

The script expression's result

401

Unauthorized

application/json

403

Insufficient API key scope

application/json

500

Internal server error

application/json

post/api/v1/workspace/{workspaceId}/script/exec

POST /api/v1/workspace/{workspaceId}/script/exec HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "moduleName": "text",
  "rowId": 1,
  "script": "text",
  "tableName": "text"
}

{
  "data": null
}