Endpoint reference¶
This page is generated by
tools/collect_api_endpoints.pyfrom the product route files. Do not edit it by hand: run the generator instead.
60 endpoints for integrations.
The base is {host}/{workspace}/{language}/lurana/api. The workspace travels
in the request body, not in the path. See API concepts for authentication and the response format.
The API has more routes: the ones the admin screens use to call themselves. They are not for integrations and are not listed here — 117 routes are left out.
Each endpoint shows its method, path and controller action. The written pages explain the parameters and the behaviour.
Authentication (8)¶
| Method | Path | Action |
|---|---|---|
POST |
/auth/check-user |
LoginController@checkUser |
POST |
/auth/logo |
LoginController@logo |
POST |
/auth/login |
LoginController@login |
POST |
/auth/update-timezone |
LoginController@updateTimezone |
POST |
/auth/token/refresh |
TokenRefreshController@refresh |
POST |
/auth/forgot-password |
PasswordRecoveryController@forgotPassword |
POST |
/auth/validate-reset-token |
PasswordRecoveryController@validateToken |
POST |
/auth/reset-password |
PasswordRecoveryController@resetPassword |
OAuth token (1)¶
| Method | Path | Action |
|---|---|---|
POST |
/oauth/token |
— |
Cases (33)¶
| Method | Path | Action |
|---|---|---|
POST |
/home/counters |
CountersController@index |
POST |
/home/case-context |
CaseOpenController@getContext |
POST |
/home/case-steps/current |
CaseStepController@current |
POST |
/home/case-steps/advance |
CaseStepController@advance |
POST |
/home/case-steps/previous |
CaseStepController@previous |
POST |
/home/case-output-documents/generate |
CaseStepController@generateOutput |
POST |
/home/case-debug/breakpoint |
CaseOpenController@getDebugBreakpoint |
POST |
/home/case-history |
CaseOpenController@getHistory |
POST |
/home/case-input-documents/info |
CaseOpenController@getInputDocumentInfo |
POST |
/home/user-card |
CaseOpenController@getUserCard |
GET |
/home/user-name-format |
CaseOpenController@getUserNameFormat |
POST |
/home/case-input-documents/upload |
CaseOpenController@uploadInputDocuments |
POST |
/home/case-messages |
CaseOpenController@getMessages |
POST |
/home/case-messages/resend |
CaseOpenController@resendMessage |
GET, POST |
/home/case-messages/attachment |
CaseOpenController@downloadMessageAttachment |
POST |
/home/case-dynaforms |
CaseOpenController@getDynaforms |
POST |
/home/case-change-log |
CaseOpenController@getChangeLog |
POST |
/home/case-documents/uploaded |
CaseOpenController@getUploadedDocuments |
POST |
/home/case-documents/generated |
CaseOpenController@getGeneratedDocuments |
GET, POST |
/home/case-documents/download |
CaseOpenController@downloadDocument |
POST |
/home/case-notes |
CaseOpenController@getNotes |
POST |
/home/case-notes/create |
CaseOpenController@postNote |
POST |
/home/case-notes/users |
CaseOpenController@getUsers |
POST |
/home/case-claim |
CaseOpenController@claimCase |
POST |
/home/case-actions |
CaseOpenController@getActions |
POST |
/home/case-pause |
CaseOpenController@pauseCase |
POST |
/home/case-unpause |
CaseOpenController@unpauseCase |
POST |
/home/case-cancel |
CaseOpenController@cancelCase |
POST |
/home/case-delete |
CaseOpenController@deleteCase |
POST |
/home/case-reassign-users |
CaseOpenController@getReassignUsers |
POST |
/home/case-reassign |
CaseOpenController@reassignCase |
POST |
/home/case-derivation |
CaseOpenController@getDerivationData |
POST |
/home/case-derivate |
CaseOpenController@executeDerivation |
Search (2)¶
| Method | Path | Action |
|---|---|---|
POST |
/search |
GlobalSearchController@search |
POST |
/search/global |
GlobalSearchController@search |
Favorites and starting a case (4)¶
| Method | Path | Action |
|---|---|---|
POST |
/favorites/list |
FavoritesController@list |
POST |
/favorites/save |
FavoritesController@save |
POST |
/favorites/delete |
FavoritesController@delete |
POST |
/favorites/launch |
FavoritesController@launch |
Current user (1)¶
| Method | Path | Action |
|---|---|---|
POST |
/admin/me |
MeController@get |
Process discovery (1)¶
| Method | Path | Action |
|---|---|---|
POST |
/admin/processes/list |
ProcessController@list |
User provisioning (10)¶
| Method | Path | Action |
|---|---|---|
POST |
/admin/users/groups-list |
SettingsController@groupsList |
POST |
/admin/users/departments-list |
SettingsController@departmentsList |
POST |
/admin/users/roles-list |
SettingsController@rolesList |
POST |
/admin/users/list |
SettingsController@usersList |
POST |
/admin/users/get |
SettingsController@usersGet |
POST |
/admin/users/save |
SettingsController@usersSave |
POST |
/admin/users/status |
SettingsController@usersStatus |
POST |
/admin/users/test-username |
UserFormController@testUsername |
POST |
/admin/users/search |
UserFormController@searchUsers |
POST |
/admin/users/form-options |
UserFormController@formOptions |
Regenerating¶
make api-endpoints