Tenant API Request

1. Tenant API Request Introduction

The Tenant API Request section offers a centralized view of all API communications initiated by the system for a specific tenant.  It serves as a centralized dashboard to track, monitor, and troubleshoot API calls made under a specific tenant account.

Each request logged here includes critical information such as the type of API invoked when it was triggered, its execution status, and the outcome of the response. 

Business Central (BC) communicates with Accelera through API calls. Every time BC performs an operation that needs Accelera’s input—such as downloading sales orders, sending payments, or acknowledging data—BC triggers an API request to Accelera.

Each of those API requests is captured and logged in this interface: the Tenant API Requests List.

This list acts as a tracking dashboard, showing the entire history of interactions from BC to Accelera. It includes critical details like:

• The API name (which operation was called)

• The timestamp (when it happened)

• The status (whether the operation succeeded or failed)

• And a reference to the full details of the request and response

This logging ensures transparency, helps with troubleshooting, and provides a clear audit trail of system activity.

This document provides an internal overview of the Tenant API Requests List interface. 

• Go to Administration
• Click on Admin Settings
• Click on Tenant API Request under Admin Settings Action

• Pagination Controls: Pagination controls appear at the top right of the request list and allow users to navigate through multiple pages of API request records. The display shows the current page number, total number of pages, and options to go to the first or last page, or move forward or backward through the list. The field “25 per page” is a dropdown that determines how many entries are displayed on a single page. These controls are critical for managing performance and usability when handling thousands of records, as seen in the count (e.g., 9,125 total requests). They prevent excessive scrolling and ensure a manageable view of data.
• Refresh: The Refresh button ensures the list reflects the latest data by reloading the current view with the most recent API requests. 

2. Tenant API Request List Overview:

• API: This line shows the name of the action performed. It describes the nature of the request made by Business Central to Accelera, such as actions related to downloading, acknowledging, or updating data. It helps users identify the purpose of the request quickly, which is useful when scanning through multiple requests to find a specific type of activity.

• UUID: The UUID (Universally Unique Identifier) displayed under each API entry serves as a system-generated reference for that specific request. The system uses this field internally to store and retrieve detailed logs associated with the request. 
• Created On (CDT): This field shows the date and time when the API request was created or submitted, and the timestamp is displayed in Central Daylight Time (CDT). It helps users understand when a specific operation was triggered within the system. This is critical for tracking changes, correlating events, or investigating issues tied to specific timeframes. 
• Execution Status: Execution Status reflects the current state of the API request processing on the server side. The status "Done" means that the API has completed its execution process, regardless of whether the outcome was successful or failed. This field indicates whether the processing has finished, is in progress, or was interrupted. 
• Response Status: This field indicates the outcome of the API operation after it has been executed, showing whether it was completed successfully or encountered an error. A "Success" label indicates that the system returned the expected response without issues. This information is especially important for users who must verify that operations such as data uploads, downloads, or updates were carried out correctly. 

• Filter Section: The Filter section provides a dropdown menu that helps users narrow down API requests based on specific criteria. Users can select filters such as API name, date range, execution status, or response outcome. Once a filter is chosen, the display updates to show only the relevant API requests, making it easier to analyze and debug data.
• API: This option allows users to filter requests based on the triggered API name. It helps isolate specific API activity from the list for easier tracking and analysis.
• Created On: This filter lets users view API calls on a specific date. It is useful for reviewing request activity within a selected time frame.
• Execution Status: This option filters requests based on whether the API execution is marked as done or still in progress. 

  Execution Status:

  • Pending: The API request has been received but has not started execution yet. This status is useful for identifying queued requests.

  • In Progress: The API request is currently being processed. It indicates that the operation is underway but not yet completed.

  • Done: The API request has completed its execution, which confirms that the process has reached an endpoint.

• Response Status: This filter allows users to sort API calls by their final results, such as Success or Failure. It is useful for identifying issues or confirming successful transactions.

  Response Status:

  • Success: The API request was successful and worked as expected. There were no issues, which means the transaction was fully successful.

  • Failure: The API request could not be completed due to an error or issue. This status is important for tracking problems that may need resolution.

  • Partial: The API request was partially successful, meaning some operations succeeded while others may have failed or were incomplete. This helps identify cases that require closer review.

• Click on View Details

• This screen displays the complete log of a specific API call that was initiated from Business Central to Accelera. It captures essential metadata along with both the request and response content, enabling transparency and traceability of communication between systems. Each section of this screen serves a different operational or audit purpose.
• UUID: This is a reference code used by the system to keep track of each request.
• Created On: This shows the exact date and time the request was made. It helps confirm whether data was sent at the right moment.
• Execution Status: This shows if the system has finished handling the request. 

• Request Data: This section shows the actual payload sent from Business Central to Accelera. This instance includes a list of order numbers that are being acknowledged. This field is essential for verifying the communicated data, allowing users to confirm that the correct business documents were referenced in the API call.

• Response Data: This section shows the response from Accelera after processing the request. It indicates a "success" status, which means the request was handled correctly. This response confirms that the operation was received and completed. It ensures clear visibility throughout the transaction process.