APIs for System Console

Owned by Akash Kumar Jaiswal (Unlicensed)
Last updated: Mar 14, 2022 by Rohan Dhanwade (Deactivated)Version comment
3 min read

You can use APIs to view the status of various sections of System Console without visiting Adeptia Connect.

Use any REST client with the following information as an input to process your request.

Component

Information type

REST URL

Refer to the URLs described later in this section for various sections of System Console. Replace <ipaddress/domain>:<port> with the relevant values in the URL.

IP Address, Domain, and Port address should be of the computer where Adeptia Connect is hosted.

Method TypeGET
Authorization TypeBasic 
HeaderAuthorization
User ID & PasswordAdministrator or Group Administrator User ID and Password for Base 64 encoding.

APIs

Click the relevant section to find API and expected response format.

 License Status
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=license

Response

{

"license":   {

"color": "#00cc00"
"name": "Status"
"value": "Valid till Dec 8, 2022"

}  {

"name": "Product Version"
"value": "4.0"

}  {

"name": "Details"
"value": "link"

}}

 Scheduler Status
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=scheduler
Response

{

"scheduler": [6]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "Running"
}
-1:  
{
"name": "Thread Count"
"value": "50"
}
-2:  
{
"name": "Thread Priority"
"value": "5"
}
-3:  
{
"name": "Misfire Threshold"
"value": "60000 miliseconds"
}
-4:  
{
"name": "Total Active Events"
"value": "40"
}
-5:  
{
"name": "Misfired Events in Last 24 Hours"
"warning-message": "63 events have misfired. This may lead to loss of data while processing. <a href="https://docs.adeptia.com/display/AS/Troubleshooting" target="_blank">Click here</a> to know how to handle misfired events."
"value": "63"
"threshold-crossed": true
}
}

 Backend Database Status
APIhttps:/<ipaddress/domain>:<port>/rest/diagnostics?component=backend-database
Response

{

"backend-database": [2]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
}

 Log Database Status
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=log-database
Response

{

"log-database": 
[10]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
-2:  
{
"name": "Process Flow Logs"
"value": "713305 Records"
}
-3:  
{
"name": "Event Logs"
"value": "102468 Records"
}
-4:  
{
"name": "System Logs"
"value": "36066 Records"
}
-5:  
{
"name": "Audit Trail"
"value": "5156 Records"
}
-6:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-7:  
{
"name": "Log Cleanup Status"
"value": " "
}
-8:  
{
"name": "Log Cleanup Execution Time"
"value": " "
}
-9:  
{
"name": "Next Scheduled Execution Time of Log Cleanup"
"value": "12/28/2017 03:00:00"
}
}

 Process Execution Status
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=process-execution
Response

{

"process-execution": [10]-0:  
{
"color": "#00cc00"
"name": "RabbitMQ Status"
"value": "Running"
}
-1:  
{
"name": "Concurrent Process Flow Execution Limit  (Shared Queue)"
"value": 5
}
-2:  
{
"name": "Running Process Flows"
"value": "0"
}
-3:  
{
"name": "Waiting Process Flows"
"value": "0"
}
-4:  
{
"name": "Queued Process Flows"
"value": "0"
}
-5:  
{
"name": "Total Active Process Flow"
"value": 36
}
-6:  
{
"name": "Logging Level"
"warning-message": "In production, the Logging Level should be set as ERROR for better performance."
"value": "ERROR: 27, INFO: 7, DEBUG: 2"
}
-7:  
{
"name": "Activity Logging Retention"
"warning-message": "In production, the Activity Logging Retention field should be set as NO LOGGING for better performance."
"value": "NO LOGGING: 0, DELETE ON SUCCESS: 25, DONT DELETE: 11"
}
-8:  
{
"name": "Repository Retention"
"warning-message": "In production, the Repository File Retention field should be set as DELETE for better performance."
"value": "DELETE: 0, DELETE ON SUCCESS: 3, DONT DELETE: 33"
}
-9:  
{
"name": "JDO Cache"
"value": "Enabled"
}
}

 Archive Log Database Status
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=archive-log-database
Response

{

"archive-log-database": [8]-0:  
{
"name": "Separate from Log Database"
"value": "No"
}
-1:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-2:  
{
"name": "Type"
"value": "MySQL"
}
-3:  
{
"name": "Process Flow Logs"
"value": "1018 Records"
}
-4:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-5:  
{
"name": "Archival Log Cleanup Status"
"value": " "
}
-6:  
{
"name": "Archival Log Cleanup Execution Time"
"value": " "
}
-7:  
{
"name": "Next Scheduled Execution Time of Archival Log Cleanup "
"value": "12/28/2017 03:00:00"
}
}

 Status of All Sections of System Console
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=all
Response

{

"license":   {

"color": "#00cc00"
"name": "Status"
"value": "Valid till Dec 8, 2022"

}  {

"name": "Product Version"
"value": "4.0"

}  {

"name": "Details"
"value": "link"

}

-"backend-database": [2]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
-"scheduler": [6]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "Running"
}
-1:  
{
"name": "Thread Count"
"value": "50"
}
-2:  
{
"name": "Thread Priority"
"value": "5"
}
-3:  
{
"name": "Misfire Threshold"
"value": "60000 miliseconds"
}
-4:  
{
"name": "Total Active Events"
"value": "38"
}
-5:  
{
"name": "Misfired Events in Last 24 Hours"
"warning-message": "64 events have misfired. This may lead to loss of data while processing. <a href="https://docs.adeptia.com/display/AS/Troubleshooting" target="_blank">Click here</a> to know how to handle misfired events."
"value": "64"
"threshold-crossed": true
}
-"process-execution": [10]-0:  
{
"color": "#00cc00"
"name": "RabbitMQ Status"
"value": "Running"
}
-1:  
{
"name": "Concurrent Process Flow Execution Limit"
"value": 5
}
-2:  
{
"name": "Running Process Flows"
"value": "0"
}
-3:  
{
"name": "Waiting Process Flows"
"value": "0"
}
-4:  
{
"name": "Queued Process Flows"
"value": "0"
}
-5:  
{
"name": "Total Active Process Flow"
"value": 36
}
-6:  
{
"name": "Logging Level"
"warning-message": "In production, the Logging Level should be set as ERROR for better performance."
"value": "ERROR: 27, INFO: 7, DEBUG: 2"
}
-7:  
{
"name": "Activity Logging Retention"
"warning-message": "In production, the Activity Logging Retention field should be set as NO LOGGING for better performance."
"value": "NO LOGGING: 0, DELETE ON SUCCESS: 25, DONT DELETE: 11"
}
-8:  
{
"name": "Repository Retention"
"warning-message": "In production, the Repository File Retention field should be set as DELETE for better performance."
"value": "DELETE: 0, DELETE ON SUCCESS: 3, DONT DELETE: 33"
}
-9:  
{
"name": "JDO Cache"
"value": "Enabled"
}
-"log-database":[10]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
-2:  
{
"name": "Process Flow Logs"
"value": "713312 Records"
}
-3:  
{
"name": "Event Logs"
"value": "102478 Records"
}
-4:  
{
"name": "System Logs"
"value": "36082 Records"
}
-5:  
{
"name": "Audit Trail"
"value": "5165 Records"
}
-6:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-7:  
{
"name": "Log Cleanup Status"
"value": " "
}
-8:  
{
"name": "Log Cleanup Execution Time"
"value": " "
}
-9:  
{
"name": "Next Scheduled Execution Time of Log Cleanup"
"value": "12/28/2017 03:00:00"
}
-"archive-log-database": [8]-0:  
{
"name": "Separate from Log Database"
"value": "No"
}
-1:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-2:  
{
"name": "Type"
"value": "MySQL"
}
-3:  
{
"name": "Process Flow Logs"
"value": "1018 Records"
}
-4:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-5:  
{
"name": "Archival Log Cleanup Status"
"value": " "
}
-6:  
{
"name": "Archival Log Cleanup Execution Time"
"value": " "
}
-7:  
{
"name": "Next Scheduled Execution Time of Archival Log Cleanup "
"value": "12/28/2017 03:00:00"
}
}
}
}
}

You may be interested in...
What is new
Best practices
Training guides
/wiki/spaces/AC400/pages/3444193
Adeptia Connect APIs
/wiki/spaces/AC400/pages/3444338