Functions

Before using the functions on this page, you may find it useful to review the following information:

Each page linked below describes one or more of the functions in the Pathfinder API. Examples are given to demonstrate how the API functions can be called. The examples use JavaScript, though of course any general-purpose language can be used.

The API provides functions in the following groups.

Function Group	Description of this function	List of functions
Cases	Get a list of cases for the current login as JSON Open a specific case	`/service/getCases` `/service/setCase`
Scenarios	Get a list of scenarios within the current case as JSON	`/service/getScenarios`
Legacy Input API	This function has been replaced by the newer Input API function. However, this documentation is provided for partners who are still using this version.	`/service/pushLegacyCase` `/service/getLegacyCase`
Strategy summary	Get the Assumptions report as JSON Get the Summary report as JSON. Get the chart data for any specific chart within the Summary report Get the data for all Action items	`/service/getAssumptionsReport` `/service/getSummaryReports` `/service/getChartRawData` `/service/getActionItems`
Output API function	Get a list of all charts and tables. Note this list is not case or scenario dependent and some of these may not be present in an actual case. Get all the data for a specific list of tables and charts. Get a strategy paper. This is a Word document with text and charts using a specific Word template.	`/service/getReportList` `/service/getDataFromReportList` `/service/getStrategyPaper`
Input API function	Push a new or existing base case Get a base case	`/service/pushCase` `/service/getBaseCase` `/service/getYaml`
Login	Ability to log in with an account (email address and password)	`/service/login`
Detailed reports	Get the Detailed report list Get the data for any report listed in the Detailed reports	`/service/getReportTree` `/service/getReport`