GoRules

https://docs.gorules.io
Admin
GoRules is a business rules management system (BRMS) platform for managing, deploying, and...
Tokens:321,300
Snippets:1,724
Trust Score:6.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install ZEN Engine via pnpm

Source: https://docs.gorules.io/developers/sdks/wasm

Install the package using pnpm.

```bash
pnpm add @gorules/zen-engine
```

--------------------------------

### Install ZenEngine and PySpark

Source: https://docs.gorules.io/developers/integrations/pyspark

Install the necessary packages to enable rule evaluation within a PySpark environment.

```bash
pip install zen-engine pyspark
```

--------------------------------

### Install GoRules ZEN Engine

Source: https://docs.gorules.io/developers/sdks/go

Use the go get command to add the ZEN Engine package to your Go project.

```bash
go get github.com/gorules/zen-go
```

--------------------------------

### Install JDM Editor

Source: https://docs.gorules.io/developers/jdm/jdm-editor

Install the package using your preferred package manager.

```bash
npm install @gorules/jdm-editor
```

```bash
yarn add @gorules/jdm-editor
```

```bash
pnpm add @gorules/jdm-editor
```

--------------------------------

### Install and Run GoRules CLI

Source: https://docs.gorules.io/developers/cli

Install the CLI globally via npm or execute it directly using npx.

```bash
# npm
npm install -g @gorules/cli

# Or run directly with npx
npx @gorules/cli mcp start
```

--------------------------------

### Install ZEN Engine via Yarn

Source: https://docs.gorules.io/developers/sdks/wasm

Install the package using yarn, potentially requiring flags for specific versions.

```bash
yarn add @gorules/zen-engine
```

```bash
yarn add @gorules/zen-engine --ignore-engines
```

--------------------------------

### Install ZEN Engine via npm

Source: https://docs.gorules.io/developers/sdks/wasm

Install the package with the wasm32 CPU architecture flag.

```bash
npm install @gorules/zen-engine --cpu=wasm32
```

--------------------------------

### Install ZEN Engine

Source: https://docs.gorules.io/developers/sdks/python

Use these commands to install the zen-engine package via common Python package managers.

```bash
pip install zen-engine
```

```bash
poetry add zen-engine
```

```bash
uv add zen-engine
```

--------------------------------

### Install ZEN Engine

Source: https://docs.gorules.io/developers/sdks/nodejs

Commands to install the ZEN Engine package using common Node.js package managers.

```bash
npm install @gorules/zen-engine
```

```bash
yarn add @gorules/zen-engine
```

```bash
pnpm add @gorules/zen-engine
```

--------------------------------

### Install ZEN Engine and Polars

Source: https://docs.gorules.io/developers/integrations/polars

Install the necessary packages to enable rule evaluation within Polars workflows.

```bash
pip install zen-engine polars
```

--------------------------------

### ZenEngine Initialization and Evaluation

Source: https://docs.gorules.io/developers/sdks/ios

Demonstrates how to instantiate the ZenEngine, create a decision object from rule data, and evaluate it against a JSON context.

```APIDOC
## ZenEngine.createDecision

### Description
Creates a decision instance from the provided rule content.

### Signature
`func createDecision(content: Data) throws -> Decision`

### Parameters
- **content** (Data) - Required - The JSON data representing the rule set.

---

## Decision.evaluate

### Description
Evaluates the decision against the provided context.

### Signature
`func evaluate(context: Data, options: Any?) async throws -> EvaluationResponse`

### Parameters
- **context** (Data) - Required - The JSON data representing the input context for the decision.
- **options** (Any?) - Optional - Additional evaluation options.
```

--------------------------------

### Get current date and time in ZEN

Source: https://docs.gorules.io/learn/zen-language/dates

Call d() without arguments to get the current timestamp, or pass a timezone string to get the current time in that zone.

```zen
d()                               // Current date and time
d("America/Los_Angeles")          // Current time in LA timezone
```

--------------------------------

### Start MCP Bridge

Source: https://docs.gorules.io/developers/cli

Launch the local MCP server to enable AI tool connectivity.

```bash
gorules mcp start
```

--------------------------------

### Load Decisions from Cloud Storage

Source: https://docs.gorules.io/developers/sdks/nodejs

Examples for initializing the engine with decisions fetched from AWS S3, Azure Blob Storage, or Google Cloud Storage.

```javascript
import { ZenEngine, ZenDecisionContent } from '@gorules/zen-engine';
import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3';
import AdmZip from 'adm-zip';

const s3 = new S3Client({ region: 'us-east-1' });
const rules = new Map();

// Download and extract all decisions at startup
const command = new GetObjectCommand({
  Bucket: 'my-rules-bucket',
  Key: 'decisions.zip'
});

const s3Response = await s3.send(command);
const zipBuffer = Buffer.from(await s3Response.Body.transformToByteArray());
const zip = new AdmZip(zipBuffer);

for (const entry of zip.getEntries()) {
  if (!entry.isDirectory) {
    rules.set(entry.entryName, new ZenDecisionContent(entry.getData()));
  }
}

const engine = new ZenEngine({
  loader: async (key) => rules.get(key)
});

const response = await engine.evaluate('pricing.json', { amount: 100 });
```

```javascript
import { ZenEngine, ZenDecisionContent } from '@gorules/zen-engine';
import { BlobServiceClient } from '@azure/storage-blob';
import AdmZip from 'adm-zip';

const blobService = BlobServiceClient.fromConnectionString(process.env.AZURE_STORAGE_CONNECTION);
const container = blobService.getContainerClient('rules');
const rules = new Map();

// Download and extract all decisions at startup
const blob = container.getBlobClient('decisions.zip');
const zipBuffer = await blob.downloadToBuffer();
const zip = new AdmZip(zipBuffer);

for (const entry of zip.getEntries()) {
  if (!entry.isDirectory) {
    rules.set(entry.entryName, new ZenDecisionContent(entry.getData()));
  }
}

const engine = new ZenEngine({
  loader: async (key) => rules.get(key)
});

const response = await engine.evaluate('pricing.json', { amount: 100 });
```

```javascript
import { ZenEngine, ZenDecisionContent } from '@gorules/zen-engine';
import { Storage } from '@google-cloud/storage';
import AdmZip from 'adm-zip';

const storage = new Storage();
const bucket = storage.bucket('my-rules-bucket');
const rules = new Map();

// Download and extract all decisions at startup
const [zipBuffer] = await bucket.file('decisions.zip').download();
const zip = new AdmZip(zipBuffer);

for (const entry of zip.getEntries()) {
  if (!entry.isDirectory) {
    rules.set(entry.entryName, new ZenDecisionContent(entry.getData()));
  }
}

const engine = new ZenEngine({
  loader: async (key) => rules.get(key)
});

const response = await engine.evaluate('pricing.json', { amount: 100 });
```

--------------------------------

### Initialize ZenEngine as a Singleton

Source: https://docs.gorules.io/developers/sdks/ios

Create a single instance of ZenEngine at application startup to reuse for all evaluations.

```swift
class RulesEngine {
    static let shared = RulesEngine()
    private let engine: ZenEngine

    private init() {
        engine = ZenEngine(loader: nil, customNode: nil)
    }

    func evaluate(decision: Data, context: Data) async throws -> Data {
        let dec = try engine.createDecision(content: decision)
        let response = try await dec.evaluate(context: context, options: nil)
        return response.result
    }
}
```

--------------------------------

### Load and evaluate rules from Google Cloud Storage

Source: https://docs.gorules.io/developers/sdks/java

Downloads a zip archive from a GCS bucket at startup and initializes the ZenEngine to serve decisions from memory.

```java
import io.gorules.zen_engine.ZenEngine;
import io.gorules.zen_engine.JsonBuffer;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import java.util.zip.ZipInputStream;
import java.util.zip.ZipEntry;
import java.io.ByteArrayInputStream;

var storage = StorageOptions.getDefaultInstance().getService();
var rules = new ConcurrentHashMap<String, byte[]>();

// Download and extract all decisions at startup
var blob = storage.get("my-rules-bucket", "decisions.zip");
var zipBytes = blob.getContent();

try (var zis = new ZipInputStream(new ByteArrayInputStream(zipBytes))) {
    ZipEntry entry;
    while ((entry = zis.getNextEntry()) != null) {
        if (!entry.isDirectory()) {
            rules.put(entry.getName(), zis.readAllBytes());
        }
    }
}

var engine = new ZenEngine(key -> {
    var bytes = rules.get(key);
    if (bytes == null) {
        return CompletableFuture.failedFuture(new RuntimeException("Decision not found: " + key));
    }
    return CompletableFuture.completedFuture(new JsonBuffer(bytes));
}, null);

var response = engine.evaluate("pricing.json", new JsonBuffer("{}"), null).join();
System.out.println(response.result());
```

--------------------------------

### Start GoRules BRMS services

Source: https://docs.gorules.io/developers/platform-guides/docker-compose

Command to initialize and start the containers in detached mode.

```bash
docker-compose up -d
```

--------------------------------

### Engine Management

Source: https://docs.gorules.io/developers/sdks/go

Best practices for initializing, disposing, and running the ZenEngine.

```APIDOC
## NewEngine

### Description
Initializes a new ZenEngine instance. It is recommended to create a single instance at application startup.

### Method
zen.NewEngine(config)

## Dispose

### Description
Releases engine and decision resources. Should be called on application termination.

### Method
engine.Dispose()
```

--------------------------------

### Initialize and Dispose Engine

Source: https://docs.gorules.io/developers/sdks/go

Create a single engine instance at startup and ensure Dispose is called to release resources.

```go
engine := zen.NewEngine(zen.EngineConfig{Loader: loader})
defer engine.Dispose()
```

--------------------------------

### Get a project OpenAPI definition

Source: https://docs.gorules.io/api-reference/brms/project/get-a-project

Defines the GET /api/projects/{projectId} endpoint for retrieving project metadata.

```yaml
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}:
    get:
      tags:
        - Project
      summary: Get a project
      description: Retrieve detailed information about a specific project by its ID.
      operationId: getProject
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Unique identifier of the project
      responses:
        '200':
          description: Project details
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier of the project
                  name:
                    type: string
                    description: Name of the project
                  key:
                    type: string
                    description: Unique key identifier for the project
                  organisationId:
                    type: string
                    format: uuid
                    description: Organisation ID the project belongs to
                  version:
                    type: string
                    enum:
                      - v1
                      - v2
                    description: Project version (v1 or v2)
                  createdAt:
                    type: string
                    description: Timestamp when the project was created
                  updatedAt:
                    type: string
                    description: Timestamp when the project was last updated
                  protected:
                    type: boolean
                    description: Whether the project is protected from deletion
                  deletedAt:
                    type: string
                    nullable: true
```

--------------------------------

### Define evaluation context example

Source: https://docs.gorules.io/openapi/brms.json

Example structure for the evaluation context object passed to the decision engine.

```json
{
  "cart": {
    "total": 1500
  },
  "customer": {
    "country": "US",
    "tier": "gold"
  }
}
```

--------------------------------

### POST /api/onboarding/skip

Source: https://docs.gorules.io/api-reference/brms/templates/skip-onboarding-process

Marks the onboarding process as complete without creating a project from a template.

```APIDOC
## POST /api/onboarding/skip

### Description
Marks the onboarding process as complete without creating a project from a template.

### Method
POST

### Endpoint
/api/onboarding/skip

### Response
#### Success Response (202)
- No content returned - Onboarding skipped successfully
```

--------------------------------

### Get integration OpenAPI definition

Source: https://docs.gorules.io/api-reference/brms/integration/get-integration

Defines the GET endpoint for retrieving integration details by project and integration ID.

```yaml
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/integrations/{integrationId}:
    get:
      tags:
        - Integration
      summary: Get integration
      description: Retrieve a single integration by its ID.
      operationId: getIntegration
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Project ID
        - schema:
            type: string
            format: uuid
          in: path
          name: integrationId
          required: true
          description: Integration ID
      responses:
        '200':
          description: Integration details
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier of the integration
                  type:
                    type: string
                    enum:
                      - http
                    description: Type of integration
                  config:
                    type: object
                    properties:
                      method:
                        type: string
                        enum:
                          - post
                          - get
                          - delete
                          - put
                          - patch
                        description: HTTP method for the request
                      url:
                        type: string
                        description: URL endpoint for the HTTP request
                      timeout:
                        type: number
                        default: 5000
                        description: Request timeout in milliseconds
                      output:
                        type: string
```

--------------------------------

### POST /api/onboarding/finalize

Source: https://docs.gorules.io/api-reference/brms/templates/finalize-onboarding-process-with-template

Completes the onboarding process by creating a new project with the selected template, including a default document and test event.

```APIDOC
## POST /api/onboarding/finalize

### Description
Completes the onboarding process by creating a new project with the selected template, including a default document and test event.

### Method
POST

### Endpoint
/api/onboarding/finalize

### Request Body
- **templateKey** (string) - Required - Key of the template to use for the new project

### Request Example
{
  "templateKey": "example-template-key"
}

### Response
#### Success Response (200)
- **project** (object) - Created project and document details
  - **id** (string) - Unique identifier of the project
  - **name** (string) - Name of the project
  - **key** (string) - URL-friendly key of the project
  - **organisationId** (string) - Organisation the project belongs to
  - **createdAt** (string) - Timestamp when the project was created
  - **updatedAt** (string) - Timestamp when the project was last updated
```

--------------------------------

### OIDC Provider Configuration Examples

Source: https://docs.gorules.io/developers/deployment/brms/sso

Environment variable configurations for common OIDC identity providers.

```shell
SSO_OAUTH2_PROVIDER=oidc
SSO_OAUTH2_CLIENT_ID=0oaycgerypftkPwxE697
SSO_OAUTH2_ISSUER=https://your-domain.okta.com/oauth2/default
SSO_OAUTH2_JWKS_URI=https://your-domain.okta.com/oauth2/default/v1/keys
```

```shell
SSO_OAUTH2_PROVIDER=oidc
SSO_OAUTH2_CLIENT_ID=brms
SSO_OAUTH2_ISSUER=https://keycloak.example.com/realms/your-realm
SSO_OAUTH2_JWKS_URI=https://keycloak.example.com/realms/your-realm/protocol/openid-connect/certs
```

```shell
SSO_OAUTH2_PROVIDER=oidc
SSO_OAUTH2_CLIENT_ID=your-application-client-id
SSO_OAUTH2_ISSUER=https://login.microsoftonline.com/YOUR_TENANT_ID/v2.0
SSO_OAUTH2_JWKS_URI=https://login.microsoftonline.com/YOUR_TENANT_ID/discovery/v2.0/keys
```

```shell
SSO_OAUTH2_PROVIDER=oidc
SSO_OAUTH2_CLIENT_ID=your-application-client-id
SSO_OAUTH2_ISSUER=https://auth.pingone.eu/YOUR_ENVIRONMENT_ID/as
SSO_OAUTH2_JWKS_URI=https://auth.pingone.eu/YOUR_ENVIRONMENT_ID/as/jwks
```

--------------------------------

### POST /environments

Source: https://docs.gorules.io/api-reference/brms/environment/create-environment

Creates a new environment in the system.

```APIDOC
## POST /environments

### Description
Creates a new environment. Requires a name and type.

### Method
POST

### Endpoint
/environments

### Request Body
- **name** (string) - Required - Name of the environment
- **type** (string) - Required - Type of environment (brms or deployment)

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the environment
- **name** (string) - Name of the environment
- **accessToken** (string) - Access token for the environment
- **type** (string) - Type of environment
- **key** (string) - Unique key for BRMS type environments
- **release** (object) - Currently deployed release information
- **releaseId** (string) - ID of the currently deployed release
- **deploymentId** (string) - ID of the associated deployment
- **deployment** (object) - Deployment configuration for the environment
- **projectId** (string) - Project ID
```

--------------------------------

### Get branch OpenAPI definition

Source: https://docs.gorules.io/api-reference/brms/branches/get-branch

Defines the GET endpoint for retrieving branch details using project and branch identifiers.

```yaml
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/branches/{branchId}:
    get:
      tags:
        - Branches
      summary: Get branch
      description: >-
        Retrieves details of a specific branch including its latest commit and
        change requests.
      operationId: getBranch
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Project ID
        - schema:
            anyOf:
              - type: string
                format: uuid
              - type: string
                enum:
                  - main
          in: path
          name: branchId
          required: true
          description: Branch ID or "main" for the default branch
      responses:
        '200':
          description: Branch details with latest commit and change requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Branch ID
                  name:
                    type: string
                    description: Branch name
                  default:
                    type: boolean
                    description: Whether this is the default (main) branch
                  projectId:
                    type: string
                    format: uuid
                    description: Project ID
                  baseCommitId:
                    type: string
                    nullable: true
                    format: uuid
                    description: Base commit ID
                  createdById:
                    type: string
                    nullable: true
                    format: uuid
                    description: ID of user who created the branch
                  createdBy:
```

--------------------------------

### Database Migration and Logging Options

Source: https://docs.gorules.io/developers/deployment/brms/overview

Control schema migrations and SQL logging behavior.

```shell
DB_MIGRATE=true                         # Run migrations on startup (default: true)
DB_SYNCHRONIZE=false                    # Auto-sync schema - dev only! (default: false)
DB_LOGGING=false                        # Log SQL queries (default: false)
```

--------------------------------

### Get audit log OpenAPI definition

Source: https://docs.gorules.io/api-reference/brms/audit-log/get-audit-log

Defines the GET endpoint for retrieving audit log entries by their unique UUID.

```yaml
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/audit-logs/{auditLogId}:
    get:
      tags:
        - Audit log
      summary: Get audit log
      description: >-
        Retrieve a single audit log entry by ID, including the full data
        payload.
      operationId: getAuditLog
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: auditLogId
          required: true
          description: Audit log entry ID
      responses:
        '200':
          description: Audit log entry with full details
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier of the audit log entry
                  createdAt:
                    type: string
                    description: Timestamp when the action was performed
                  type:
                    type: string
                    enum:
                      - organisation
                      - user
                      - group
                      - accessToken
                      - project
                      - document
                      - release
                      - member
                      - personalAccessToken
                    description: Category of the audited resource
                  action:
                    type: string
                    description: Specific action that was performed
                  ipAddress:
                    type: string
                    nullable: true
                    description: IP address of the client that performed the action
                  userAgent:
                    type: string
                    nullable: true
                    description: User agent of the client that performed the action
                  refId:
```

--------------------------------

### Install GoRules ZEN Engine via CLI

Source: https://docs.gorules.io/developers/sdks/csharp

Use the dotnet CLI to add the GoRules.ZenEngine package to your project.

```bash
dotnet add package GoRules.ZenEngine
```

--------------------------------

### OpenAPI Specification for Get Release Files

Source: https://docs.gorules.io/api-reference/brms/release/get-release-files

Defines the GET endpoint for retrieving release files using project and release UUIDs.

```yaml
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/releases/{releaseId}/files:
    get:
      tags:
        - Release
      summary: Get release files
      description: Retrieve all files contained in a release with their content.
      operationId: getReleaseFiles
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Project unique identifier
        - schema:
            type: string
            format: uuid
          in: path
          name: releaseId
          required: true
          description: Release unique identifier
      responses:
        '200':
          description: List of release files with content
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      description: File unique identifier
                    name:
                      type: string
                      nullable: true
                      description: File name
                    path:
                      type: string
                      description: File path within the release
                    contentType:
                      type: string
                      nullable: true
                      description: MIME type of the file
                    contentHash:
                      type: string
                      nullable: true
                      description: MD5 hash of the file content
                    releaseId:
                      type: string
                      format: uuid
                      description: ID of the release this file belongs to
                    versionId:
                      type: string
```

--------------------------------

### Get project with approvals OpenAPI definition

Source: https://docs.gorules.io/api-reference/brms/project/get-project-with-approvals

Defines the GET request structure for retrieving project approval settings by project ID.

```yaml
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/approvals:
    get:
      tags:
        - Project
      summary: Get project with approvals
      description: >-
        Retrieve project details including the configured approval groups for
        decisions.
      operationId: getProjectApprovals
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Unique identifier of the project
      responses:
        '200':
          description: Project details with approval configuration
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier of the project
                  name:
                    type: string
                    description: Name of the project
                  key:
                    type: string
                    description: Unique key identifier for the project
                  organisationId:
                    type: string
                    format: uuid
                    description: Organisation ID the project belongs to
                  version:
                    type: string
                    enum:
                      - v1
                      - v2
                    description: Project version (v1 or v2)
                  createdAt:
                    type: string
                    description: Timestamp when the project was created
                  updatedAt:
                    type: string
                    description: Timestamp when the project was last updated
                  protected:
                    type: boolean
                    description: Whether the project is protected from deletion
```

--------------------------------

### Configure Secrets Providers via Environment Variables

Source: https://docs.gorules.io/developers/deployment/brms/secrets-management

Examples of setting the required environment variables for different secrets management providers.

```bash
SECRETS_PROVIDER=aws-kms
SECRETS_AWS_KMS_KEY_ID=arn:aws:kms:us-east-1:123456789:key/12345-abcd-6789
SECRETS_AWS_KMS_REGION=us-east-1
```

```bash
SECRETS_PROVIDER=azure-keyvault
SECRETS_AZURE_KEYVAULT_URL=https://mycompany-vault.vault.azure.net
SECRETS_AZURE_KEYVAULT_KEY_NAME=gorules-master-key
```

```bash
SECRETS_PROVIDER=gcp-kms
SECRETS_GCP_KMS_KEY_NAME=projects/my-project/locations/us-east1/keyRings/my-ring/cryptoKeys/gorules-key
```

```bash
SECRETS_PROVIDER=env
SECRETS_MASTER_KEY=your-secure-passphrase-at-least-32-characters
```

--------------------------------

### POST /deployments

Source: https://docs.gorules.io/openapi/brms.json

Create a new deployment with the specified cloud storage provider configuration.

```APIDOC
## POST /deployments

### Description
Create a new deployment with the specified cloud storage provider configuration.

### Method
POST

### Endpoint
/deployments

### Request Body
- **name** (string) - Required - Name of the deployment
- **description** (string) - Optional - Description of the deployment
- **provider** (string) - Required - Cloud storage provider type (aws_s3, azure_storage, google_cloud_storage)
- **configuration** (object) - Optional - Provider-specific configuration settings
- **secrets** (object) - Optional - Provider-specific secrets (e.g., access keys, credentials)

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the deployment
- **name** (string) - Name of the deployment
- **description** (string) - Description of the deployment
- **provider** (string) - Cloud storage provider type
```

--------------------------------

### Get documents by path OpenAPI definition

Source: https://docs.gorules.io/api-reference/brms/document/get-documents-by-path

Defines the GET endpoint for retrieving document metadata by path within a specific project.

```yaml
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/documents/path:
    get:
      tags:
        - Document
      summary: Get documents by path
      description: Retrieve a document by its file system path.
      operationId: getDocumentByPath
      parameters:
        - schema:
            type: string
          in: query
          name: path
          required: true
          description: Document path to search for
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Project unique identifier
      responses:
        '200':
          description: Document matching the specified path
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Document unique identifier
                  key:
                    type: string
                    description: Materialized lowercase path based on the name
                  path:
                    type: string
                    description: Materialized path based on the name
                  name:
                    type: string
                    description: Document name
                  type:
                    type: string
                    enum:
                      - f
                      - d
                      - e
                    description: Document type (file, directory, or external file)
                  meta:
                    type: object
                    additionalProperties:
                      anyOf:
                        - type: string
                        - type: number
                        - type: boolean
                    description: Document metadata
                  contentType:
                    type: string
```
Tokens:
Raw