Login

Login returns a token which is used for all further calls.

Environment: Debug Development Production Sandbox Email: Password:

Login

Session Id:

Pathfinder API Documentation

Overview of the Optimo API

Pathfinder home page

Set up Partner login

Cases

Gets a list of cases. Paste the id for the selected case.

Get list of cases

Case Id:

Set the case

Scenarios

Gets a list of scenarios. Paste the guid for the selected scenario.

Get list of scenarios

Paste a "Guid" from the list of cases into ScenarioId below. This will then be used for all further API calls.

Scenario Id:

Test 1

Gets the assumptions part of the "Strategy summary" page

Get Assumptions report

Test 2

Gets the actual strategy part of the "Strategy summary" page. The returned JSON returns multiple strategies where each strategy has a path and a list of charts with name and path to the chart.

Get Summary report

Test 3

This will get the chart data for a strategy. Click the "Get Summary report" button first, then copy the Chart and its report path from the strategy node and paste into Chart and report path textboxes respectvely then click the "Get chart data" button.

Report Path:

Chart:

Get chart data

Test 4

This will get the data for all Action items.

Get action items

Test 5

This gets the complete hierarchical list of reports as shown on the left of the "Detailed reports" page. Each tree node has a Name field that is the name displayed in the tree and a Path field that can be used to get the data for that report.

Get report tree

Test 6

This gets the data for an individual table as displayed on the RHS of the "Detailed reports" page when a report is selected. After clicking the "Get report list" button above, copy the Path field from the report and past it into "Report path" below then click "Get report".

Report path:

Get report

Test 7

Pushes a new or existing case. Click the "Load sample case" button to load the JSON for a small sample case OR load the existing case by clicking the "Get existing case" button below. Set the "Case Id" to an existing case to update that case or leave it blank to create a new case. If a new case is submitted then "Case Id" will be set to the new case id.

Case Id:

Load sample case Push case

Test 8

Get the JSON for the current case. This can be then resubmitted as discussed above.

Get existing case

Get the YAML specification file. Note: a case must first be loaded via the "Cases" tab, "Set the case" button.

Get YAML specification

Test 9

Get list of all charts and tables.

Get list of reports

Test 10

Get data for all requested charts and tables. The list of reports from the previous Test 9 can be edited and used to request the data for all those OR the first button below will load a shorter sample list of charts and tables. This list can be edited.

Load sample list of reports Get data from list of charts and tables

Test 11

Get the strategy paper as a Word document.

Get strategy paper

Test 13

Pushes a new case. Click the "Load sample case" button to load the JSON for a small sample case OR load the existing case by clicking the "Get existing case" button below. In the returned JSON, "CaseId" will be set to the new case id.

Warning: after pushing a case the case cannot be opened from the API because it is saved internally as JSON. It has to be first opened in Pathfinder using "Edit case" which will then convert the JSON to a normal case. Note "View case" does NOT perform the conversion.

Load sample case Push case

This gets the case for a specific scenario guid as set on the Scenario tab.

Test 14

Get the JSON for the current case. This can be then resubmitted as discussed above.

Get existing case