User guide
Quick Start Guide
Dashboard
Overviews
Case detail (Caseoverview)
Case - event
Tasks
Case notes
Documents
User settings
Favorites
Table component
FAQ
News/Announcements in Team assistant
Mobile app settings
Administrator Guide
Platform guide
Administration
Crons
Authentication and Synchronization
Mobile App Setup for Your Environment
Scheme
Dynamic tables
Archiving
Scripts
Service console
Scheduled Tasks
HR Agenda
Sequences
CSP Headers
Logs
Access Token Settings & Session Expiration
Template
Roles
Planning
Users
Organizational structure
Events
Translations
NFC Integration
AXIOS API
Calculations & Functions
Integrations
TAS Forms
TAS Forms
Activating the module on the environment
TAS Forms - secret creation guide for Docker Swarm
Advanced Features & Tips
Product
Technical Changelog
Business Changelog
Version Upgrade Guide
Upgrading to 5.7
Lodash upgrade v4.17.x (>v5.5)
Main changes and deprecated features (v5.3 > v5.7)
Highlighting variables in Read-only status (>v5.7.58)
Using validation functions
Upgrading to 5.3
Dynamic conditions migration
PDF printing adjustment
Editing Task Description vs Task Instructions
Transpiling forEach to a for loop
Rendering HTML on Caseoverview
Differences between TAS4 and TAS5 - a complete overview
Best Practices for Upgrading from v4 to v5
Technical details
News / Important information
- All Categories /
- Administrator Guide
- Integrations /
- TAS call module - TAS 2 TAS (process creation via API)
TAS call module - TAS 2 TAS (process creation via API)
The Endpoint Start Process API allows you to create a new case from an existing template, populate variables with input data, and immediately start the workflow with a single call. The operation is atomic — the case is either created completely or not at all.
5.7.75 and 5.17Endpoint
Method: POST
URL: /api/plugins/api-extensions/start-process
Authentication
Each call must include a Bearer token in the HTTP header:
Authorization: Bearer <accessToken>
Content-Type: application/json
Request body
{
"processId": 27, //Header ID of the selected process
"data": {
"processVariable1": "value1",
"processVariable2": "value2"
}
}Field | Type | Description |
|
| The process header (template) ID from which the case is created |
|
| Key–value pairs corresponding to template variables |
Supported value types in data
Type | Example |
String |
|
Number |
|
Date ( |
|
Call example
try {
const accessToken = 'xxxxxx';
const configStartNewProces = {
method: "post",
url: `/api/plugins/api-extensions/start-process`,
headers: {
"Authorization": `Bearer ${accessToken}`,
"Content-Type": "application/json"
},
data: JSON.stringify({
processId: 27, //Header ID of the selected process
data: {
"processVariable1": "value1",
"processVariable2": "value2"
}
})
};
const requestStartNewProces = axios.getAxios().requestRaw(configStartNewProces);
proc.warn(`requestStartNewProces Result`, { requestStartNewProces });
} catch (error) {
proc.warn(`requestStartNewProces error`, { error });
}async / await — the transpiler will fill them in automatically. Using them manually will cause an error at runtime.Administrator recommendations
- We recommend adding the
_isCaseCreatedByAPIvariable with the value"true"to thedataobject. This way, the template will immediately recognize that the case was created via the API and can react to this in conditions or routing. - All values from
dataare already available in the Start task — the workflow can work with them immediately (conditions, routing, decision-making) without having to wait for the next step.
"_isCaseCreatedByAPI": "true" — add this variable to the template as a text field and the workflow can read it right from the start.Error behavior
If any error occurs (invalid input, non-existent processId , problem starting workflow):
- the case will not be created ,
- no data will be saved ,
- No incomplete or "broken" processes will remain in the system.
Updated
by Frantisek Brych