WIRE developer reference
Open dashboardBrowse every implemented Route Handler, its accepted input, response contract, and authorization requirement. Path values in braces are required URL parameters.
Use the secure session cookie after login, or a scoped API key where the endpoint supports external access. Public and job-runner exceptions are marked explicitly.
Permissions use resource:action. Application-scoped checks also verify membership and access to the referenced Application.
List endpoints accept page and limit. The default limit is 10 and the maximum is 100.
Showing 123 of 123
/api/environmentsList standalone environmentsQuery: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list standalone environments in the standard success envelope.environment:read
/api/environmentsCreate a standalone environmentJSON: name, type/stage, optional URL/configuration.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: name, type/stage, optional URL/configuration.Updated create a standalone environment in the standard success envelope.environment:update
/api/environments/{id}Update an environmentPath: id. JSON: mutable environment fields.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: mutable environment fields.Updated update an environment in the standard success envelope.environment:update on {id}
/api/groupsList groupsQuery: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list groups in the standard success envelope.group:read
/api/groupsCreate a groupJSON: name, displayName?, description?.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: name, displayName?, description?.Updated create a group in the standard success envelope.group:update
/api/groups/{id}/membersList group membersPath: id. Query: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list group members in the standard success envelope.group:read on {id}
/api/groups/{id}/membersAdd or remove a group memberPath: id. JSON: userId, action.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: userId, action.Updated add or remove a group member in the standard success envelope.group:update on {id}
/api/organizationsList organizationsQuery: page (default 1), limit (default 10, maximum 100). Optional query: search, sort, order.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list organizations in the standard success envelope.organization:read
/api/organizationsCreate an organizationJSON: name, slug, optional domain/settings.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: name, slug, optional domain/settings.Updated create an organization in the standard success envelope.platform:organization:create
/api/organizations/{id}Delete an organizationPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Updated delete an organization in the standard success envelope.organization:delete
/api/organizations/{id}Read an organizationPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read an organization in the standard success envelope.organization:read
/api/organizations/{id}Update an organizationPath: id. JSON: mutable organization fields.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: mutable organization fields.Updated update an organization in the standard success envelope.organization:update
/api/rolesList rolesQuery: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list roles in the standard success envelope.role:read
/api/rolesCreate a custom roleJSON: name, displayName?, description?.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: name, displayName?, description?.Updated create a custom role in the standard success envelope.role:update
/api/roles/{id}/permissionsReplace role permissionsPath: id. JSON: permissionIds.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: permissionIds.Updated replace role permissions in the standard success envelope.role:update on {id}
/api/system-configRead workspace policyNo request body.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read workspace policy in the standard success envelope.system:read
/api/system-configUpdate workspace policyJSON: validated workspace security and retention policy.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: validated workspace security and retention policy.Updated update workspace policy in the standard success envelope.system:update
/api/usersList organization usersQuery: page (default 1), limit (default 10, maximum 100). Optional query: search, status.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list organization users in the standard success envelope.user:read
/api/usersCreate an organization userJSON: email, username, displayName?, password?, status?, roleIds?.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: email, username, displayName?, password?, status?, roleIds?.Updated create an organization user in the standard success envelope.user:create
/api/users/{id}Update a userPath: id. JSON: mutable identity and lifecycle fields.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: mutable identity and lifecycle fields.Updated update a user in the standard success envelope.user:update on {id}
/api/users/{id}/credentialsSet an initial passwordPath: id. JSON: password.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: password.Updated set an initial password in the standard success envelope.user:update on {id}
/api/users/{id}/rolesReplace user role assignmentsPath: user id. JSON: roleIds.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: roleIds.Updated replace user role assignments in the standard success envelope.role:update on {id}
/api/applicationsList ApplicationsQuery: page (default 1), limit (default 10, maximum 100). Optional query: search, status (active|archived).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list applications in the standard success envelope.application:read
/api/applicationsCreate an ApplicationJSON: name and optional description/key metadata.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: name and optional description/key metadata.Updated create an application in the standard success envelope.application:create
/api/applications/{id}Archive an ApplicationPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Updated archive an application in the standard success envelope.application:archive on {id}
/api/applications/{id}Read an ApplicationPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read an application in the standard success envelope.application:read on {id}
/api/applications/{id}Update an ApplicationPath: id. JSON: mutable Application fields.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: mutable Application fields.Updated update an application in the standard success envelope.application:update on {id}
/api/applications/{id}/design/casesSave an Application CMMN draftPath: id. JSON: key, name, cmmnXml, optional description/category.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: key, name, cmmnXml, optional description/category.Updated save an application cmmn draft in the standard success envelope.application:update on {id}
/api/applications/{id}/design/decisionsSave an Application DMN draftPath: id. JSON: key, name, dmnXml, optional description/category.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: key, name, dmnXml, optional description/category.Updated save an application dmn draft in the standard success envelope.application:update on {id}
/api/applications/{id}/design/formsSave an Application Form draftPath: id. JSON: key, name, UI schema, optional description/category.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: key, name, UI schema, optional description/category.Updated save an application form draft in the standard success envelope.application:update on {id}
/api/applications/{id}/design/processesSave an Application BPMN draftPath: id. JSON: key, name, bpmnXml, optional description/category.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: key, name, bpmnXml, optional description/category.Updated save an application bpmn draft in the standard success envelope.application:update on {id}
/api/applications/{id}/resourcesList linked or available resourcesPath: id. Query: page (default 1), limit (default 10, maximum 100). Query: availableType, search.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list linked or available resources in the standard success envelope.application:read on {id}
/api/applications/{id}/resourcesChange an entry-point designationPath: id. JSON: resourceId, isEntryPoint.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: resourceId, isEntryPoint.Updated change an entry-point designation in the standard success envelope.application:update on {id}
/api/applications/{id}/resourcesLink a resourcePath: id. JSON: resourceType, resourceId, optional isEntryPoint.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: resourceType, resourceId, optional isEntryPoint.Updated link a resource in the standard success envelope.application:update on {id}
/api/applications/{id}/resources/{resourceId}Unlink a resourcePath: id, resourceId.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Updated unlink a resource in the standard success envelope.application:update on {id}
/api/applications/{id}/resources/dependenciesPreview a dependency bundlePath: id. JSON: resourceType, resourceId.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: resourceType, resourceId.Updated preview a dependency bundle in the standard success envelope.application:update on {id}
/api/applications/{id}/resources/dependenciesAdopt a dependency bundlePath: id. JSON: resourceType, resourceId, confirmed dependency identities.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: resourceType, resourceId, confirmed dependency identities.Updated adopt a dependency bundle in the standard success envelope.application:update on {id}
/api/applications/{id}/validateValidate the Application dependency graphPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone.Updated validate the application dependency graph in the standard success envelope.application:read on {id}
/api/applications/{id}/versionsList immutable Application versionsPath: id. Query: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list immutable application versions in the standard success envelope.application:read on {id}
/api/applications/{id}/versionsCreate an immutable Application versionPath: id. JSON: semantic version, validatedDraftChecksum, optional release notes.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: semantic version, validatedDraftChecksum, optional release notes.Updated create an immutable application version in the standard success envelope.application:update on {id}
/api/applications/{id}/versions/{versionId}/exportExport an Application versionPath: id, versionId.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Portable Application pack containing manifest and frozen artifacts.application:read on {id}
/api/applications/importImport an Application packJSON: exported Application pack with manifest and typed resources.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: exported Application pack with manifest and typed resources.Updated import an application pack in the standard success envelope.application:create
/api/auth/activateActivate an invited accountJSON: token, password.
200 OK
No authentication header required.
Content-Type: application/jsonContent-Type: application/jsonJSON: token, password.Activated account confirmation.Public with activation token
/api/auth/loginCreate an authenticated sessionJSON: email, password, optional mfaCode.
201 Created
No authentication header required.
Content-Type: application/jsonContent-Type: application/json
Set-Cookie: auth_token=<opaque session>; HttpOnly; SameSite=LaxJSON: email, password, optional mfaCode.User profile and MFA/session state; sets the secure auth cookie.Public
/api/auth/logoutEnd the current sessionNo request body.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/json
Set-Cookie: auth_token=; Max-Age=0None.Success confirmation; clears the auth cookie.Authenticated session
/api/auth/meRead the current principalNo request body.
200 OK
No authentication header required.
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Current user, organization, roles, permissions, and principal kind.Public; returns 401 when unauthenticated
/api/auth/mfaManage or verify MFAJSON: action plus action-specific code or enrollment data.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: action plus action-specific code or enrollment data.MFA enrollment, verification, disable, or recovery result.Authenticated session
/api/auth/passwordChange the current passwordJSON: currentPassword, newPassword.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: currentPassword, newPassword.Password-change confirmation and session security result.Authenticated session
/api/auth/password-resetRequest password recoveryJSON: email.
200 OK
No authentication header required.
Content-Type: application/jsonContent-Type: application/jsonJSON: email.Generic accepted response that does not disclose account existence.Public
/api/auth/password-resetComplete password recoveryJSON: token, password.
200 OK
No authentication header required.
Content-Type: application/jsonContent-Type: application/jsonJSON: token, password.Password-reset confirmation.Public with reset token
/api/eventsCorrelate a BPMN message or signalJSON: processInstanceId, type (message|signal), name?, payload.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: processInstanceId, type (message|signal), name?, payload.Updated correlate a bpmn message or signal in the standard success envelope.process:control on processInstanceId
/api/processesList standalone process definitionsQuery: page (default 1), limit (default 10, maximum 100). Optional query: search, status, sort, order.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list standalone process definitions in the standard success envelope.process:read
/api/processesDeploy a standalone process definitionJSON: key, name, bpmnXml, optional description/category.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: key, name, bpmnXml, optional description/category.Updated deploy a standalone process definition in the standard success envelope.process:deploy
/api/processes/{id}Read a process definitionPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read a process definition in the standard success envelope.process:read on {id}
/api/processes/{id}Control a process definitionPath: id. JSON: action.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: action.Updated control a process definition in the standard success envelope.process:control on {id}
/api/processes/{id}/startRead the standalone Start Form contractPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Pinned Start Form metadata and schema, or null Form.process:start on {id}
/api/processes/{id}/startStart a standalone processPath: id. JSON: businessKey?, name?, variables, idempotencyKey?.
201 Created
Cookie: auth_token=<session>
OR Authorization: Bearer <API_KEY>
Content-Type: application/jsonContent-Type: application/jsonJSON: businessKey?, name?, variables, idempotencyKey?.Updated start a standalone process in the standard success envelope.Authenticated session with process:start on {id}; API keys are rejected
/api/processes/instancesList process instancesQuery: page (default 1), limit (default 10, maximum 100). Optional query: search, status, processDefinitionId, sort, order.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list process instances in the standard success envelope.process:read
/api/processes/instancesStart a process instanceJSON: processDefinitionId, businessKey?, name?, variables.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: processDefinitionId, businessKey?, name?, variables.Updated start a process instance in the standard success envelope.process:start
/api/casesList standalone case definitionsQuery: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list standalone case definitions in the standard success envelope.case:read
/api/casesDeploy a standalone case definitionJSON: key, name, cmmnXml, optional description/category.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: key, name, cmmnXml, optional description/category.Updated deploy a standalone case definition in the standard success envelope.case:deploy
/api/cases/{id}/startRead the standalone Case Start Form contractPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Pinned Case Start Form metadata and schema, or null Form.case:start on {id}
/api/cases/instancesList case instancesQuery: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list case instances in the standard success envelope.case:read
/api/cases/instancesStart a case instanceJSON: caseDefinitionId, businessKey?, name?, variables.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: caseDefinitionId, businessKey?, name?, variables.Updated start a case instance in the standard success envelope.case:start
/api/cases/instances/{id}Read a case instancePath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Case instance, executions, human tasks, milestones, and immutable history.case:read
/api/cases/instances/{id}Control a case instancePath: id. JSON: action (suspend|activate|complete|terminate).
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: action (suspend|activate|complete|terminate).Updated control a case instance in the standard success envelope.case:control
/api/cases/instances/{id}/plan-items/{executionId}Activate, trigger, or complete a case plan itemPath: id, executionId. JSON: action (activate|trigger|complete) and optional payload object. Complete applies only to an active manual-completion Stage whose active and required child work is finished.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: action (activate|trigger|complete) and optional payload object. Complete applies only to an active manual-completion Stage whose active and required child work is finished.Updated activate, trigger, or complete a case plan item in the standard success envelope.case:control on {id}
/api/cases/milestones/{id}Achieve an eligible milestonePath: id. JSON: action (achieve).
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: action (achieve).Updated achieve an eligible milestone in the standard success envelope.case:control
/api/cases/tasks/{id}Claim or complete a CMMN Human TaskPath: id. JSON: action (claim|complete), variables.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: action (claim|complete), variables.Updated claim or complete a cmmn human task in the standard success envelope.case:task:update
/api/applications/{id}/deploymentsList deploymentsPath: id. Query: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list deployments in the standard success envelope.deployment:read on {id}
/api/applications/{id}/deploymentsDeploy an Application versionPath: id. JSON: applicationVersionId, environmentId, idempotencyKey.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: applicationVersionId, environmentId, idempotencyKey.Updated deploy an application version in the standard success envelope.deployment:create on {id}
/api/applications/{id}/deployments/{deploymentId}Read deployment detailsPath: id, deploymentId.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read deployment details in the standard success envelope.deployment:read on {id}
/api/applications/{id}/deployments/{deploymentId}/approvalApprove or reject a deploymentPath: id, deploymentId. JSON: decision, optional comment.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: decision, optional comment.Updated approve or reject a deployment in the standard success envelope.deployment:approve on {id}
/api/applications/{id}/deployments/{deploymentId}/promotePromote a deploymentPath: id, deploymentId. JSON: environmentId, idempotencyKey.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: environmentId, idempotencyKey.Updated promote a deployment in the standard success envelope.deployment:promote on {id}
/api/applications/{id}/deployments/{deploymentId}/rollbackRoll back an environmentPath: id, deploymentId. JSON: targetDeploymentId, idempotencyKey.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: targetDeploymentId, idempotencyKey.Updated roll back an environment in the standard success envelope.deployment:rollback on {id}
/api/applications/{id}/deployments/preflightRun deployment preflightPath: id. JSON: applicationVersionId, environmentId.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: applicationVersionId, environmentId.Updated run deployment preflight in the standard success envelope.deployment:create on {id}
/api/applications/{id}/environmentsList Application environmentsPath: id. Query: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list application environments in the standard success envelope.deployment:read on {id}
/api/applications/{id}/environmentsCreate an Application environmentPath: id. JSON: name, stage, optional description/configuration.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: name, stage, optional description/configuration.Updated create an application environment in the standard success envelope.deployment:create on {id}
/api/operations/deployments/integrityInspect deployment integrityNo request body.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested inspect deployment integrity in the standard success envelope.deployment:read
/api/operations/deployments/integrityRun deployment maintenanceJSON: maintenance action and bounded selection parameters.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: maintenance action and bounded selection parameters.Updated run deployment maintenance in the standard success envelope.system:update
/api/decisionsList decision definitionsQuery: page (default 1), limit (default 10, maximum 100). Optional query: latest=true.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list decision definitions in the standard success envelope.decision:read
/api/decisionsDeploy a decision definitionJSON: key, name, dmnXml, optional description/category.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: key, name, dmnXml, optional description/category.Updated deploy a decision definition in the standard success envelope.decision:deploy
/api/decisions/{id}Read a decision definitionPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read a decision definition in the standard success envelope.decision:read on {id}
/api/decisions/evaluateEvaluate a decisionJSON: decisionDefinitionId, inputVariables, optional correlations.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: decisionDefinitionId, inputVariables, optional correlations.Updated evaluate a decision in the standard success envelope.decision:evaluate on decisionDefinitionId
/api/decisions/inspectInspect DMN without deployingJSON: dmnXml.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: dmnXml.Updated inspect dmn without deploying in the standard success envelope.decision:deploy
/api/formsList Form definitionsQuery: page (default 1), limit (default 10, maximum 100). Optional query: latest, status.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list form definitions in the standard success envelope.form:read
/api/formsCreate a Form draftJSON: key, name, UI schema, optional description/category.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: key, name, UI schema, optional description/category.Updated create a form draft in the standard success envelope.form:design
/api/forms/{id}Read a Form definitionPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read a form definition in the standard success envelope.form:read on {id}
/api/forms/{id}Publish a Form definitionPath: id. JSON: publish action/options.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: publish action/options.Updated publish a form definition in the standard success envelope.form:publish on {id}
/api/forms/{id}/submitSubmit Form dataPath: id. JSON: data and optional workflow correlation IDs.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: data and optional workflow correlation IDs.Updated submit form data in the standard success envelope.form:submit on {id}
/api/forms/{id}/uploadsUpload a Form attachmentPath: id. multipart/form-data with file.
201 Created
Cookie: auth_token=<session>
Content-Type: multipart/form-data; boundary=<generated>Content-Type: application/jsonmultipart/form-data containing the file field.Updated upload a form attachment in the standard success envelope.form:submit on {id}
/api/forms/uploads/{id}Download a Form attachmentPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: <stored file MIME type>
Content-Disposition: attachment; filename="<filename>"
Cache-Control: private, no-store
X-Content-Type-Options: nosniffNone. Path and query parameters are described above.Binary attachment with private no-store headers.form:read
/api/jobsList workflow jobsQuery: page (default 1), limit (default 10, maximum 100). Optional query: status.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list workflow jobs in the standard success envelope.job:read
/api/jobs/{id}Act on a workflow jobPath: id. JSON: action (complete|fail|retry|cancel), variables, errorMessage?.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: action (complete|fail|retry|cancel), variables, errorMessage?.Updated act on a workflow job in the standard success envelope.job:update on {id}
/api/jobs/runProcess due BPMN and CMMN timersAuthorization: Bearer secret. No body.
200 OK
Authorization: Bearer <JOB_RUNNER_SECRET>
Accept: application/jsonContent-Type: application/jsonNone.Counts plus per-job results and CMMN timer occurrence results.Bearer JOB_RUNNER_SECRET
/api/operations/jobs/bulkAct on multiple jobsJSON: jobIds (bounded), action, idempotencyKey.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: jobIds (bounded), action, idempotencyKey.Updated act on multiple jobs in the standard success envelope.job:update
/api/modeling/catalogSearch modeling resourcesQuery: page (default 1), limit (default 10, maximum 100). Query: type (form|decision|process|case), search?, applicationId?.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested search modeling resources in the standard success envelope.Type-derived read permission, or application:update when applicationId is supplied
/api/analyticsRead operational analyticsQuery: range or from/to; optional format=csv.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonJSON: Content-Type: application/json
CSV: Content-Type: text/csv; charset=utf-8; Content-Disposition: attachment; Cache-Control: private, no-storeNone. Path and query parameters are described above.JSON analytics snapshot, or formula-safe CSV when format=csv.analytics:read
/api/auditList audit or security eventsQuery: page (default 1), limit (default 10, maximum 100). Query: stream, search, start, end, action, result, optional format=csv.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonJSON: Content-Type: application/json
CSV: Content-Type: text/csv; charset=utf-8; Content-Disposition: attachment; Cache-Control: private, no-storeNone. Path and query parameters are described above.Requested list audit or security events in the standard success envelope.audit:read
/api/operations/processesList process operations recordsQuery: page (default 1), limit (default 10, maximum 100). Optional query: applicationId, applicationVersionId, deploymentId, environmentId, processDefinitionId, status, incident, businessKey, from, to.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list process operations records in the standard success envelope.process:read
/api/operations/processes/{id}Read a process operations summaryPath: process instance id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read a process operations summary in the standard success envelope.process:read on {id}
/api/operations/processes/{id}/{collection}List a process operations collectionPath: id, collection (executions|activities|tasks|variables|variable-history|jobs|events|audit). Query: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list a process operations collection in the standard success envelope.process:read on {id}
/api/operations/processes/{id}/variables/{variableId}Correct a running process variablePath: id, variableId. JSON: value.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: value.Updated correct a running process variable in the standard success envelope.process:control on {id}
/api/api-keysList API keysQuery: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list api keys in the standard success envelope.api-key:read
/api/api-keysCreate an API keyJSON: name, scopes, expiresAt?, allowedEntryPointIds?.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: name, scopes, expiresAt?, allowedEntryPointIds?.API-key metadata plus the plaintext token exactly once.api-key:create
/api/api-keys/{id}Revoke an API keyPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Updated revoke an api key in the standard success envelope.api-key:revoke
/api/sessionsList sessionsQuery: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list sessions in the standard success envelope.session:read
/api/sessions/{id}Revoke a sessionPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Updated revoke a session in the standard success envelope.session:revoke
/api/sessions/revoke-othersRevoke other sessionsNo request body.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone.Updated revoke other sessions in the standard success envelope.session:revoke
/api/tasksList visible BPMN tasksQuery: page (default 1), limit (default 10, maximum 100). Optional query: scope, search, status, processInstanceId, applicationId, environmentId, sort, order.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list visible bpmn tasks in the standard success envelope.Authenticated session; candidate-aware visibility
/api/tasksCreate a BPMN taskJSON: process/task identity, name, assignment, priority, due date, form key.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: process/task identity, name, assignment, priority, due date, form key.Updated create a bpmn task in the standard success envelope.task:create
/api/tasks/{id}Read a visible taskPath: id.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read a visible task in the standard success envelope.Authenticated session with task visibility
/api/tasks/{id}Act on a taskPath: id. JSON: action, variables, and action-specific assignment fields.
200 OK
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: action, variables, and action-specific assignment fields.Updated act on a task in the standard success envelope.task:update on {id}
/api/tasks/{id}/attachmentsList task attachmentsPath: id. Query: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list task attachments in the standard success envelope.Authenticated session with task visibility
/api/tasks/{id}/attachmentsUpload a task attachmentPath: id. multipart/form-data with file.
201 Created
Cookie: auth_token=<session>
Content-Type: multipart/form-data; boundary=<generated>Content-Type: application/jsonmultipart/form-data containing the file field.Updated upload a task attachment in the standard success envelope.Authenticated session with task visibility
/api/tasks/{id}/attachments/{attachmentId}Delete a task attachmentPath: id, attachmentId.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Updated delete a task attachment in the standard success envelope.Authenticated session with task visibility
/api/tasks/{id}/attachments/{attachmentId}/downloadDownload a task attachmentPath: id, attachmentId.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: <stored file MIME type>
Content-Disposition: attachment; filename="<filename>"
Cache-Control: private, no-store
X-Content-Type-Options: nosniffNone. Path and query parameters are described above.Binary attachment with private no-store headers.Authenticated session with task visibility
/api/tasks/{id}/commentsList task commentsPath: id. Query: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list task comments in the standard success envelope.Authenticated session with task visibility
/api/tasks/{id}/commentsAdd a task commentPath: id. JSON: message.
201 Created
Cookie: auth_token=<session>
Content-Type: application/jsonContent-Type: application/jsonJSON: message.Updated add a task comment in the standard success envelope.Authenticated session with task visibility
/api/work/applicationsList runtime ApplicationsQuery: page (default 1), limit (default 10, maximum 100).
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested list runtime applications in the standard success envelope.application:read
/api/work/applications/{id}Read a runtime Application workspacePath: id. Optional query: environmentId.
200 OK
Cookie: auth_token=<session>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Requested read a runtime application workspace in the standard success envelope.application:read
/api/work/entry-points/{id}Discover an active entry pointPath: entry-point id.
200 OK
Cookie: auth_token=<session>
OR Authorization: Bearer <API_KEY>
Accept: application/jsonContent-Type: application/jsonNone. Path and query parameters are described above.Deployment identity, entry-point metadata, and exact Start Form contract.Session or API key allowed for exact entry point
/api/work/entry-points/{id}/startStart an active Application entry pointPath: entry-point id. JSON: businessKey?, name?, variables, idempotencyKey?.
201 Created
Cookie: auth_token=<session>
OR Authorization: Bearer <API_KEY>
Content-Type: application/jsonContent-Type: application/jsonJSON: businessKey?, name?, variables, idempotencyKey?.Updated start an active application entry point in the standard success envelope.Session permission for process/case start, or API key with start scope and exact entry-point allowlist
{
"success": true,
"data": { }
}{
"success": true,
"data": [],
"meta": {
"pagination": {
"page": 1,
"limit": 10,
"total": 0,
"totalPages": 0
}
}
}{
"success": false,
"error": {
"message": "Human-readable message",
"code": "OPTIONAL_ERROR_CODE",
"details": { }
}
}This catalog documents the application contract at a practical level. Validation errors may include field-level details; exported files and attachment downloads return their declared binary content instead of the JSON envelope.