WFE "isActive" API Deprecated
- 20 Apr 2023
-
DarkLight
-
PDF
WFE "isActive" API Deprecated
- Updated on 20 Apr 2023
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Deprecating the "isActive" API
Beginning in the 2023.1 release, the workflow_engine/active
API is deprecated from Workflow Engine (WFE) and scheduled to be replaced by the /workflow_engine/workers/status
API. Our policy is to provide a deprecation notice two (2) release cycles in advance (at a minimum) before the API is removed.
API Endpoint | Description | Deprecation Release | Scheduled Removal Release | Replacement |
---|---|---|---|---|
POST /workflow_engine/active | Gets the status and configured startup values for jobWorker and taskWorker. | 2031.1 | 2024.1 | GET /workflow_engine/workers/status |
What should I do?
Review any apps and adapters that might reference the deprecated API and change it to the replacement call.
Deprecated Route
"route": {
"path": "/workflow_engine/active",
"verb": "POST"
},
Output
true
Replacement Route
"route": {
"path": "/workflow_engine/workers/status",
"verb": "GET"
},
Output
{
"jobWorker": {
"running": true,
"clusterValue": "not defined",
"localValue": "not defined",
"startupValue": true
},
"taskWorker": {
"running": true,
"clusterValue": "not defined",
"localValue": "not defined",
"startupValue": true
}
}
Was this article helpful?