Have you ever wanted to try out the Archer API, but didn't know where to get started or never wrote a line of code? Check out the Archer API Templates application...just another tool in the Archer Toolbox.
For beginners and those that are just curious, the application provides a point-and-click interface to quickly and easily test the Archer Web Services API, REST API, and Content API. The list of predefined API calls are based on the Archer API Guides and Online Documentation. Check out the RSA Archer Platform documentation and RSA Archer Suite for more details on your specific Archer version.
The attached .zip file is an Archer package consisting of a solution, workspace, and the Archer API Templates application. The application:
- shows custom messages including a countdown clock
- finds a field based on field id
- saves your favorite API calls as a content record
- requires Archer 6.2 P1 or higher
The REST API Console is a custom object that allows a user to select from a list of predefined calls or enter a URL. After selecting an option from list, the Input pane will display a sample JSON body. Simply replace the required values, select the VERB option, and click the Run button. The REST API calls use the current user's session, so a separate API user account is not required. Click the Export button to view the results in an HTML table for saving to PDF, printing or to copy/paste into Excel. Enable the Sort checkbox to sort the columns alphabetically when exporting to HTML table except for common fields like Id, Guid, Name, Alias, etc...more images below.
The Web Services API Console is another custom object that allows a user to select from a list of predefined calls. After selecting an option, the Input pane will display a sample SOAP message. Simply replace the required values and click the Run button. If an option is selected from list, the session token will be replaced automatically in the SOAP message. Click the Load button to display a generic SOAP envelope that is ready for a method to be inserted...more images below.
The Content API Console is a custom object added in v2.0 allowing a user to select from list of calls and testing their own. It can get record content data as well as save/update records. Click the Export button to view the results in an HTML table for saving to PDF, printing or to copy/paste into Excel. Enable the Sort checkbox to sort the columns alphabetically when exporting to HTML table except for common fields like Id, Guid, Name, Alias, etc...more images below.
In the Tools and Functions section, the Lookup Field Id is a custom object that uses the REST API to find a field. If found, it displays the Field Name, Alias, Level Id, Level Name, Module Id, and Module Name. This helps investigate calculation errors found in the Archer JobFramework log files like the following:
For developers, it demonstrates how to "chain" multiple API calls synchronously.
Another tool added in v2.0 is the Bulk User Management custom object. It will read a CSV file and take an action like Create Users or Update Account Status to active/inactive/locked/delete. This custom object demonstrates how to perform API calls in bulk and automate common processes. Click the Download Template button to get a sample CSV file for the selected action. Testing has shown the CSV file works well up to 5,000 rows, but it's recommended to start small and scale up. Includes error handling for multiple data conditions too.
Add some flair and pizzazz with the Alerts and Messages custom object to display custom messages at the top of sections, above/below the toolbar, and allow users to close the message.
The Countdown Clock custom object displays important information with a countdown timer.
These can inform users of scheduled outages, provide a link for users to get more information, or display any other messages.
Lists of predefined calls for REST, Web Services and Content API
REST API call to get basic field details for an application and use ODATA to select subset of details and sort by Name
REST API results (array of objects) exported to HTML table
REST API result (single object) exported to HTML table in name/value format
Web Services API call to get all groups
Content API call getting a specific Policies content record
Application Layout showing Custom Objects
NOTE: This is not an RSA supported product. It is intended as a proof of concept and for use in non-prod environments. Archer Support or Engineering teams will not be able to customize or enhance it. Use at your own risk!
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.