Developer
Log in

Actions

Advanced

1 action in the Advanced group. Each is its own JSON-RPC method, and also runs through action.run.

raw.transactionRaw request

The escape hatch: commits scene-model commands as one transaction, all or nothing, exactly as Studio's own panels do (see the model's command reference). Changes made this way aren't undo steps.

Keyscope: manage

Parameters

  • commandsjsonrequired

    The commands, as a JSON array.

  • labeltextoptional

    A name for the change.

    Up to 200 characters

Result

  • revintegeralways

    The scene model's revision after the change.

Live state

This action has no live state.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "raw.transaction",
  "params": {
    "commands": []
  }
}

In the SDKs

C#
Task<RawTransactionResult> RawTransactionAsync(RawTransactionParams parameters, CancellationToken cancellationToken = default)
TypeScript
rawTransaction(params: RawTransactionParams): Promise<RawTransactionResult>
Python
async def raw_transaction(self, *, commands: list[dict[str, Any]], label: str | None = None) -> RawTransactionResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "commands": {
        "description": "The commands, as a JSON array.",
        "items": {
          "properties": {
            "cmd": {
              "type": "string"
            }
          },
          "required": [
            "cmd"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "label": {
        "description": "A name for the change.",
        "maxLength": 200,
        "type": "string"
      }
    },
    "required": [
      "commands"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "rev": {
        "description": "The scene model's revision after the change.",
        "type": "integer"
      }
    },
    "required": [
      "rev"
    ],
    "type": "object"
  }
}

to open · ↑ ↓ to move · Esc to close