Processes

Get an individual Process

get

Same as GetProcessById

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

processGuidstring · uuidRequired

Process unique identifier

processVersioninteger · int32Required

Process version

Responses

200

application/json

404

Process not found

application/problem+json

get

/api/v1/processes/{processGuid}/versions/{processVersion}

GET /api/v1/processes/{processGuid}/versions/{processVersion} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "isDeleted": true,
    "version": 1,
    "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "id": 1,
    "name": "text",
    "modified": "2025-11-28T00:31:33.597Z",
    "modifier": "text",
    "description": "text",
    "isNotLatestVersion": true,
    "changeDescription": "text",
    "bpmn": "text",
    "elementParameters": [
      {
        "id": "text",
        "type": "Start",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": [
            "[Circular Reference]"
          ]
        },
        "selectedTypeId": "text",
        "promoteResultAs": "text",
        "name": "text",
        "description": "text",
        "isDefault": true,
        "shouldRetry": true,
        "maxRetryCount": 1,
        "shouldNotLogResult": true,
        "shouldDispose": true
      }
    ],
    "manualTrigger": [
      [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    ],
    "obsoleteTasks": [
      {
        "uri": "text",
        "argumentsJson": "text",
        "returnType": "text",
        "name": "text",
        "displayName": "text",
        "packageName": "text",
        "description": "text",
        "isNotLatestVersion": true,
        "isStandard": true,
        "isDotNet": true
      }
    ],
    "draftId": 1,
    "idOfBaseProcessForDraft": 1,
    "isDraft": true,
    "isSubprocess": true,
    "graphData": {
      "ANY_ADDITIONAL_PROPERTY": [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    },
    "triggerData": [
      [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    ],
    "majorVersion": 1,
    "minorVersion": 1,
    "isMigration": true,
    "activateIfNew": true,
    "frendsVersion": "text",
    "ignoreDependencyConflicts": true,
    "documentationMarkdown": "text",
    "targetFramework": "text",
    "apiSpecId": 1,
    "isForMonitoringRule": true,
    "validationOnly": true,
    "cancellationDisabled": true,
    "processVariables": [
      {
        "name": "text",
        "value": "text",
        "isSecret": true,
        "mode": "text",
        "description": "text"
      }
    ],
    "processTemplate": {
      "id": 1,
      "name": "text",
      "modifier": "text",
      "modified": "2025-11-28T00:31:33.597Z",
      "majorVersion": 1,
      "minorVersion": 1,
      "targetFramework": "text",
      "frendsVersion": "text",
      "isSubprocess": true,
      "staticRequiredEnvironmentVariablesJson": "text",
      "isForMonitoringRule": true,
      "cancellationDisabled": true,
      "description": "text",
      "changeDescription": "text",
      "bpmn": "text",
      "elementParameters": "text",
      "promotedResultVariablesJson": "text",
      "usedSubprocessesJson": "text",
      "usedTasksJson": "text",
      "triggersJson": "text",
      "manualTriggerJson": "text",
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isListed": true,
      "version": 1,
      "isDeleted": true,
      "processVariablesJson": "text",
      "processTags": "text",
      "templateTags": [
        "text"
      ],
      "getVersion": "text"
    },
    "processTemplateDeviated": "2025-11-28T00:31:33.597Z",
    "nextProcessTemplate": {
      "id": 1,
      "name": "text",
      "modifier": "text",
      "modified": "2025-11-28T00:31:33.597Z",
      "majorVersion": 1,
      "minorVersion": 1,
      "targetFramework": "text",
      "frendsVersion": "text",
      "isSubprocess": true,
      "staticRequiredEnvironmentVariablesJson": "text",
      "isForMonitoringRule": true,
      "cancellationDisabled": true,
      "description": "text",
      "changeDescription": "text",
      "bpmn": "text",
      "elementParameters": "text",
      "promotedResultVariablesJson": "text",
      "usedSubprocessesJson": "text",
      "usedTasksJson": "text",
      "triggersJson": "text",
      "manualTriggerJson": "text",
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isListed": true,
      "version": 1,
      "isDeleted": true,
      "processVariablesJson": "text",
      "processTags": "text",
      "templateTags": [
        "text"
      ],
      "getVersion": "text"
    },
    "performAdditionalSyntaxValidation": true
  },
  "links": {
    "deployments": {
      "uri": "https://example.com",
      "method": "text"
    },
    "delete": {
      "uri": "https://example.com",
      "method": "text"
    }
  }
}

Get an individual Process by Id

get

Same as GetProcess

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

Process version unique identifier

Responses

200

application/json

404

Process not found

application/problem+json

get

/api/v1/processes/{id}

GET /api/v1/processes/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "isDeleted": true,
    "version": 1,
    "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "id": 1,
    "name": "text",
    "modified": "2025-11-28T00:31:33.597Z",
    "modifier": "text",
    "description": "text",
    "isNotLatestVersion": true,
    "changeDescription": "text",
    "bpmn": "text",
    "elementParameters": [
      {
        "id": "text",
        "type": "Start",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": [
            "[Circular Reference]"
          ]
        },
        "selectedTypeId": "text",
        "promoteResultAs": "text",
        "name": "text",
        "description": "text",
        "isDefault": true,
        "shouldRetry": true,
        "maxRetryCount": 1,
        "shouldNotLogResult": true,
        "shouldDispose": true
      }
    ],
    "manualTrigger": [
      [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    ],
    "obsoleteTasks": [
      {
        "uri": "text",
        "argumentsJson": "text",
        "returnType": "text",
        "name": "text",
        "displayName": "text",
        "packageName": "text",
        "description": "text",
        "isNotLatestVersion": true,
        "isStandard": true,
        "isDotNet": true
      }
    ],
    "draftId": 1,
    "idOfBaseProcessForDraft": 1,
    "isDraft": true,
    "isSubprocess": true,
    "graphData": {
      "ANY_ADDITIONAL_PROPERTY": [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    },
    "triggerData": [
      [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    ],
    "majorVersion": 1,
    "minorVersion": 1,
    "isMigration": true,
    "activateIfNew": true,
    "frendsVersion": "text",
    "ignoreDependencyConflicts": true,
    "documentationMarkdown": "text",
    "targetFramework": "text",
    "apiSpecId": 1,
    "isForMonitoringRule": true,
    "validationOnly": true,
    "cancellationDisabled": true,
    "processVariables": [
      {
        "name": "text",
        "value": "text",
        "isSecret": true,
        "mode": "text",
        "description": "text"
      }
    ],
    "processTemplate": {
      "id": 1,
      "name": "text",
      "modifier": "text",
      "modified": "2025-11-28T00:31:33.597Z",
      "majorVersion": 1,
      "minorVersion": 1,
      "targetFramework": "text",
      "frendsVersion": "text",
      "isSubprocess": true,
      "staticRequiredEnvironmentVariablesJson": "text",
      "isForMonitoringRule": true,
      "cancellationDisabled": true,
      "description": "text",
      "changeDescription": "text",
      "bpmn": "text",
      "elementParameters": "text",
      "promotedResultVariablesJson": "text",
      "usedSubprocessesJson": "text",
      "usedTasksJson": "text",
      "triggersJson": "text",
      "manualTriggerJson": "text",
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isListed": true,
      "version": 1,
      "isDeleted": true,
      "processVariablesJson": "text",
      "processTags": "text",
      "templateTags": [
        "text"
      ],
      "getVersion": "text"
    },
    "processTemplateDeviated": "2025-11-28T00:31:33.597Z",
    "nextProcessTemplate": {
      "id": 1,
      "name": "text",
      "modifier": "text",
      "modified": "2025-11-28T00:31:33.597Z",
      "majorVersion": 1,
      "minorVersion": 1,
      "targetFramework": "text",
      "frendsVersion": "text",
      "isSubprocess": true,
      "staticRequiredEnvironmentVariablesJson": "text",
      "isForMonitoringRule": true,
      "cancellationDisabled": true,
      "description": "text",
      "changeDescription": "text",
      "bpmn": "text",
      "elementParameters": "text",
      "promotedResultVariablesJson": "text",
      "usedSubprocessesJson": "text",
      "usedTasksJson": "text",
      "triggersJson": "text",
      "manualTriggerJson": "text",
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isListed": true,
      "version": 1,
      "isDeleted": true,
      "processVariablesJson": "text",
      "processTags": "text",
      "templateTags": [
        "text"
      ],
      "getVersion": "text"
    },
    "performAdditionalSyntaxValidation": true
  },
  "links": {
    "deployments": {
      "uri": "https://example.com",
      "method": "text"
    },
    "delete": {
      "uri": "https://example.com",
      "method": "text"
    }
  }
}

List Processes

get

If response data is empty there were no Processes found with the chosen filters

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Query parameters

PageNumberinteger · int32Optional

Current page number. Default value is 1.

PageSizeinteger · int32Optional

Maximum page size is 200. Default page size is 30.

processGuidstring · uuidOptional

Filter Processes by unique identifier

processNamestringOptional

Filter Processes by name

Responses

200

application/json

get

/api/v1/processes

GET /api/v1/processes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

{
  "data": [
    {
      "isDeleted": true,
      "version": 1,
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "id": 1,
      "name": "text",
      "modified": "2025-11-28T00:31:33.597Z",
      "modifier": "text",
      "description": "text",
      "isNotLatestVersion": true,
      "changeDescription": "text",
      "bpmn": "text",
      "elementParameters": [
        {
          "id": "text",
          "type": "Start",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
          },
          "selectedTypeId": "text",
          "promoteResultAs": "text",
          "name": "text",
          "description": "text",
          "isDefault": true,
          "shouldRetry": true,
          "maxRetryCount": 1,
          "shouldNotLogResult": true,
          "shouldDispose": true
        }
      ],
      "manualTrigger": [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ],
      "obsoleteTasks": [
        {
          "uri": "text",
          "argumentsJson": "text",
          "returnType": "text",
          "name": "text",
          "displayName": "text",
          "packageName": "text",
          "description": "text",
          "isNotLatestVersion": true,
          "isStandard": true,
          "isDotNet": true
        }
      ],
      "draftId": 1,
      "idOfBaseProcessForDraft": 1,
      "isDraft": true,
      "isSubprocess": true,
      "graphData": {
        "ANY_ADDITIONAL_PROPERTY": [
          [
            "[Circular Reference]"
          ]
        ]
      },
      "triggerData": [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ],
      "majorVersion": 1,
      "minorVersion": 1,
      "isMigration": true,
      "activateIfNew": true,
      "frendsVersion": "text",
      "ignoreDependencyConflicts": true,
      "documentationMarkdown": "text",
      "targetFramework": "text",
      "apiSpecId": 1,
      "isForMonitoringRule": true,
      "validationOnly": true,
      "cancellationDisabled": true,
      "processVariables": [
        {
          "name": "text",
          "value": "text",
          "isSecret": true,
          "mode": "text",
          "description": "text"
        }
      ],
      "processTemplate": {
        "id": 1,
        "name": "text",
        "modifier": "text",
        "modified": "2025-11-28T00:31:33.597Z",
        "majorVersion": 1,
        "minorVersion": 1,
        "targetFramework": "text",
        "frendsVersion": "text",
        "isSubprocess": true,
        "staticRequiredEnvironmentVariablesJson": "text",
        "isForMonitoringRule": true,
        "cancellationDisabled": true,
        "description": "text",
        "changeDescription": "text",
        "bpmn": "text",
        "elementParameters": "text",
        "promotedResultVariablesJson": "text",
        "usedSubprocessesJson": "text",
        "usedTasksJson": "text",
        "triggersJson": "text",
        "manualTriggerJson": "text",
        "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "isListed": true,
        "version": 1,
        "isDeleted": true,
        "processVariablesJson": "text",
        "processTags": "text",
        "templateTags": [
          "text"
        ],
        "getVersion": "text"
      },
      "processTemplateDeviated": "2025-11-28T00:31:33.597Z",
      "nextProcessTemplate": {
        "id": 1,
        "name": "text",
        "modifier": "text",
        "modified": "2025-11-28T00:31:33.597Z",
        "majorVersion": 1,
        "minorVersion": 1,
        "targetFramework": "text",
        "frendsVersion": "text",
        "isSubprocess": true,
        "staticRequiredEnvironmentVariablesJson": "text",
        "isForMonitoringRule": true,
        "cancellationDisabled": true,
        "description": "text",
        "changeDescription": "text",
        "bpmn": "text",
        "elementParameters": "text",
        "promotedResultVariablesJson": "text",
        "usedSubprocessesJson": "text",
        "usedTasksJson": "text",
        "triggersJson": "text",
        "manualTriggerJson": "text",
        "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "isListed": true,
        "version": 1,
        "isDeleted": true,
        "processVariablesJson": "text",
        "processTags": "text",
        "templateTags": [
          "text"
        ],
        "getVersion": "text"
      },
      "performAdditionalSyntaxValidation": true,
      "links": {
        "deployments": {
          "uri": "https://example.com",
          "method": "text"
        },
        "delete": {
          "uri": "https://example.com",
          "method": "text"
        }
      }
    }
  ],
  "paging": {
    "currentPage": 1,
    "pageSize": 1,
    "totalCount": 1,
    "firstPage": "https://example.com",
    "lastPage": "https://example.com",
    "nextPage": "https://example.com",
    "previousPage": "https://example.com"
  }
}

Delete Process and Undeploy from all Agent Groups

delete

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

processGuidstring · uuidRequired

Unique identifier for Process to delete

Responses

204

No Content

404

Not Found

application/problem+json

delete

/api/v1/processes/{processGuid}

DELETE /api/v1/processes/{processGuid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Export Process to file

get

Same as ExportWithId. Process Variables values are taken the Development Agent Group.

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

processGuidstring · uuidRequired

Process unique identifier

processVersioninteger · int32Required

Process version

Responses

200

application/json

Responsestring · binary

404

Process not found

application/problem+json

get

/api/v1/processes/{processGuid}/versions/{processVersion}/export

GET /api/v1/processes/{processGuid}/versions/{processVersion}/export HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

binary

Export Process to file

get

Same as Export. Process Variables values are taken the Development Agent Group.

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

Process version unique identifier

Responses

200

application/json

Responsestring · binary

404

Process not found

application/problem+json

get

/api/v1/processes/{id}/export

GET /api/v1/processes/{id}/export HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

binary

Export multiple Processes to file

get

Process Variables values are taken the Development Agent Group.

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Query parameters

idsinteger · int64[]Optional

List of Process Id's that should be exported.

Responses

200

application/json

Responsestring · binary

get

/api/v1/processes/batch-export

GET /api/v1/processes/batch-export HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

binary

Import one or more Processes

post

This can be a very slow action. Please make sure your client has a long enough timeout so that the operation does not get cancelled.

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body

File to upload.

filestring · binaryRequired

importConflictstring · enumRequired

Setting for deciding what to do when a Process GUID already exists. Error - the request will fail if Process exists.UseExisting - will not import Processes that exist.NewVersion - will update the existing Process to the imported one.NewActiveElement - will create a new Process with an Activated Trigger.NewInactiveElement - will create a new Process with an Deactivated Trigger.

Default: ErrorPossible values:

Responses

200

Process(es) imported successfully

application/json

400

File not found

application/problem+json

415

Unsupported Media Type

application/problem+json

422

Error in compilation

application/problem+json

post

/api/v1/processes/batch-import

POST /api/v1/processes/batch-import HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 42

{
  "file": "binary",
  "importConflict": "Error"
}

{
  "data": {
    "name": "text",
    "elementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "id": 1,
    "resourceLocation": "https://example.com",
    "version": 1
  }
}

PreviousProcessDeployments NextProcessInstances

Was this helpful?

Good night

Get an individual Process

Get an individual Process by Id

List Processes

Delete Process and Undeploy from all Agent Groups

Export Process to file

Export Process to file

Export multiple Processes to file

Import one or more Processes