APIs for Viewing Logs

Refer to the URLs described in the next table for various types of logs in Adeptia Suite.

Same Day Process Flow Logs

This API will fetch the process flow logs of the day you are running the check.

This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.

/adeptia/api/manageServiceApi/PFLog?page=1&start=0&limit=20

Process Flow logs within a Date Range

This API will fetch process flow logs for the given date range.

• You can change the date and time values in the API (without changing the format).
• This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.
• You can filter the logs by giving values of following parameters in API endpoint
  • pfstatus - This parameter filters the logs based on process flow execution status. Following are the possible values: Executed, Failed, Aborted, Running, Waiting. You can use only one possible value for pfstatus at a time.
  • pfname - This parameter filters the logs based on the process flow name. As a value, provide PF name against the parameter. You can use only one name for pfname at a time.
  • pfid - This parameter filters the logs based on the process flow id. As a value, provide PF id against the parameter. You can use only one id for pfid at a time.
  • pfnodename - This parameter filters the logs based on the node where the process flow is being executed (this is applicable only in clustered mode). As a value, provide node's IP/hostname against the parameter. You can use only one IP/hostname for a pfnode name at a time.
  • archiveFlag - The possible values for this parameter can be true or false. If the value is set to true, then API will fetch the PF logs from the archival database, If the value is set to false, API will only fetch the log data from the log database only.

Note: You must not delete any parameter from the API in case there filter is required. In this case, leave the parameter blank (e.g. the first API in API Endpoint column of this table). Second example API gives the endpoint with filters applied with parameteres' values.

/adeptia/api/manageServiceApi/PFLog?page=1&start=0&limit=20&advancesearch=fromdate=05-04-2019$fromtime=00:00$todate=05-04-2019$totime=23:59$pfstatus=$pfname=$pfid=$pfnodename=$archiveFlag=false

Example API Endpoint for fetching all details of a PF

/adeptia/api/manageServiceApi/PFLog?page=1&start=0&limit=20&advancesearch=fromdate=05-04-2019$fromtime=00:00$todate=05-04-2019$totime=23:59$pfstatus=Executed$pfname=AC_2_0_PF_Main$pfid=$pfnodename=192.168.1.123$archiveFlag=false

Same Day Event Logs

This API will fetch the event logs of the day you are running the check.

This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.

/adeptia/api/manageServiceApi/EventLog?page=1&start=0&limit=20

Event Logs within a Date Range

This API will fetch event logs for the given date range.

• You can change the date and time values in the API (without changing the format).
• This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.
• You can filter the logs by giving values of the following parameter in API endpoint
  • loglevel - This parameter filters the logs based on event logging level status. Following are the possible values: INFO, DEBUG, WARN, ERROR. You can use only one possible value for loglevel at a time.
  • If you don't require filtered list based on loglevel, you can remove the logelvel parameter from the endpoint or leave it blank.

/adeptia/api/manageServiceApi/EventLog?page=1&start=0&limit=20& advancesearch=fromdate=05-04-2019$fromtime=00:00$todate=05-04-2019$totime=23:59$loglevel=INFO

Same Day System Logs

This API will fetch the system logs of the day you are running the check.

This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.

/adeptia/api/manageServiceApi/SystemLog?page=1&start=0&limit=20

System Logs within a Date Range 

This API will fetch the system logs for the given date range.

• You can change the date and time values in the API (without changing the format).
• This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.
• You can filter the logs by giving values of the following parameter in API endpoint
  • loglevel - This parameter filters the logs based on event logging level status. Following are the possible values: INFO, DEBUG, WARN, ERROR. You can use only one possiblevalueforloglevel at a time. If you don't require filtered list based on loglevel, you can remove the logelvel parameter from the endpoint or leave it blank.

Same Day SAP Logs

This API will fetch the SAP logs of the day you are running the check.

This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.

SAP Logs within a Date Range 

This API will fetch SAP logs for the given date range.

• You can change the date and time values in the API (without changing the format).
• This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit change the limit value from 20 to the desired number.
• You can filter the logs by giving values of the following parameter in API endpoint
  • archiveFlag - The possible values for this parameter can be true or false. If the value is set to true, then API will fetch the SAP logs from the archival database, If the value is set to false, API will only fetch the log data from the log database only.

/adeptia/api/manageServiceApi/SAPLog?page=1&start=0&limit=20&advancesearch=fromdate=05-04-2019$fromtime=00:00$todate=05-04-2019$totime=23:59$archiveFlag=false

Audit Trail Logs

This API will fetch the audit trail logs of the day you are running the check.

This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.

/adeptia/api/manageServiceApi/AuditTrailLog?page=1&start=0&limit=20

Audit Trail Logs within a Date Range

This API will fetch the audit trail logs for the given date range.

• You can change the date and time values in the API (without changing the format).
• This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit change the limit value from 20 to the desired number.
• You can filter the logs by giving values of the following parameter in API endpoint
  • username - This parameter will filter the logs based on the provided username. Possible value is user id. To ignore this filter, you can either leave the possible value as blank or remove this parameter.
  • groupname - This parameter will filter the logs based on the provided group name. Possible value is user id. To ignore this filter, you can either leave the possible value as blank or remove this parameter.

/adeptia/api/manageServiceApi/AuditTrailLog?page=1&start=0&limit=20&advancesearch=fromdate=05-04-2019$fromtime=00:00$todate=05-04-2019$totime=23:59$username=shivani.tyagi@adeptia.com$groupname=Group_1

AS2 Logs

This API will fetch the AS2 trail logs of the day you are running the check.

This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit, change the limit value from 20 to the desired number.

/adeptia/api/logs/AS2?page=1&start=0&limit=20

AS2 Logs within a Date Range

This API will fetch AS2 logs for the given date range.

• You can change the date and time values in the API (without changing the format).
• This API has a page limit of 20, hence it would fetch only 20 records. However, if you want to increase the limit change the limit value from 20 to the desired number.
• You can filter the logs by giving values of the following parameter in API endpoint
  • archiveFlag - The possible values for this parameter can be true or false. If the value is set to true, then API will fetch AS2 logs from the archival database, If the value is set to false, API will only fetch the log data from the log database only.
  • as2status - This parameter filters the logs based on process flow execution status. Following are the possible values: Successful or Failed. You can use only one possible value for as2status at a time.

/adeptia/api/logs/AS2?page=1&start=0&limit=20&advancesearch=fromdate=05-04-2019$fromtime=00:00$todate=05-04-2019$totime=23:59$archiveFlag=false$as2status=