Execute one command | Cessy Builder Docs

const url = 'https://cessy.ai/api/rest/tenant-id/app-id/commands/commandType';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "success": true,
  "executionId": "a3f1c2d4-e5b6-47a8-9c0d-1e2f3a4b5c6d",
  "command": "PlaceOrder",
  "eventsEmitted": 1,
  "correlationId": "c9d8e7f6-a5b4-43c2-d1e0-f9a8b7c6d5e4",
  "events": [
    {
      "type": "OrderPlaced",
      "data": {}
    }
  ],
  "scopeKey": "order:7f3e2a1b-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
  "idempotentReplay": false,
  "warnings": [
    "Inventory reservation will expire in 15 minutes if payment is not completed."
  ],
  "policyErrors": [
    {}
  ]
}

Executes a command from the published DomainConfig. Use the generated app OpenAPI document for the concrete request schema, required business fields, and response event types. Declared UUID fields marked by the command model as generated/defaulted are optional for callers and are materialized server-side before DCB boundary resolution. Supply a client-owned Idempotency-Key UUID and reuse it with the identical body after an ambiguous outcome; a committed intent returns its canonical receipt without another append.

Authentication

AuthorizationBearer

Runtime bearer accepted by the normal app-scoped pipeline: an API key or OAuth/JWT with the ‘runtime’ scope, or an app-scoped agent service token. Individual operations may require a narrower principal type.

Path parameters

commandTypestringRequired

Command name from DomainConfig.commands.

Query parameters

workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Request

This endpoint expects a map from strings to any.

Response

Command executed on an existing scope

successboolean

executionIdstringformat: "uuid"

Stable command intent and protected execution-log lookup identifier.

commandstring

eventsEmittedinteger>=0

correlationIdstring

Identifier for related requests and diagnostics.

eventslist of objects

scopeKeystringOptional

idempotentReplaybooleanOptional

True when the response was reconstructed from an already-committed intent.

warningslist of stringsOptional

policyErrorslist of maps from strings to anyOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

503

Service Unavailable Error