Endpoint reference (classic API)

This page is generated by tools/collect_legacy_api.py from the controller annotations. Do not edit it by hand: run the generator instead.

142 endpoints documented.

The base is /api/1.0/{workspace}/; the resource name is the first segment of the path. See Classic REST API for authentication and conventions.

392 routes are left out: deprecated ones, those the new admin replaces, and the designer editing its own objects.

Cases (49)

Method	Path
GET	/
GET	/paged
GET	/draft
GET	/draft/paged
GET	/participated
GET	/participated/paged
GET	/unassigned
GET	/unassigned/paged
GET	/paused
GET	/paused/paged
GET	/advanced-search
GET	/advanced-search/paged
GET	/:appUid
GET	/:appUid/current-task
POST	/
POST	/impersonate
PUT	/:appUid/reassign-case
PUT	/:appUid/route-case
PUT	/:appUid/cancel
PUT	/:appUid/pause
PUT	/:appUid/unpause
PUT	/:appUid/claim
GET	/:appNumber/supervisor
PUT	/:appUid/:usrUid/assign
GET	/:task_uid/:app_uid/userstoreassign
PUT	/:appUid/execute-trigger/:tri_uid
DELETE	/:appUid
GET	/:appUid/variables
PUT	/:appUid/variable
GET	/:appUid/notes
GET	/:appUid/notes/:paged
POST	/:appUid/note
GET	/:appUid/tasks
PUT	/:appUid/execute-triggers
GET	/:appUid/:del_index/steps
GET	/start-cases
GET	/bookmark-start-cases
POST	/bookmark/:tas_uid
DELETE	/bookmark/:tas_uid
POST	/reassign
POST	/:appUid/upload/:var_name
POST	/:appUid/upload/:var_name/:doc_uid
POST	/:appUid/upload/:var_name/:doc_uid/:app_doc_uid
GET	/:appUid/sub-process-cases
GET	/advanced-search/filters
GET	/advanced-search/filter/:filterUid
POST	/advanced-search/filter
PUT	/advanced-search/filter/:filterUid
DELETE	/advanced-search/filter/:filterUid

Workspace lists (28)

Method	Path
GET	/draft
GET	/inbox
GET	/todo
GET	/unassigned
GET	/paused
POST	/draft/:id
POST	/inbox/:id
POST	/unassigned/:id
POST	/paused/:id
GET	/mycases
GET	/counters
GET	/mycases/counters
GET	/search
GET	/menu
GET	/:appNumber/pending-tasks
GET	/processes
GET	/users
GET	/:task/counter
GET	/:task/counter/caseList/:id
GET	/tasks/counter
GET	/tasks/highlight
GET	/tasks
GET	/process-debug-status
GET	/config/:id/:name
POST	/config
PUT	/config
DELETE	/config/:id/:name
GET	/categories

Counts and totals (20)

Method	Path
GET	/
GET	/inbox
GET	/inbox/total
GET	/total
GET	/participated
GET	/participated-last
GET	/participated/total
GET	/participated-last/total
GET	/participated-history
GET	/participated-history/total
GET	/paused
GET	/paused/total
GET	/canceled
GET	/canceled/total
GET	/completed
GET	/completed/total
GET	/my-inbox
GET	/my-inbox/total
GET	/unassigned
GET	/unassigned/total

Saved case lists (10)

Method	Path
POST	/
PUT	/:id
DELETE	/:id
GET	/inbox
GET	/draft
GET	/paused
GET	/unassigned
GET	/:id/export
POST	/import
GET	/:type/default-columns

Actions by email (10)

Method	Path
GET	/
GET	/editTemplate
PUT	/updateTemplate
GET	/loadFields
PUT	/saveConfiguration
GET	/loadActionByEmail
POST	/forwardMail
GET	/viewForm
GET	/Templates/:proId
GET	/Dynaforms/:proUid

Input documents (6)

Method	Path
GET	/:app_uid/input-documents
GET	/:app_uid/input-document/:inp_doc_uid
GET	/:app_uid/input-document/:app_doc_uid/file
DELETE	/:app_uid/:del_index/input-document/:app_doc_uid
POST	/:app_uid/input-document
GET	/:app_uid/input-document/:app_doc_uid/versions

Output documents (5)

Method	Path
GET	/:app_uid/output-documents
GET	/:app_uid/output-document/:app_doc_uid
GET	/:app_uid/output-document/:app_doc_uid/file
DELETE	/:app_uid/output-document/:app_doc_uid
POST	/:app_uid/:del_index/output-document/:out_doc_uid

Case variables (5)

Method	Path
GET	/:app_uid/:del_index/variable/:var_name/paged
GET	/:app_uid/:del_index/variable/:var_name
POST	/:app_uid/:del_index/variable/:var_name
PUT	/:app_uid/:del_index/variable/:var_name
DELETE	/:app_uid/:del_index/variable/:var_name

Process permissions (5)

Method	Path
GET	/:prj_uid/process-permissions
GET	/:prj_uid/process-permission/:ob_uid
POST	/:prj_uid/process-permission/
PUT	/:prj_uid/process-permission/:ob_uid
DELETE	/:prj_uid/process-permission/:ob_uid

Starting tasks per user (4)

Method	Path
GET	/:prj_uid/users
GET	/:prj_uid/starting-tasks
GET	/:prj_uid/user/:usr_uid/starting-tasks
POST	/:prj_uid/ws/user/can-start-task

Regenerating

make legacy-api