### Install and Start Local Development

Source: https://github.com/burgan-tech/vnext-docs/blob/main/README.md

Use these commands to install project dependencies and start the local development server. The site will be available at http://localhost:3000/vnext-docs/.

```bash
npm install
npm run start
```

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

### Alternative Setup as Dependency

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/template-cli.md

Install the template CLI as a dependency and use the 'setup' script to create a new project.

```bash
npm install @burgan-tech/vnext-template
npm run setup <domain-name>
```

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

### Start Development Environment with Makefile

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/getting-started/local-dev.md

The Makefile simplifies the development setup by checking environment files and starting the development environment with a single command. It handles environment setup, PostgreSQL startup, and sequential service initialization.

```bash
# Check environment files and start development environment
make dev

# Display help menu
make help

# Network setup and environment check
make setup
```

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

### Install as Dependency

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/template-cli.md

Alternatively, install the package as a dependency and use the setup script.

```APIDOC
## Install as Dependency

### Description
Install the vNext Template CLI as a project dependency and use the `setup` script to create a new project.

### Method
`npm` commands

### Commands
```bash
npm install @burgan-tech/vnext-template
npm run setup <domain-name>
```

### Parameters
#### Path Parameters
- **domain-name** (string) - Required - The name of the domain for the new project.
```

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

### Example: Create user-management Project

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/template-cli.md

This command creates a new directory named 'user-management', copies template files, replaces domain name references, and automatically installs dependencies.

```bash
npx @burgan-tech/vnext-template user-management
```

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

### Start Infrastructure and Domains

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/getting-started/multi-domain.md

Initiate the shared infrastructure first using `make up-infra`. Then, start pre-configured domains like 'core' and 'discovery'. Finally, create and start your custom domains, ensuring a unique `PORT_OFFSET` is used.

```bash
# 1. Paylaşılan altyapıyı başlat
make up-infra

# 2. Önceden yapılandırılmış domain'ler (core ve discovery) kullanıma hazır
make up-vnext DOMAIN=core
make up-vnext DOMAIN=discovery

# 3. Kendi domain'ini oluştur ve başlat (offset 10 veya üstü kullan)
make create-domain DOMAIN=sales PORT_OFFSET=10
make up-vnext DOMAIN=sales

# 4. Tüm çalışan servisleri görüntüle
make status-all-domains
```

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

### Usage Examples for Configuration Access

Source: https://github.com/burgan-tech/vnext-docs/blob/main/i18n/en/docusaurus-plugin-content-docs/current/components/mappings.md

Demonstrates how to retrieve configuration values, including typed values with defaults, check for existence, and get connection strings within a mapping class.

```csharp
public class ConfigAwareMapping : ScriptBase, IMapping
{
    public Task<ScriptResponse> InputHandler(WorkflowTask task, ScriptContext context)
    {
        // Get simple configuration value
        var apiUrl = GetConfigValue("ExternalApi:BaseUrl");
        
        // Get with default value
        var timeout = GetConfigValue("ExternalApi:Timeout", "30");
        
        // Get typed configuration
        var maxRetries = GetConfigValue<int>("ExternalApi:MaxRetries", 3);
        var enableLogging = GetConfigValue<bool>("Features:EnableDetailedLogging", false);
        
        // Check if configuration exists
        if (ConfigExists("ExternalApi:SecondaryUrl"))
        {
            var secondaryUrl = GetConfigValue("ExternalApi:SecondaryUrl");
            LogInformation("Secondary URL configured: {0}", args: new object?[] { secondaryUrl });
        }
        
        // Get connection string
        var dbConnection = GetConnectionString("DefaultConnection");
        
        if (enableLogging)
        {
            LogDebug("API URL: {0}, Timeout: {1}, Max Retries: {2}", 
                args: new object?[] { apiUrl, timeout, maxRetries });
        }
        
        var httpTask = task as HttpTask;
        httpTask.SetUrl(apiUrl);
        httpTask.SetTimeout(int.Parse(timeout));
        
        return Task.FromResult(new ScriptResponse());
    }

    public Task<ScriptResponse> OutputHandler(ScriptContext context)
    {
        return Task.FromResult(new ScriptResponse());
    }
}
```

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

### Local Development Commands

Source: https://github.com/burgan-tech/vnext-docs/blob/main/CONTRIBUTING.md

Commands to install dependencies, start the development server with different locales, build for production, and serve the production build locally.

```bash
npm install
npm run start                  # Dev server (TR, default locale)
npm run start -- --locale en   # Dev server (EN)
npm run build                  # Production build (catches broken links)
npm run serve                  # Serve production build locally
```

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

### Start Services with Docker Compose

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/getting-started/local-dev.md

Navigate to the docker directory and use docker-compose to start, view logs, or restart services manually. Ensure environment files are configured correctly before starting.

```bash
cd vnext/docker

# Start all services in the background
docker-compose up -d

# Follow logs
docker-compose logs -f vnext-app

# Restart a specific service
docker-compose restart vnext-app
```

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

### Start Development Server

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/superpowers/plans/2026-04-24-phase-1-technical-migration.md

Starts the development server for visual verification of the documentation site. Access it at http://localhost:3000/vnext-docs/.

```bash
npm run start
```

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

### CLI Alias Examples

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/workflow-cli.md

Examples of using different aliases for the vNext Workflow CLI.

```bash
wf --version       # short alias
vnext --version    # recommended for Windows
workflow --version # full name
```

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

### Install vNext Workflow CLI

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/workflow-cli.md

Install the CLI globally for system-wide access or as a project dependency.

```bash
# Global installation (recommended)
npm install -g @burgan-tech/vnext-workflow-cli

# Or as a project dependency
npm install @burgan-tech/vnext-workflow-cli
```

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

### Clean and Reinstall Development Environment

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/getting-started/local-dev.md

This command performs a clean installation of the development environment. Use it to reset your local setup to a fresh state.

```bash
make reset
make dev
```

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

### Release Notes Structure Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/product/release-strategy/index.md

Example structure for release notes, detailing version, date, highlights, features, fixes, breaking changes, migration, and recommended actions.

```markdown
## v1.4.0 — 2026-05-08

### Highlights
- Visual Workflow Designer beta yayınlandı
- DaprPubSub task'a CloudEvents headers desteęi eklendi

### Features
- [Designer] Sürük-bırak workflow tasarımı
- [DaprPubSub] CloudEvents v1.0 headers parametreleri
- [Metrics] Persistent metric retention süresi yapılandırılabilir

### Fixes
- [Timer] Cron ifadelerinde DST kayması düzeltildi
- [Audit] Transition metadata'sı tüm task tiplerinde tutarlı

### Breaking Changes
- Yok

### Migration
- Yok (geriye uyumlu)

### Önerilen Aksiyon
- Visual Designer beta'sını staging ortamında deneyin
```

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

### Start Instance

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/rest-api.md

Initiates a new instance of a workflow.

```APIDOC
## POST /api/v1/{domain}/workflows/{workflow}/instances/start

### Description
Initiates a new instance of a workflow.

### Method
POST

### Endpoint
/api/v1/{domain}/workflows/{workflow}/instances/start

### Parameters
#### Path Parameters
- **domain** (string) - Required - Domain name
- **workflow** (string) - Required - Workflow key

#### Query Parameters
- **version** (string) - Optional - Workflow version
- **sync** (boolean) - Optional - `true` for synchronous execution, `false` for asynchronous (default `false`)
- **extensions** (string[]) - Optional - List of extensions to include in the response

#### Request Body
- **key** (string) - Required - Instance key (max 100 characters)
- **tags** (string[]) - Optional - Tags
- **attributes** (object) - Optional - Initial instance data
- **stage** (string | null) - Optional - User-defined status (max 120 characters, free text)

### Response
#### Success Response (200 OK)
- **id** (string) - Instance ID
- **key** (string) - Instance key
- **status** (string) - Instance status
- **attributes** (object) - Instance attributes
- **eTag** (string) - Entity tag for the instance
- **extensions** (object) - Included extensions

#### Error Response (400 Bad Request)
- ProblemDetails

#### Error Response (404 Not Found)
- Workflow not found

#### Error Response (409 Conflict)
- Key collision
```

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

### Transition Schema Mapping Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/interfaces.md

An example of how mapping is configured within a transition schema, specifying the code location for custom logic.

```json
{
  "key": "transition-name",
  "source": "source-state",
  "target": "target-state",
  "mapping": {
    "code": "BASE64_ENCODED_CSX_CONTENT",
    "location": "./TransitionMappingFile.csx"
  }
}
```

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

### Function Task Mapping Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/mappings.md

Example class demonstrating how to read query parameters within a Function task's InputHandler.

```csharp
public class FunctionTaskMapping : ScriptBase, IMapping
{
    public Task<ScriptResponse> InputHandler(WorkflowTask task, ScriptContext context)
    {
        var userId = context.QueryParameters?.["userId"];
        var cityId = context.QueryParameters?["cityId"];

        LogInformation("Function işleniyor - userId: {0}, cityId: {1}",
            args: new object?[] { userId, cityId });

        return Task.FromResult(new ScriptResponse());
    }

    public Task<ScriptResponse> OutputHandler(ScriptContext context) =>
        Task.FromResult(new ScriptResponse());
}
```

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

### ScriptResponse Short Usage Examples

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/mappings.md

Concise examples of returning a `ScriptResponse` with data, headers, and tags.

```csharp
return new ScriptResponse
{
    Data = new { success = true, userId = 123 }
};

return new ScriptResponse
{
    Data = requestData,
    Headers = new { Authorization = "Bearer " + token },
    Tags = new[] { "authentication", "success" }
};
```

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

### Package Publish Response Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/init-service.md

Example response after successfully accepting a package publish job. It provides the job ID and a status URL to poll for progress updates.

```json
{
  "jobId": "...",
  "statusUrl": "/api/package/publish/status/...",
  "message": "Job accepted. Poll statusUrl for progress."
}
```

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

### Example Code Block

Source: https://github.com/burgan-tech/vnext-docs/blob/main/blog-breaking-changes/2026-05-18-template.md

This snippet shows an example of previous and new code usage. Migration steps are provided in the surrounding text.

```text
// eski kullanim
```

```text
// yeni kullanim
```

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

### Start PostgreSQL Docker Container

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/workflow-cli.md

Start the PostgreSQL Docker container named 'vnext-postgres'. Use this command when database connections fail and Docker is enabled.

```bash
docker start vnext-postgres
```

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

### PaymentProcessingMapping Usage Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/i18n/en/docusaurus-plugin-content-docs/current/components/mappings.md

Demonstrates the usage of logging functions within a payment processing mapping. It includes examples of logging information, warnings, debug messages, and errors, utilizing parameterized messages.

```csharp
public class PaymentProcessingMapping : ScriptBase, IMapping
{
    public Task<ScriptResponse> InputHandler(WorkflowTask task, ScriptContext context)
    {
        LogInformation("Starting payment processing for user {0}", args: new object?[] { context.Instance.Data.userId });
        
        try
        {
            var amount = context.Body?.amount;
            if (amount == null || amount <= 0)
            {
                LogWarning("Invalid payment amount received: {0}", args: new object?[] { amount });
                return Task.FromResult(new ScriptResponse
                {
                    Data = new { error = "Invalid amount" }
                });
            }
            
            LogDebug("Processing payment amount: {0}", args: new object?[] { amount });
            
            // Process payment...
            
            LogInformation("Payment processed successfully");
            return Task.FromResult(new ScriptResponse { Data = new { success = true } });
        }
        catch (Exception ex)
        {
            LogError("Payment processing failed: {0}", args: new object?[] { ex.Message });
            throw;
        }
    }

    public Task<ScriptResponse> OutputHandler(ScriptContext context)
    {
        LogTrace("OutputHandler called with status code: {0}", args: new object?[] { context.Body?.statusCode });
        return Task.FromResult(new ScriptResponse());
    }
}
```

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

### List Configured Domains

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/getting-started/multi-domain.md

Lists all domains that have been configured in the system. This is useful for an overview of your setup.

```bash
make list-domains
```

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

### ETag Support - Initial Response

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/built-in.md

Example of a 200 OK response with data and ETag for caching.

```http
HTTP/1.1 200 OK
ETag: "W/\"v1\""
Content-Type: application/json

{
  "data": { ... },
  "eTag": "W/\"v1\""
}
```

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

### Setup Development Environment

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/getting-started/local-dev.md

Initializes the development environment by checking environment files and setting up the network.

```bash
make dev
```

```bash
make setup
```

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

### Filter Parameter Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/tasks/get-instances.md

Example of using the filter parameter with a JSON structure to specify conditions for fetching instances. This adheres to the Instance Filtering Guide.

```json
{
  "filter": ["{\"and\":[{\"status\":{\"eq\":\"Active\"}},{\"attributes.amount\":{\"gt\":\"1000\"}}]}"]
}
```

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

### HTTP GET Request for View Function

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/built-in.md

Example of an HTTP GET request to retrieve a view for a specific workflow instance. The 'view' function endpoint allows fetching UI definitions.

```http
GET /core/workflows/payment-flow/instances/abc-123/functions/data HTTP/1.1
Host: api.example.com
Accept: application/json
If-None-Match: "W/\"previous-etag\""
```

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

### ETag Support - Subsequent Request (No Change)

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/built-in.md

Example of a subsequent GET request using the If-None-Match header to check for data modification.

```http
GET /core/workflows/payment-flow/instances/123/functions/data
If-None-Match: "W/\"v1\""
```

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

### Publish Package with Full Configuration

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/init-service.md

This comprehensive example includes all available parameters for publishing a package. It demonstrates setting a custom npm registry, using an npm token, and enabling domain replacement with a specified app domain.

```http
POST /api/package/publish
Content-Type: application/json

{
  "packageName": "@my-org/my-workflow-package",
  "version": "1.0.0",
  "npmRegistry": "https://registry.your-company.com",
  "npmToken": "your-npm-token-here",
  "replaceDomain": true,
  "appDomain": "production",
  "reInitialize": true
}
```

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

### Start Workflow Instance

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/concepts/user-integration.md

Workflow örneğini başlatmak için kullanılır. Genellikle `sync=false` ile asenkron başlatılır.

```bash
POST /api/v1/{domain}/workflows/{wf}/instances/start
```

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

### Domain Creation Infrastructure Provisioning

Source: https://github.com/burgan-tech/vnext-docs/blob/main/architecture/domain-model/topology.md

Commands for provisioning infrastructure and deploying vNext runtime components during domain creation. This includes setting up databases, state stores, Pub/Sub configurations, and deploying runtime applications.

```bash
# Infrastructure provisioning
- Domain database oluşturma
- Domain state store yapılandırması
- Domain PubSub konfigürasyonu

# vNext Runtime deployment
- vnext-init ile system kurulum
- vnext-app deployment
- vnext-execution-app deployment
```

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

### StartInstanceOutput / TransitionOutput

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/rest-api.md

Output structure for starting an instance or transitioning between states. Includes ID, status, attributes, and ETags.

```typescript
{
  id: string;
  key?: string;
  status: InstanceStatus;
  attributes?: any;
  eTag?: string;
  entityEtag?: string;
  extensions?: { [key: string]: any };
}
```

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

### API Endpoint: Get All Domain Functions

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/custom.md

Retrieve all domain instances and data by calling this GET endpoint.

```http
GET /api/v1/{domain}/functions
```

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

### Configuration JSON Structure

Source: https://github.com/burgan-tech/vnext-docs/blob/main/i18n/en/docusaurus-plugin-content-docs/current/components/mappings.md

Illustrates a sample JSON structure for application configuration, showing how nested keys can be organized.

```json
{
  "ExternalApi": {
    "BaseUrl": "https://api.example.com",
    "Timeout": "30",
    "MaxRetries": 3,
    "SecondaryUrl": "https://backup-api.example.com"
  },
  "Features": {
    "EnableDetailedLogging": true
  },
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=mydb;User=sa;Password=xxx"
  }
}
```

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

### Successful Response Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/tasks/trigger.md

Example of a successful response when a task is executed, typically containing the instance ID and its status.

```json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "A"
}
```

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

### Build and Pack Project

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/init-service.md

Commands to build your project and create a package for deployment.

```bash
# Projeyi build edin
npm run build

# Paketi oluşturun
npm pack
```

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

### API Endpoint: Get Instance State

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/custom.md

Retrieve the current state information of an instance by calling this GET endpoint.

```http
GET /api/v1/{domain}/workflows/{workflow}/instances/{instance}/functions/state
```

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

### Build Runtime Package

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/template-cli.md

Builds the complete domain structure for engine deployment.

```bash
npm run build
```

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

### Example Appsettings Structure

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/mappings.md

Illustrative JSON structure for application settings, showing hierarchical keys separated by colons.

```json
{
  "ExternalApi": {
    "BaseUrl": "https://api.example.com",
    "Timeout": "30",
    "MaxRetries": 3,
    "SecondaryUrl": "https://backup-api.example.com"
  },
  "Features": { "EnableDetailedLogging": true },
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=mydb;..."
  }
}
```

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

### vnext.config.json Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/workflow-cli.md

A sample configuration file for the vNext Workflow CLI, defining project structure and paths.

```json
{
  "version": "1.0.0",
  "domain": "core",
  "paths": {
    "componentsRoot": "core",
    "tasks": "Tasks",
    "views": "Views",
    "functions": "Functions",
    "extensions": "Extensions",
    "workflows": "Workflows",
    "schemas": "Schemas"
  }
}
```

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

### API Endpoint: Get Specific Function Result

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/custom.md

Retrieve the result of a specific function within a domain by calling this GET endpoint.

```http
GET /api/v1/{domain}/functions/{function}
```

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

### Init Service

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/index.md

Paket deployment API'leri ve publish endpointleri.

```APIDOC
## Init Service

### Description
Bu bölüm, paket deployment API'lerini ve publish endpointlerini kapsar.

### Method
POST (Paket deployment ve publish işlemleri için yaygın)

### Endpoint
/api/init/... (Belirtilmemiş, ancak Init Service için yaygın bir yapı)

### Parameters
(Kaynak metinde belirtilmemiş)

### Request Example
(Kaynak metinde belirtilmemiş)

### Response
(Kaynak metinde belirtilmemiş)
```

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

### Install vNext Workflow CLI

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/index.md

Installs the vNext Workflow CLI globally. This tool is used for deploy, validation, and CSX mapping operations.

```bash
npm install -g @burgan-tech/vnext-workflow-cli
```

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

### Publish Package with Full Configuration

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/init-service.md

A comprehensive example of publishing a package with all available parameters, including token-based authentication and domain replacement settings.

```APIDOC
## POST /api/package/publish

### Description
Publishes a package with a full set of configuration options, including npm token authentication and domain replacement.

### Method
POST

### Endpoint
/api/package/publish

### Request Body
- **packageName** (string) - Required - The name of the package to publish.
- **version** (string) - Required - The version of the package.
- **npmRegistry** (string) - Required - The URL of the npm registry.
- **npmToken** (string) - Required - The npm token for authentication.
- **replaceDomain** (boolean) - Optional - Whether to replace the domain in component JSONs.
- **appDomain** (string) - Optional - The target domain to use when `replaceDomain` is true.
- **reInitialize** (boolean) - Optional - Whether to re-initialize the platform cache after publishing.

### Request Example
```json
{
  "packageName": "@my-org/my-workflow-package",
  "version": "1.0.0",
  "npmRegistry": "https://registry.your-company.com",
  "npmToken": "your-npm-token-here",
  "replaceDomain": true,
  "appDomain": "production",
  "reInitialize": true
}
```
```

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

### Schema Definition JSON Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/schema.md

This example shows the structure of a schema definition, including metadata and the actual JSON schema for attribute validation.

```json
{
  "key": "account-type-selection",
  "version": "1.0.0",
  "domain": "banking",
  "flow": "sys-schemas",
  "flowVersion": "1.0.0",
  "tags": ["banking", "account", "selection"],
  "_comment": "Hesap türü seçimi için transition schema",
  "attributes": {
    "type": "workflow",
    "schema": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "$id": "https://schemas.vnext.com/banking/account-type-selection.json",
      "title": "Account Type Selection",
      "description": "Schema for account type selection input",
      "type": "object",
      "required": ["accountType"],
      "properties": {
        "accountType": {
          "type": "string",
          "title": "Account Type",
          "description": "Type of account to be opened",
          "oneOf": [
            { "const": "demand-deposit", "description": "Vadesiz Hesap" },
            { "const": "time-deposit", "description": "Vadeli Hesap" },
            { "const": "savings-account", "description": "Tasarruf Hesabı" }
          ]
        }
      },
      "additionalProperties": false
    },
    "labels": [
      { "label": "Account Type Selection", "language": "en-US" },
      { "label": "Hesap Türü Seçimi", "language": "tr-TR" }
    ]
  }
}
```

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

### Workflow Start for Application Intake

Source: https://github.com/burgan-tech/vnext-docs/blob/main/business/industries/index.md

Initiates a workflow via REST API for tasks like application intake. This is the starting point for many automated processes.

```text
REST API üzerinden akış başlatılır
```

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

### ETag Support - Initial Request

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/built-in.md

Demonstrates the initial GET request to fetch data, including the ETag header in the response.

```http
GET /core/workflows/payment-flow/instances/123/functions/data
```

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

### Install vNext Forge Studio via VSIX

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/tools/forge-studio.md

Installs the vNext Forge Studio extension from a VSIX file using the VS Code command-line interface.

```bash
code --install-extension vnext-forge-studio-<version>.vsix
```

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

### JSON View Response Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/built-in.md

An example of a JSON response from the 'view' function endpoint when the content type is JSON. It includes view metadata and content for a form.

```json
{
  "key": "account-type-selection-view",
  "content": {
    "type": "form",
    "title": { "en-US": "Choose Your Account Type", "tr-TR": "Hesap Türünüzü Seçin" },
    "fields": [...]
  },
  "type": "Json",
  "display": "full-page",
  "label": "Hesap Tipi Seç"
}
```

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

### Clone vNext Runtime Repository

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/getting-started/multi-domain.md

Clone the public template repository to start your project. Navigate into the cloned directory to begin configuration.

```bash
git clone https://github.com/burgan-tech/vnext-runtime.git
cd vnext-runtime
```

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

### Start Workflow Instance via HTTP

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/getting-started/tutorial.md

Initiate a new workflow instance by sending a POST request to the /api/v1/{domain}/workflows/{workflow}/instances/start endpoint.

```bash
curl -X POST http://localhost:4201/api/v1/demo/workflows/simple-approval/instances/start \
  -H "Content-Type: application/json" \
  -d '{
    "key": "test-001",
    "tags": ["tutorial"],
    "attributes": {}
  }'
```

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

### Submit Transition

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/concepts/user-integration.md

Kullanıcı eylemi sonucunda bir transition'ı tetiklemek için kullanılır. Transition'a özel onay (modal/popup) gerekebilir.

```bash
PATCH /instances/{id}/transitions/{key}
```

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

### Standard Get Instances API Response

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/tasks/get-instances.md

This JSON object represents the standard response from the Get Instances API. It includes pagination links and a list of workflow instances.

```json
{
  "links": {
    "self": "/api/v1/core/workflows/order-workflow/instances?page=1&pageSize=10",
    "first": "/api/v1/core/workflows/order-workflow/instances?page=1&pageSize=10",
    "next": "/api/v1/core/workflows/order-workflow/instances?page=2&pageSize=10",
    "prev": ""
  },
  "items": [
    {
      "data": {
        "orderId": "ORDER-001",
        "status": "pending",
        "amount": 1500
      },
      "etag": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "extensions": {}
    },
    {
      "data": {
        "orderId": "ORDER-002",
        "status": "active",
        "amount": 2300
      },
      "etag": "01ARZ3NDEKTSV4RRFFQ69G5FAW",
      "extensions": {}
    }
  ]
}
```

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

### Completed Job Response Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/init-service.md

Example of a response for a job that has successfully completed. It includes the final status, progress details, and a results object detailing successful and failed components.

```json
{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "packageName": "@my-org/my-workflow-package",
  "status": "completed",
  "progress": {
    "current": 12,
    "total": 12,
    "currentFile": "core/Schemas/sys-schemas.json",
    "phase": "done"
  },
  "results": {
    "success": true,
    "message": "Package processed and published successfully",
    "packageName": "@my-org/my-workflow-package",
    "appDomain": "my-domain",
    "successful": ["core/Workflows/sys-flows.json", "core/Tasks/sys-tasks.json"],
    "failed": [],
    "skipped": []
  },
  "error": null,
  "cancelRequested": false,
  "cancelledAt": null,
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:31:20Z"
}
```

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

### HTTP GET Request with Range Filter

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/components/functions/built-in.md

Illustrates using the 'between' operator to filter instance attributes within a specified range in an HTTP GET request. This is useful for numerical attributes.

```http
GET /core/workflows/payment-flow/instances/abc-123/functions/data?filter=attributes=amount=between:100,500 HTTP/1.1
Host: api.example.com
Accept: application/json
```

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

### Transition View Configuration

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/how-to/view-selection.md

Utilize the same `views` array format for configuring views during transitions between states. This example defines mobile and desktop views for a submit transition.

```json
{
  "key": "submit-transition",
  "target": "review-state",
  "triggerType": 0,
  "views": [
    {
      "rule": { "location": "inline", "code": "...", "encoding": "NAT" },
      "view": { "domain": "forms", "key": "submit-mobile-view", "version": "1.0.0", "flow": "sys-views" },
      "loadData": true
    },
    {
      "view": { "domain": "forms", "key": "submit-desktop-view", "version": "1.0.0", "flow": "sys-views" },
      "loadData": true
    }
  ]
}
```

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

### Cancel Job Response Example

Source: https://github.com/burgan-tech/vnext-docs/blob/main/docs/api-reference/init-service.md

Example response after requesting to cancel a job. It indicates that the cancel signal was sent and the job will stop at the next checkpoint. Polling the status endpoint is recommended to confirm.

```json
{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing",
  "cancelRequested": true,
  "message": "Cancel signal sent. Job will stop at next checkpoint. Poll status endpoint to confirm."
}
```