### Start New Instance with cURL

Source: https://developer.webcon.com/docs/api-operations

Example cURL command to start a new workflow instance. Ensure you have the correct database ID, path, and provide the workflow and form type in the request body.

```curl
curl -X POST "http://dev20/WEBCONBPS/api/data/v6.0/db/1/elements?path=default" \
-H "accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn (…) eyJiYWWqrZ6FdBI" \
-H "Content-Type: application/json" \
-d "{\"workflow\":{\"id\":21},\"formType\":{\"guid\":\"64148798-6847-49e0-8450-52969c6db3f3\"}}"
```

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

### Start Instance with Attachment (cURL Request)

Source: https://developer.webcon.com/docs/attachment-operations

Example cURL command to start a new workflow instance with an attachment. Ensure the Authorization header and Content-Type are correctly set.

```bash
curl -X POST "http://dev20/WEBCONBPS/api/data/v5.0/db/1/elements?path=default" \
-H "accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn (…) eyJiYWWqrZ6FdBI " \
-H "Content-Type: application/json" \
-d "{ \"workflow\": { \"guid\": \"a31da521-1352-4c63-8be6-5887a8fddc19\" }, \"formType\": { \"guid\": \"64148798-6847-49e0-8450-52969c6db3f3\" }, \"attachments\": [ { \"content\": \"U2FtcGxlIHZhbHVlIFdFQkNPTg==\", \"name\": \"Thomas Green CV.pdf\" \"group\": \"3#Application files\" } ]}" \

```

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

### Start Instance with Attachment using cURL

Source: https://developer.webcon.com/docs/api-attachments-operations

Example cURL command to initiate a new workflow instance with an attachment. Ensure the Authorization header contains a valid token and the Content-Type is set to application/json.

```bash
curl -X POST "http://dev20/WEBCONBPS/api/data/v6.0/db/1/elements?path=default" \
-H "accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn (…) eyJiYWWqrZ6FdBI " \
-H "Content-Type: application/json" \
-d "{ \"workflow\": { \"guid\": \"a31da521-1352-4c63-8be6-5887a8fddc19\" }, \"formType\": { \"guid\": \"64148798-6847-49e0-8450-52969c6db3f3\" }, \"attachments\": [ { \"content\": \"U2FtcGxlIHZhbHVlIFdFQkNPTg==\", \"name\": \"Thomas Green CV.pdf\" \"group\": \"3#Application files\" } ]}"

```

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

### Start New Element Instance (Path and Query Parameters)

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

This section outlines the path and query parameters for starting a new element instance. It specifies the required database ID and path, along with optional mode parameters for validation behavior.

```text
/api/data/v7.0/db/{dbId}/elements

pathrequired| string Path that will be used by element. Available values are: guid, id or key word 'default'  

mode| String <int32> (Root.ApiMode)  Enum: "standard" "ignoreReadonly" "admin" Optional mode parameter that specifies validation behavior. When empty or standard, all fields will be validated. When set ignoreReadonly, readonly fields won't be set but no error will be returned. Admin value allows to edit readonly fields, but requires admin permissions.  
```

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

### Start New Instance using cURL

Source: https://developer.webcon.com/docs/basic-operations

This cURL command demonstrates how to start a new workflow instance, including setting the workflow, form type, and specifying the database and path.

```curl
curl -X POST "http://dev20/WEBCONBPS/api/data/v5.0/db/1/elements?path=default" \
-H "accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn (…) eyJiYWWqrZ6FdBI" \
-H "Content-Type: application/json" \
-d "{\"workflow\":{\"id\":21},\"formType\":{\"guid\":\"64148798-6847-49e0-8450-52969c6db3f3\"}}"
```

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

### Start New Instance Request Body

Source: https://developer.webcon.com/docs/api-operations

Use this JSON body to start a new instance of a workflow. Specify the workflow and form type by their IDs or GUIDs.

```json
{
  "workflow": {
    "id": 21
  },
  "formType": {
    "guid": "64148798-6847-49e0-8450-52969c6db3f3"
  }
}
```

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

### Response Sample for Get User

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Example JSON response when successfully retrieving an external user's data. Includes user details and status.

```json
{
  "status": "Synchronized",
  "name": "string",
  "email": "string",
  "phoneNumber": "string",
  "managerBpsId": "string",
  "jobTitle": "string",
  "bpsId": "string"
}
```

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

### Starting new instance

Source: https://developer.webcon.com/docs/api-operations

Starts a new instance of a workflow, supporting field and item list value setting, and attachments. Requires appropriate user privileges.

```APIDOC
## POST /api/data/v6.0/db/{dbId}/elements?path={path}

### Description
Operation that starts new instance of a workflow. It supports setting fields and item lists values and adding attachments at the start step. Endpoint uses standard user privileges, so application or impersonated user should have launching instances permissions in order to use it.

### Method
POST

### Endpoint
`/api/data/v6.0/db/{dbId}/elements?path={path}`

### Parameters
#### Query Parameters
- **dbId** (string) - Required - Describes which content database should be used in order to start instance
- **path** (string) - Required - The transition path that will be used by started instance. Can be specified by three different values ID, guid or key word default

#### Request Body
- **workflow** (object) - Required - Identifies the workflow within which a new instance will be created, can be specified by either guid or id
  - **id** (integer) - Required
  - **guid** (string) - Required
- **formType** (object) - Required - Identifies the form type that will be used for new instance
  - **id** (integer) - Required
  - **guid** (string) - Required

### Request Example
```json
{
  "workflow": {
    "id": 21
  },
  "formType": {
    "guid": "64148798-6847-49e0-8450-52969c6db3f3"
  }
}
```

### Response
#### Success Response (200)
- **string** (string) - Description
```

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

### Get Selected Global Constant (GET)

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves a specific global constant by its ID or GUID. Requires read permissions for constants.

```json
{
  * "id": 0,
  * "guid": "string",
  * "name": "string",
  * "groupId": 0,
  * "groupName": "string",
  * "description": "string",
  * "common": {
    * "value": "string"
},
  * "dev": {
    * "value": "string",
    * "breakInheritance": true
},
  * "test": {
    * "value": "string",
    * "breakInheritance": true
},
  * "prod": {
    * "value": "string",
    * "breakInheritance": true
}

}
```

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

### StartStepID Property

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/a020e9c7-cdc2-d341-bbae-9f117e9a679a.htm

Gets the ID of the starting step for the workflow.

```APIDOC
## StartStepID Property

### Description
Gets the ID of the starting step for the workflow.

### Property Value
Type: Int32
```

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

### StartStepID Property

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/7aebe76d-bfa6-0396-16e1-1fc3a9f0a669.htm

Gets the starting workflow step ID.

```APIDOC
## StartStepID Property

### Description
Gets the starting workflow step ID.

### Property Value
Type: Int32
```

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

### Start Instance with Attachment

Source: https://developer.webcon.com/docs/api-attachments-operations

Starts a new workflow instance and adds one or more attachments to it. Attachments are provided as an array in the request body.

```APIDOC
## POST /api/data/v6.0/db/{dbId}/elements

### Description
Starts a new workflow instance and allows for the addition of one or more attachments. The attachments are specified in an 'attachments' array within the request body.

### Method
POST

### Endpoint
/api/data/v6.0/db/{dbId}/elements

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - The ID of the database.

#### Request Body
- **workflow** (object) - Required - Contains the GUID of the workflow.
  - **guid** (string) - Required - The GUID of the workflow.
- **formType** (object) - Required - Contains the GUID of the form type.
  - **guid** (string) - Required - The GUID of the form type.
- **attachments** (array) - Optional - An array of attachment objects to be added.
  - **name** (string) - Required - The desired name for the attachment, including the file extension.
  - **content** (string) - Required - The file content encoded as a base64 string.
  - **description** (string) - Optional - A description for the attachment.
  - **group** (string) - Optional - Specifies the attachment's group in the format 'ID#name'. If not provided, the attachment is added to the default group.

### Request Example
```json
{
  "workflow": {
    "guid": "a31da521-1352-4c63-8be6-5887a8fddc19"
  },
  "formType": {
    "guid": "64148798-6847-49e0-8450-52969c6db3f3"
  },
  "attachments": [
    {
      "content": "U2FtcGxlIHZhbHVlIFdFQkNPTg==",
      "name": "Thomas Green CV.pdf",
      "group": "3#Application files"
    }
  ]
}
```

### Curl Example
```bash
curl -X POST "http://dev20/WEBCONBPS/api/data/v6.0/db/1/elements?path=default" \
-H "accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn (…) eyJiYWWqrZ6FdBI " \
-H "Content-Type: application/json" \
-d "{ \"workflow\": { \"guid\": \"a31da521-1352-4c63-8be6-5887a8fddc19\" }, \"formType\": { \"guid\": \"64148798-6847-49e0-8450-52969c6db3f3\" }, \"attachments\": [ { \"content\": \"U2FtcGxlIHZhbHVlIFdFQkNPTg==\", \"name\": \"Thomas Green CV.pdf\" \"group\": \"3#Application files\" } ]}"
```
```

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

### StartPathID Property

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/7aebe76d-bfa6-0396-16e1-1fc3a9f0a669.htm

Gets the starting workflow path ID.

```APIDOC
## StartPathID Property

### Description
Gets the starting workflow path ID.

### Property Value
Type: Int32
```

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

### Get Application by ID/GUID Response

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Returns detailed metadata for a specific application, identified by its GUID or ID. Includes basic information and group details.

```json
{
  "id": 0,
  "guid": "string",
  "name": "string",
  "description": "string",
  "groupId": 0,
  "groupName": "string",
  "links": [
    {
      "href": "string",
      "method": "string",
      "rel": "string"
}
]

}
```

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

### Get Application by ID or GUID

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves metadata for a specific application using its GUID or ID. This endpoint requires read permissions for the application.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/applications/{idguid}

### Description
Retrieves metadata for a specific application using its GUID or ID. This endpoint requires read permissions for the application.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/applications/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Content database id
- **idguid** (string) - Required - Either guid or id of application

### Responses
#### Success Response (200)
- **id** (integer) - The ID of the application.
- **guid** (string) - The GUID of the application.
- **name** (string) - The name of the application.
- **description** (string) - The description of the application.
- **groupId** (integer) - The group ID of the application.
- **groupName** (string) - The name of the application's group.
- **links** (array) - Links related to the application.
  - **href** (string) - The URL of the link.
  - **method** (string) - The HTTP method for the link.
  - **rel** (string) - The relation of the link.

#### Response Example
```json
{
  "id": 0,
  "guid": "string",
  "name": "string",
  "description": "string",
  "groupId": 0,
  "groupName": "string",
  "links": [
    {
      "href": "string",
      "method": "string",
      "rel": "string"
    }
  ]
}
```
```

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

### Initialize SqlExecutionHelper (C++)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/49b78c10-d63b-a360-c5df-b0334c496df0.htm

Initializes a new instance of the SqlExecutionHelper class. Requires a BaseContext object representing the plugin running context.

```cpp
public:
SqlExecutionHelper(
	BaseContext^ context
)
```

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

### Get Process

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves metadata for a process using its GUID or ID.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/processes/{idguid}

### Description
Gets a process with the given guid or id.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/processes/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Content database id
- **idguid** (string) - Required - Either guid or id of process
```

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

### Initialize SqlExecutionHelper (F#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/49b78c10-d63b-a360-c5df-b0334c496df0.htm

Initializes a new instance of the SqlExecutionHelper class. Requires a BaseContext object representing the plugin running context.

```fsharp
new :
        context : BaseContext -> SqlExecutionHelper
```

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

### Starts new element instance

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Initiates a new element instance within a specified database. Requires appropriate element management permissions.

```APIDOC
## POST /api/data/v7.0/db/{dbId}/elements

### Description
Starts a new element instance in a selected database.

### Method
POST

### Endpoint
/api/data/v7.0/db/{dbId}/elements

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Database id

#### Query Parameters
- **path** (string) - Required - Path that will be used by element. Available values are: guid, id or key word 'default'.
- **mode** (string) - Optional - Enum: "standard" "ignoreReadonly" "admin". Specifies validation behavior. "standard" validates all fields. "ignoreReadonly" skips readonly fields without error. "admin" allows editing readonly fields but requires admin permissions.

### Responses
#### Success Response (200 or other success codes)
Details of the created element instance (specific response body not provided in source).

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **405** - Method Not Allowed
```

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

### Get Path

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves metadata for a path using its GUID or ID.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/paths/{idguid}

### Description
Gets a path with the given guid or id.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/paths/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Content database id
- **idguid** (string) - Required - Either guid or id of workflow

### Response
#### Success Response (200)
- **Path metadata**

#### Response Example
```json
{
  "id": 0,
  "guid": "string",
  "name": "string",
  "description": "string",
  "links": [
    {
      "href": "string",
      "method": "string",
      "rel": "string"
    }
  ]
}
```
```

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

### Start Instance with Attachment

Source: https://developer.webcon.com/docs/attachment-operations

Starts a new workflow instance and adds one or more attachments to it. Attachments are provided in an 'attachments' array within the request body.

```APIDOC
## POST /api/data/v5.0/db/{dbId}/elements

### Description
Starts a new workflow instance and adds one or more attachments to it. Attachments are provided in an 'attachments' array within the request body.

### Method
POST

### Endpoint
/api/data/v5.0/db/{dbId}/elements

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - The ID of the database.

#### Request Body
- **workflow** (object) - Required - Contains the GUID of the workflow.
  - **guid** (string) - Required - The GUID of the workflow.
- **formType** (object) - Required - Contains the GUID of the form type.
  - **guid** (string) - Required - The GUID of the form type.
- **attachments** (array) - Optional - An array of attachment objects to be added.
  - **name** (string) - Required - The desired name for the attachment, including the file extension.
  - **content** (string) - Required - The file content encoded as a Base64 string.
  - **description** (string) - Optional - A description for the attachment.
  - **group** (string) - Optional - Specifies the attachment's group in 'ID#name' format.

### Request Example
```json
{
  "workflow": {
    "guid": "a31da521-1352-4c63-8be6-5887a8fddc19"
  },
  "formType": {
    "guid": "64148798-6847-49e0-8450-52969c6db3f3"
  },
  "attachments": [
    {
      "content": "U2FtcGxlIHZhbHVlIFdFQkNPTg==",
      "name": "Thomas Green CV.pdf",
      "group": "3#Application files"
    }
  ]
}
```

### Curl Example
```bash
curl -X POST "http://dev20/WEBCONBPS/api/data/v5.0/db/1/elements?path=default" \
-H "accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn (…) eyJiYWWqrZ6FdBI " \
-H "Content-Type: application/json" \
-d "{ \"workflow\": { \"guid\": \"a31da521-1352-4c63-8be6-5887a8fddc19\" }, \"formType\": { \"guid\": \"64148798-6847-49e0-8450-52969c6db3f3\" }, \"attachments\": [ { \"content\": \"U2FtcGxlIHZhbHVlIFdFQkNPTg==\", \"name\": \"Thomas Green CV.pdf\" \"group\": \"3#Application files\" } ]}"
```

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

### Initialize ConnectionsHelper (C++)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/989edc63-0d2b-a3e3-914e-209922f30266.htm

Initializes a new instance of the ConnectionsHelper class using a BaseContext. This is used to establish a plugin running context.

```cpp
public:
ConnectionsHelper(
	BaseContext^ context
)
```

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

### Example Item List Structure

Source: https://developer.webcon.com/docs/api-workflow-instances

This section details metadata for instance item lists, including their ID, GUID, name, mode, columns, and rows. Each row contains cells with values.

```json
"itemLists": [
    {
      "id": 3,
      "guid": "791ef030-2901-4bfb-8212-c2aa1af8aa2f",
      "name": "string",
      "mode": "Incremental",
      "columns": [
        {
          "id": 7,
          "guid": "E554D815-F958-463A-B4DD-E2EB29B29FF2",
          "type": "SingleLine",
          "name": "Invoice number"
        }
      ],
      "rows": [
        {
          "id": 25,
          "delete": false,
          "cells": [
            {
              "value": "INV/2020/01/12"
              "id": 9,
              "guid": "AA80F5F8-4634-4940-9E3D-3265EFDB6EB1",
              "svalue": "INV/2020/01/12"
            }
          ]
        }
      ]
    }
  ]
```

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

### IDocumentsManager.GetNewDocumentAsync Method

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/387aa8df-88ef-d73c-c13c-51ebd82609f7.htm

Getting new workflow element to start new workflow.

```APIDOC
## IDocumentsManager.GetNewDocumentAsync Method

### Description
Getting new workflow element to start new workflow.

### Namespace
WebCon.WorkFlow.SDK.Documents

### Assembly
WebCon.WorkFlow.SDK (in WebCon.WorkFlow.SDK.dll)

### Method Signature (C#)
```csharp
Task<NewDocumentData> GetNewDocumentAsync(
	GetNewDocumentParams args
)
```

### Method Signature (VB)
```vb
Function GetNewDocumentAsync (
	args As GetNewDocumentParams
) As Task(Of NewDocumentData)
```

### Method Signature (C++)
```cpp
Task<NewDocumentData^>^ GetNewDocumentAsync(
	GetNewDocumentParams^ args
)
```

### Method Signature (F#)
```fsharp
abstract GetNewDocumentAsync : 
        args : GetNewDocumentParams -> Task<NewDocumentData>
```

### Parameters
#### args
- **Type**: WebCon.WorkFlow.SDK.Documents.Model.GetNewDocumentParams
- **Description**: New workflow element parameters

### Return Value
- **Type**: Task<NewDocumentData>
- **Description**: New workflow element ready to use in StartNewWorkFlow method.

### Reference
- IDocumentsManager Interface
- WebCon.WorkFlow.SDK.Documents Namespace
```

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

### Initialize SDKCheckoutException (C++)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/fc8e6869-9fa1-d106-9d3b-5f8d75e71dff.htm

Initializes a new instance of the SDKCheckoutException class in C++.

```cpp
public:
SDKCheckoutException()
```

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

### Initialize ConnectionsHelper (F#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/989edc63-0d2b-a3e3-914e-209922f30266.htm

Initializes a new instance of the ConnectionsHelper class using a BaseContext. This is used to establish a plugin running context.

```fsharp
new :
        context : BaseContext -> ConnectionsHelper
```

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

### DocumentsManager.GetNewDocumentAsync Method

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/170f9efd-05c3-929a-10d3-e0e26ae54942.htm

Getting new workflow element to start new workflow.

```APIDOC
## DocumentsManager.GetNewDocumentAsync Method

### Description
Getting new workflow element to start new workflow.

### Method Signature
```csharp
public Task<NewDocumentData> GetNewDocumentAsync(GetNewDocumentParams args)
```

### Parameters
#### Path Parameters
- **args** (WebCon.WorkFlow.SDK.Documents.Model.GetNewDocumentParams) - Required - New workflow element parameters

### Return Value
Type: Task<NewDocumentData>
New workflow element ready to use in StartNewWorkFlow method.

### Implements
IDocumentsManager.GetNewDocumentAsync(GetNewDocumentParams)
```

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

### Get Form Type

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves metadata for a form type using its GUID or ID.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/formtypes/{idguid}

### Description
Gets a formtype with the given guid or id.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/formtypes/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Content database id
- **idguid** (string) - Required - Either guid or id of formtype

### Response
#### Success Response (200)
- **Formtype metadata**

#### Response Example
```json
{
  "id": 0,
  "guid": "string",
  "name": "string",
  "description": "string",
  "links": [
    {
      "href": "string",
      "method": "string",
      "rel": "string"
    }
  ]
}
```
```

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

### Initialize SDKCheckoutException (F#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/fc8e6869-9fa1-d106-9d3b-5f8d75e71dff.htm

Initializes a new instance of the SDKCheckoutException class in F#.

```fsharp
new : unit -> SDKCheckoutException
```

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

### Initialize FileGenerationHelper (C++)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/bb6f8455-a689-4106-9bfc-312a68b38d58.htm

Initializes a new instance of the FileGenerationHelper class. Requires a BaseContext object.

```cpp
public:
FileGenerationHelper(
	BaseContext^ context
)
```

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

### Initialize FileGenerationHelper (F#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/bb6f8455-a689-4106-9bfc-312a68b38d58.htm

Initializes a new instance of the FileGenerationHelper class. Requires a BaseContext object.

```fsharp
new :
        context : BaseContext -> FileGenerationHelper
```

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

### Gets single data connection by either guid or id

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves a single data connection using its unique identifier, which can be either its GUID or its ID. This operation requires specific administrative permissions.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/admin/connections/{idguid}

### Description
Retrieves a single data connection by its unique identifier (GUID or ID).

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/admin/connections/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Database id
- **idguid** (string) - Required - Connection identifier, either guid or id

### Responses
#### Success Response (200)
Connection metadata

#### Error Responses
- **401**: Unauthorized
- **403**: Access denied. Admin permissions are required.
- **405**: Admin operations require not impersonated application.
```

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

### Get Process Constants (GET)

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieve a list of constants associated with a specific process. Requires App.Metadata.Read or App.Metadata.ReadWrite permissions. The response includes details for each constant, such as its ID, GUID, name, and associated links.

```json
{
  "constants": [
    {
      "id": 0,
      "guid": "string",
      "name": "string",
      "links": [
        {
          "href": "string",
          "method": "string",
          "rel": "string"
}
]
}
]

}
```

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

### Initialize SqlExecutionHelper (VB)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/49b78c10-d63b-a360-c5df-b0334c496df0.htm

Initializes a new instance of the SqlExecutionHelper class. Requires a BaseContext object representing the plugin running context.

```vb
Public Sub New (
	context As BaseContext
)
```

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

### Instantiate PluginConfiguration

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/26f530f5-2992-46ab-86bc-888fc1d59e33.htm

Use this constructor to create a new instance of the PluginConfiguration class. No specific setup or imports are required beyond the SDK assembly.

```csharp
public PluginConfiguration()
```

```vb
Public Sub New
```

```cpp
public:
PluginConfiguration()
```

```fsharp
new : unit -> PluginConfiguration
```

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

### Get Workflow

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves metadata for a specific workflow using its database ID and workflow GUID or ID.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/workflows/{idguid}

### Description
Gets a workflow with the given guid or id.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/workflows/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Content database id
- **idguid** (string) - Required - Either guid or id of workflow

### Responses
#### Success Response (200)
- **Workflow metadata** (object) - Contains the workflow's metadata.

#### Error Responses
- **400** - Invalid workflow identifier
- **401** - Unauthorized
- **403** - Insufficient permissions to view workflow
- **404** - Workflow not exists
```

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

### Get Step

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves metadata for a specific step using its database ID and step GUID or ID.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/steps/{idguid}

### Description
Gets a step with the given guid or id.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/steps/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Content database id
- **idguid** (string) - Required - Either guid or id of step

### Responses
#### Success Response (200)
- **Step metadata** (object) - Contains the step's metadata.

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Insufficient permissions to view step
- **404** - Step not exists
```

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

### Initialize ConnectionsHelper (C#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/989edc63-0d2b-a3e3-914e-209922f30266.htm

Initializes a new instance of the ConnectionsHelper class using a BaseContext. This is used to establish a plugin running context.

```csharp
public ConnectionsHelper(
	BaseContext context
)
```

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

### Initialize SDKKeyNotFoundException

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/bd80bbff-236b-81e4-3f3c-ae773c22450d.htm

Initializes a new instance of the SDKKeyNotFoundException class. This is the default constructor.

```csharp
public SDKKeyNotFoundException()
```

```vb
Public Sub New
```

```cpp
public: 
SDKKeyNotFoundException()
```

```fsharp
new : unit -> SDKKeyNotFoundException
```

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

### Get Report

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves metadata for a specific report using its database ID and report GUID or ID.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/reports/{idguid}

### Description
Retrieves metadata for a specific report.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/reports/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Content database id
- **idguid** (string) - Required - Either guid or id of report

### Responses
#### Success Response (200)
- **Report metadata** (object) - Contains the report's metadata.

#### Error Responses
- **400** - Invalid report identifier
- **401** - Unauthorized
- **403** - Insufficient permissions to view report
- **404** - Report not exists
```

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

### Example WEBCON BPS API Error Object

Source: https://developer.webcon.com/docs/api-errors

This is an example of the JSON error response object returned by the WEBCON BPS API. It includes the error type, a developer-facing description, and a unique error GUID for logging.

```json
{
  "type": "InvalidAuthenticationToken",
  "description": "Authentication token is invalid or has expired.",
  "errorGuid": "0a92939c-bd75-4cf7-8392-41776f9bf63b"
}
```

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

### Start the Extension Workbench

Source: https://developer.webcon.com/docs/form-field-extension-js-without-vs

Launches the WEBCON BPS Form Field Extension JS workbench, providing an environment to test your extension locally. This command should be run after building the extension.

```bash
npm start  
```

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

### StartNewWorkFlowAsync

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/1543bbe6-e93f-2ad9-2c7a-bff89fcff9c1.htm

Starts a new workflow.

```APIDOC
## StartNewWorkFlowAsync

### Description
Initiates a new workflow process.

### Method
`StartNewWorkFlowAsync`

### Parameters
This method does not explicitly list parameters in the provided documentation. Refer to the SDK for specific parameter details.

### Response
This method's response is not detailed in the provided documentation. Refer to the SDK for specific response details.
```

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

### Get StartStepID Property Value (F#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/cbe91263-264b-0510-d1dc-3c2da5abc389.htm

Retrieves the start step ID for the current workflow. This property is read-only.

```fsharp
member StartStepID : int with get
```

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

### Initialize SDKNotSupportedException (C++/CLI)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/5ee15b01-0e0e-e25a-a882-dc5ae5c44315.htm

Initializes a new instance of the SDKNotSupportedException class with default values. Use this constructor when an exception condition is not a result of another exception.

```cpp
public:
SDKNotSupportedException()
```

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

### Initialize FileGenerationHelper (C#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/bb6f8455-a689-4106-9bfc-312a68b38d58.htm

Initializes a new instance of the FileGenerationHelper class. Requires a BaseContext object.

```csharp
public FileGenerationHelper(
	BaseContext context
)
```

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

### Get StartStepID Property Value (C++)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/cbe91263-264b-0510-d1dc-3c2da5abc389.htm

Retrieves the start step ID for the current workflow. This property is read-only.

```cpp
public:
	property int StartStepID {
		int get ();
	}
```

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

### Get StartStepID Property Value (VB)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/cbe91263-264b-0510-d1dc-3c2da5abc389.htm

Retrieves the start step ID for the current workflow. This property is read-only.

```vb
Public ReadOnly Property StartStepID As Integer
	Get
```

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

### Initialize SqlExecutionHelper (C#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/49b78c10-d63b-a360-c5df-b0334c496df0.htm

Initializes a new instance of the SqlExecutionHelper class. Requires a BaseContext object representing the plugin running context.

```csharp
public SqlExecutionHelper(
	BaseContext context
)
```

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

### Get StartStepID Property Value (C#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/cbe91263-264b-0510-d1dc-3c2da5abc389.htm

Retrieves the start step ID for the current workflow. This property is read-only.

```csharp
public int StartStepID { get; }
```

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

### Example Links Section for Workflow

Source: https://developer.webcon.com/docs/api-metadata

This JSON snippet illustrates the 'links' section for a workflow, demonstrating how to access child resources like steps.

```json
"links": [
    {
      "href": "/api/data/v6.0/db/1/workflows/12/steps",
      "method": "GET",
      "rel": "steps"
    }
  ]

```

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

### Example Workflow Instance Header

Source: https://developer.webcon.com/docs/api-workflow-instances

This section contains basic metadata for a workflow instance, including IDs, version, author, dates, and workflow/form type information.

```json
"header": {
    "id": 240,
    "instanceNumber": "Api/2020/01/00017",
    "version": 5,
    "author": {
      "bpsId": "t.green@webcon.pl",
      "name": "Thomas Green"
    },
    "updatedBy": {
      "bpsId": " t.green@webcon.pl ",
      "name": "Thomas Green"
    },
    "creationDate": "2020-01-16T08:16:03.504Z",
    "modificationDate": "2020-01-16T08:16:03.504Z",
    "finishDate": "2020-01-16T08:16:03.504Z",
    "enterToCurrentStepDate": "2020-01-16T08:16:03.505Z",
    "step": {
      "id": 43,
      "guid": "adb07a18-95f3-40e6-a0f0-a54552fdc88e"
    },
    "workflow": {
      "id": 12,
      "guid": "d1fd2660-669e-4f84-9e1b-88814fef3365"
    },
    "company": {
      "id": 1,
      "guid": "E554D815-F958-463A-B4DD-E2EB29B29FF2"
    },
    "formType": {
      "id": 9,
      "guid": " f1905dde-12fc-46d5-a736-0dc61e838e5b"
    },
    "parentInstanceId": 205
 }
```

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

### ExtensionTransitionInfo.PreviousStepID Property

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/95dcc6f3-b1cd-4454-f4bd-ef115333cc47.htm

Gets the ID of the previous step for a document in the current workflow. The ID is not populated if it is the start step.

```APIDOC
## ExtensionTransitionInfo.PreviousStepID Property

### Description
Previous step id for document in current workflow. ID is not filled if it is start step.

### Property Value
Type: Int32
```

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

### Get Process Details

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves the details of a specific process using its database ID and process GUID or ID.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/processes/{idguid}

### Description
Retrieves the details of a specific process.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/processes/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Content database id
- **idguid** (string) - Required - Either guid or id of process

### Response
#### Success Response (200)
- **id** (integer) - Process ID
- **guid** (string) - Process GUID
- **name** (string) - Process name
- **description** (string) - Process description
- **links** (array) - Links related to the process
  - **href** (string)
  - **method** (string)
  - **rel** (string)

### Response Example
```json
{
  "id": 0,
  "guid": "string",
  "name": "string",
  "description": "string",
  "links": [
    {
      "href": "string",
      "method": "string",
      "rel": "string"
    }
  ]
}
```
```

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

### Publish the SDK Package

Source: https://developer.webcon.com/docs/form-field-extension-js-without-vs

Creates an installation package for WEBCON BPS Modern Form extensions using the publish-sdk script. This command is used to prepare the extension for deployment.

```bash
npm run publish-sdk  
```

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

### Initialize ADGroupSearchParameters using SID (F#)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/a9ff9806-2ad1-2d22-dc3d-09d0731bdb98.htm

This F# example illustrates creating an ADGroupSearchParameters instance using a group's SID and an optional domain.

```fsharp
static member FromSID :
        sid : string *
        ?domain : string
(* Defaults:
        let _domain = defaultArg domain null
*) -> ADGroupSearchParameters
```

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

### Get Single Data Connection by ID or GUID (REST API)

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Use this endpoint to retrieve metadata for a single data connection using its database ID and either its GUID or ID. Requires specific admin permissions.

```http
GET /api/data/v7.0/db/{dbId}/admin/connections/{idguid}
```

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

### Initialize DataSourcesHelper in C++

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/48e43a77-4ffc-53ad-cf82-2ed8b10cce5a.htm

Use this constructor to create an instance of DataSourcesHelper, providing the plugin's running context.

```cpp
public:
DataSourcesHelper(
	BaseContext^ baseContext
)
```

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

### Get Process Details API

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves detailed information about a specific process using its database ID and process GUID.

```json
{
  * "id": 0,
  * "guid": "string",
  * "name": "string",
  * "description": "string",
  * "links": [
    * {
      * "href": "string",
      * "method": "string",
      * "rel": "string"
}
]

}
```

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

### Initialize UserInfo in C++

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/ff0ed6fe-e5b1-1a80-3705-dae48e99d057.htm

Use this constructor to create a new UserInfo object by providing the user's BPS ID and display name.

```cpp
public:
UserInfo(
	String^ bpsID, 
	String^ displayName
)
```

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

### Get Applications Response

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves a list of applications available to the user, including their IDs, GUIDs, names, and associated links.

```json
{
  "applications": [
    {
      "id": 0,
      "guid": "string",
      "name": "string",
      "links": [
        {
          "href": "string",
          "method": "string",
          "rel": "string"
}
]
}
]

}
```

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

### SDKNotSupportedException Constructor (String, Exception)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/4cc00618-bfae-2ccc-d906-8a74ec4e0fb6.htm

Initializes a new instance of the SDKNotSupportedException class.

```APIDOC
## SDKNotSupportedException Constructor (String, Exception)

### Description
Initializes a new instance of the SDKNotSupportedException class.

### Parameters
#### Parameters
- **message** (System.String) - The error message that explains the reason for the exception.
- **innerException** (System.Exception) - The exception that is the cause of the current exception.
```

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

### Get Selected Global Constant

Source: https://developer.webcon.com/2026/resources/rest_api7.0/index.html

Retrieves a specific global constant by its ID or GUID. Requires appropriate admin permissions.

```APIDOC
## GET /api/data/v7.0/db/{dbId}/admin/constants/{idguid}

### Description
Retrieves a specific global constant by its ID or GUID.

### Method
GET

### Endpoint
/api/data/v7.0/db/{dbId}/admin/constants/{idguid}

### Parameters
#### Path Parameters
- **dbId** (integer) - Required - Database id
- **idguid** (string) - Required - Id or guid of the selected global constant

### Responses
#### Success Response (200)
- **id** (integer) - Constant identifier
- **guid** (string) - Constant unique identifier
- **name** (string) - Constant name
- **groupId** (integer) - Group identifier
- **groupName** (string) - Name of the group
- **description** (string) - Description of the constant
- **common** (object) - Common environment settings
  - **value** (string)
- **dev** (object) - Development environment settings
  - **value** (string)
  - **breakInheritance** (boolean)
- **test** (object) - Test environment settings
  - **value** (string)
  - **breakInheritance** (boolean)
- **prod** (object) - Production environment settings
  - **value** (string)
  - **breakInheritance** (boolean)

#### Error Responses
- **401** Unauthorized
- **403** Access denied. Admin permissions are required.
- **404** Selected constant does not exist.
- **405** Admin operations require not impersonated application.
```

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

### Get Element Form Field Data

Source: https://developer.webcon.com/docs/api-fields

This JSON structure represents the data returned when retrieving an element's form field, including its value, ID, GUID, type, string representation, and name. Use GUID for identification when possible.

```json
{
  "value": [
    {
      "id": "t.green@webcon.pl",
      "name": "Thomas Green"
    }
  ],
  "id": 392,
  "guid": "3238dbbd-3aff-4985-a531-cc5753fc6b59",
  "type": "People",
  "svalue": "t.green@webcon.pl#Thomas Green",
  "name": "Employee"
}

```

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

### ConfigEditableGrid Constructor (String, String)

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/0b1118d3-1d6d-2920-2d59-04086ef837cb.htm

Initializes a new instance of the ConfigEditableGrid class with a display name and an optional description.

```APIDOC
## ConfigEditableGrid Constructor (String, String)

### Description
Initializes ConfigEditableGrid attribute with displayName and description.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### Get Path Details

Source: https://developer.webcon.com/docs/api-metadata

Retrieves detailed metadata for a single path, including its ID, GUID, name, links, and extended properties.

```APIDOC
## GET /api/data/v6.0/db/{dbId}/paths/{idguid}

### Description
Retrieves detailed metadata for a single path.

### Method
GET

### Endpoint
/api/data/v6.0/db/{dbId}/paths/{idguid}

### Parameters
#### Path Parameters
- **dbId** (string) - Required - The ID of the database.
- **idguid** (string) - Required - The ID or GUID of the path.

### Response
#### Success Response (200)
- A path object containing ID, GUID, name, links, and extended properties.
```

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

### Get Step Details

Source: https://developer.webcon.com/docs/api-metadata

Retrieves detailed metadata for a single step, including its ID, GUID, name, links, and extended properties.

```APIDOC
## GET /api/data/v6.0/db/{dbId}/steps/{idguid}

### Description
Retrieves detailed metadata for a single step.

### Method
GET

### Endpoint
/api/data/v6.0/db/{dbId}/steps/{idguid}

### Parameters
#### Path Parameters
- **dbId** (string) - Required - The ID of the database.
- **idguid** (string) - Required - The ID or GUID of the step.

### Response
#### Success Response (200)
- A step object containing ID, GUID, name, links, and extended properties.
```

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

### Initialize UserDataProvider

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/2f47f4d3-bf04-eed0-5f7a-ededb6f60a59.htm

Initializes a new instance of the UserDataProvider class. Requires the plugin running context.

```csharp
public UserDataProvider(
	BaseContext baseContext
)
```

```vb
Public Sub New (
	baseContext As BaseContext
)
```

```cpp
public:
UserDataProvider(
	BaseContext^ baseContext
)
```

```fsharp
new :
        baseContext : BaseContext -> UserDataProvider
```

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

### SDKKeyNotFoundException Constructor

Source: https://developer.webcon.com/2026/resources/sdk-reference/html/bd80bbff-236b-81e4-3f3c-ae773c22450d.htm

Initializes a new instance of the SDKKeyNotFoundException class.

```APIDOC
## SDKKeyNotFoundException Constructor

### Description
Initializes a new instance of the SDKKeyNotFoundException class.

### Namespace
WebCon.WorkFlow.SDK.Exceptions

### Assembly
WebCon.WorkFlow.SDK (in WebCon.WorkFlow.SDK.dll)

### C#
```csharp
public SDKKeyNotFoundException()
```

### VB
```vb
Public Sub New
```

### C++ 
```cpp
public: SDKKeyNotFoundException()
```

### F#
```fsharp
new : unit -> SDKKeyNotFoundException
```
```

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

### Get Workflow Details

Source: https://developer.webcon.com/docs/api-metadata

Retrieves detailed metadata for a single workflow, including its ID, GUID, name, links, and extended properties.

```APIDOC
## GET /api/data/v6.0/db/{dbId}/workflows/{idguid}

### Description
Retrieves detailed metadata for a single workflow.

### Method
GET

### Endpoint
/api/data/v6.0/db/{dbId}/workflows/{idguid}

### Parameters
#### Path Parameters
- **dbId** (string) - Required - The ID of the database.
- **idguid** (string) - Required - The ID or GUID of the workflow.

### Response
#### Success Response (200)
- A workflow object containing ID, GUID, name, links, and extended properties.
```