AssignmentPro API enables the exchange of information between AssignmentPro and other systems using API. The API Event History screen can be used to view log of each API event in the system.
A detailed history of API requests will be recorded, and this screen can be used for tracking, troubleshooting, and resolving issues. This includes both requests, responses and errors. Navigate to the page using configuration search.
User's Security Rights
In order for a user to view the API Event History Screen, the user's security role must have appropriate security rights to the API Event History screen under the Secure Section Screen Rights.
This will only allow users to view the API Event Log grid but not the API Event History Details. To allow the user to view detailed information about API events, the user must be granted with the following rights:
Screen Section Rights granted rights to Integration Details.
The "Has All Assignment Rights" must also be enabled under the User Maintenance Screen in Security Maintenance.
Note, users who are missing one or both of the rights mentioned above will not be allowed to view any additional details about any of the API events beyond the basic information that’s presented in the grid, and will also not be permitted to filter the events by either the Request Body or the Response Body.
Search Filter
The API Event Log can be filtered using any combination of the provided fields including:
Request Http Method: A request HTTP method is designed to enable communication between servers. Examples include DELETE, GET, PATCH, POST.
Request URI Resource: The API endpoint which is the location where a request retrieves information from.
Response Status Code: Status codes are used to convey the results of a request. Examples include “200 OK”, “201 CREATED”, and “400 BAD REQUEST”.
API Subscriber: List of active API subscribers so users can filter by who made the request.
Request Body: Allows the user to do a search on the Request Body.
To filter by Request Body, a user needs the secure section Integration Details and have all the Assignment Rights checked under User Profile.
Valid Wildcards are the following:
% (percent): Zero or more characters in that position. To search for a literal percent sign character, use [%]
_ (underscore): Exactly one character in that position. To search for a literal underscore character use [_]
Status: Status can be used to filter by Success or Failure.
Date Range: Date Range can be used to filter by when the API request was made.
The API Event History screen will only load the most recent 1,000 records. This will work in combination with any filter criteria supplied by the user, for example if a specific API Subscriber is selected, then the top 1,000 records for that API Subscriber will be displayed. When sorting results, the sort will only apply to those 1,000 entries.
API Event Log
To view the request and response details related to your API event, click the status button and the API Event Details page will appear. Note, an event detail records are automatically purged if the request is older than 15 days.
Under API Event Details you can copy the full URL. You can also copy the formatted or unformatted Request/Response Headers and Request/Response Body.
If an error were to occur in an API event, the API Event Details will default to the Errors tab with the error message.
Things to Note
SCIM API is not available for API Event History currently
To learn how to view API documentation, you can navigate to this page: AssignmentPro API - How to access API technical documentation