ProcessTemplates

Lists all Process Templates

get

Lists all Process Templates including older versions and deleted ones. If response data is empty there were no Process Templates found with the chosen filters

Authorizations

Query parameters

PageNumberinteger · int32Optional

Current page number. Default value is 1.

PageSizeinteger · int32Optional

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

templateGuidstring · uuidOptional

Filter Process Templates by unique identifier

processTemplateNamestringOptional

Filter Process Templates by name

tagsstring[]Optional

Filter Process Templates by tags

processGuidstring · uuidOptional

Filter Process Templates by Process unique identifier

processNamestringOptional

Filter Process Templates by Process name

Responses

200

Success

application/json

get

GET /api/v1/process-templates HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Success

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "modifier": "text",
      "modified": "2025-09-07T10:06:06.550Z",
      "majorVersion": 1,
      "minorVersion": 1,
      "targetFramework": "text",
      "frendsVersion": "text",
      "isSubprocess": true,
      "staticRequiredEnvironmentVariablesJson": "text",
      "isForMonitoringRule": true,
      "description": "text",
      "promotedResultVariablesJson": "text",
      "usedSubprocessesJson": "text",
      "usedTasksJson": "text",
      "triggersJson": "text",
      "manualTriggerJson": "text",
      "isCrossPlatform": true,
      "isDotNet": true,
      "isListed": true,
      "version": 1,
      "isDeleted": true,
      "processVariablesJson": "text",
      "processTags": "text",
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "templateTags": [
        "text"
      ]
    }
  ],
  "paging": {
    "currentPage": 1,
    "pageSize": 1,
    "totalCount": 1,
    "firstPage": "https://example.com",
    "lastPage": "https://example.com",
    "nextPage": "https://example.com",
    "previousPage": "https://example.com"
  }
}

Create a new Process Template from a Process

post

Authorizations

Body

namestring · min: 1Optional

Element name

descriptionstring | nullableOptional

Element description

processIdinteger · int64Optional

Process id

guidstring · uuidOptional

templateMajorVersioninteger · int32 | nullableOptional

Templates major version

templateMinorVersioninteger · int32 | nullableOptional

Templates minor version

templateTagsstring[] | nullableOptional

Tags for the Process template

processTagsstring[] | nullableOptional

Predefined tags for Processes created from the template

linkProcessToCreatedTemplateboolean | nullableOptional

Link the Process to the created Template

Responses

201

Created Process Template id

text/plain

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

404

Process not found

application/problem+json

409

Process already has Process template

application/problem+json

500

Server Error

application/problem+json

post

POST /api/v1/process-templates HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 332

{
  "name": "text",
  "description": "text",
  "processVariables": [
    {
      "name": "text",
      "value": "text",
      "isSecret": true,
      "mode": "text",
      "description": "text"
    }
  ],
  "processId": 1,
  "guid": "123e4567-e89b-12d3-a456-426614174000",
  "templateMajorVersion": 1,
  "templateMinorVersion": 1,
  "templateTags": [
    "text"
  ],
  "processTags": [
    "text"
  ],
  "linkProcessToCreatedTemplate": true
}

{
  "data": 1
}

Update an existing Process Template from a Process

put

Authorizations

Body

namestring · min: 1Optional

Element name

descriptionstring | nullableOptional

Element description

processIdinteger · int64Optional

Process id

guidstring · uuidOptional

templateMajorVersioninteger · int32 | nullableOptional

Templates major version

templateMinorVersioninteger · int32 | nullableOptional

Templates minor version

templateTagsstring[] | nullableOptional

Tags for the Process template

processTagsstring[] | nullableOptional

Predefined tags for Processes created from the template

linkProcessToCreatedTemplateboolean | nullableOptional

Link the Process to the created Template

Responses

200

Updated Process template id

text/plain

Responseinteger · int64

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

404

Process cannot be found

application/problem+json

500

Server Error

application/problem+json

put

PUT /api/v1/process-templates HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 332

{
  "name": "text",
  "description": "text",
  "processVariables": [
    {
      "name": "text",
      "value": "text",
      "isSecret": true,
      "mode": "text",
      "description": "text"
    }
  ],
  "processId": 1,
  "guid": "123e4567-e89b-12d3-a456-426614174000",
  "templateMajorVersion": 1,
  "templateMinorVersion": 1,
  "templateTags": [
    "text"
  ],
  "processTags": [
    "text"
  ],
  "linkProcessToCreatedTemplate": true
}

Delete Process Templates

delete

Authorizations

Query parameters

templateIdsinteger · int64[]Optional

Responses

204

Deleted Process Templates successfully

No content

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

delete

DELETE /api/v1/process-templates HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Lists latest Process Templates

get

Lists the most recent versions of Process Templates. If response data is empty there were no Process Templates found with the chosen filters

Authorizations

Query parameters

PageNumberinteger · int32Optional

Current page number. Default value is 1.

PageSizeinteger · int32Optional

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

templateGuidstring · uuidOptional

Filter Process Templates by unique identifier

processTemplateNamestringOptional

Filter Process Templates by name

tagsstring[]Optional

Filter Process Templates by tags

processGuidstring · uuidOptional

Filter Process Templates by Process unique identifier

processNamestringOptional

Filter Process Templates by Process name

Responses

200

Success

application/json

get

GET /api/v1/process-templates/latest HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Success

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "modifier": "text",
      "modified": "2025-09-07T10:06:06.550Z",
      "majorVersion": 1,
      "minorVersion": 1,
      "targetFramework": "text",
      "frendsVersion": "text",
      "isSubprocess": true,
      "staticRequiredEnvironmentVariablesJson": "text",
      "isForMonitoringRule": true,
      "description": "text",
      "promotedResultVariablesJson": "text",
      "usedSubprocessesJson": "text",
      "usedTasksJson": "text",
      "triggersJson": "text",
      "manualTriggerJson": "text",
      "isCrossPlatform": true,
      "isDotNet": true,
      "isListed": true,
      "version": 1,
      "isDeleted": true,
      "processVariablesJson": "text",
      "processTags": "text",
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "templateTags": [
        "text"
      ]
    }
  ],
  "paging": {
    "currentPage": 1,
    "pageSize": 1,
    "totalCount": 1,
    "firstPage": "https://example.com",
    "lastPage": "https://example.com",
    "nextPage": "https://example.com",
    "previousPage": "https://example.com"
  }
}

Get an individual Process Template

get

Returns a detailed view of a Process Template

Authorizations

Path parameters

processTemplateGuidstring · uuidRequired

Process Template unique identifier

processTemplateVersioninteger · int32Required

Process Template version

Responses

200

Success

application/json

404

Process Template not found

application/problem+json

get

GET /api/v1/process-templates/{processTemplateGuid}/versions/{processTemplateVersion} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "modifier": "text",
    "modified": "2025-09-07T10:06:06.550Z",
    "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": {
      "major": 1,
      "minor": 1,
      "build": 1,
      "revision": 1,
      "majorRevision": 1,
      "minorRevision": 1
    }
  }
}

Get an individual Process Template by Id

get

Returns a detailed view of a Process Template

Authorizations

Path parameters

idinteger · int64Required

Process Template id

Responses

200

Success

application/json

404

Process Template not found

application/problem+json

get

GET /api/v1/process-templates/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "modifier": "text",
    "modified": "2025-09-07T10:06:06.550Z",
    "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": {
      "major": 1,
      "minor": 1,
      "build": 1,
      "revision": 1,
      "majorRevision": 1,
      "minorRevision": 1
    }
  }
}

Create a new Process from a Process Template

post

Authorizations

Path parameters

templateIdinteger · int64Required

Process Template id

Body

namestring · min: 1Optional

Element name

descriptionstring | nullableOptional

Element description

ignoreProcessTagsbooleanOptional

If true the Process will not be created with the predefined tags

Responses

201

Created Process id

text/plain

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

500

Server Error

application/problem+json

post

POST /api/v1/process-templates/{templateId}/create-process HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "name": "text",
  "description": "text",
  "processVariables": [
    {
      "name": "text",
      "value": "text",
      "isSecret": true,
      "mode": "text",
      "description": "text"
    }
  ],
  "ignoreProcessTags": true
}

{
  "data": 1
}

Updates Processes to the template's version

put

Authorizations

Path parameters

templateIdinteger · int64Required

Body

processIdsinteger · int64[] | nullableOptional

Responses

200

A dictionary mapping Process GUIDs to its id

No content

400

Expected between 1 and 20 Processes

application/problem+json

403

Forbidden

application/problem+json

500

Server Error

application/problem+json

put

PUT /api/v1/process-templates/{templateId}/update-processes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "processIds": [
    1
  ]
}

No content

Update Process Template tags

post

Authorizations

Body

templateIdsinteger · int64[]Optional

List of Process template ids

tagsstring[]Optional

Tags to be added to the Process templates

overwritebooleanOptional

If true the tags will be overwritten

Responses

204

Updated Process Template tags successfully

No content

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

post

POST /api/v1/process-templates/tag HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "templateIds": [
    1
  ],
  "tags": [
    "text"
  ],
  "overwrite": true
}

No content

Import Process Template from file

post

Authorizations

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 Template exists.

Default: ErrorPossible values:

Responses

200

Template imported successfully

application/json

400

File not found

application/problem+json

415

Client Error

application/problem+json

500

Server Error

application/problem+json

post

POST /api/v1/process-templates/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
  }
}

Export Process Templates

get

Authorizations

Query parameters

templateIdsinteger · int64[]Optional

Responses

200

Success

application/json

Responsestring · binary

get

GET /api/v1/process-templates/export HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Success

binary

PreviousProcessInstances NextTags

Was this helpful?