This endpoint enables a workspace administrator to download the Anaplan Optimizer log. This is useful for root cause analysis when an error occurs.

To use this endpoint, you must supply a valid authentication, the Optimizer action ID (see List model actions), and the correlation ID, obtained from the Anaplan UI.

Note:

  • Anaplan Optimizer logs are automatically removed 48 hours after the last access.
  • You must have Workspace Administrator permissions in the model.

Group Download Files for Actions

View the following endpoints for further details on download files for actions APIs:

You can download files that were uploaded or download files after carrying out an export.

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/optimizeActions/{actionId}/tasks/{correlationId}/solutionLogs

Parameters

ParameterDescription
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
modelId
  • Required
  • Type: string
  • Description: The model ID
  • Example: FC12345678912343455667
actionId
  • Required
  • Type: string
  • Description: The Optimizer action's ID, obtained from List model actions.
  • Example:117000000002
correlationId
  • Required
  • Type: string
  • Description: The Optimizer log's correlation ID, obtained from the Anaplan UI, after running an Optimizer action.
  • Example:C73885D890BC44BD8000A910A5CFF3C2

Curl Example

curl -X GET \
https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/optimizeActions/{actionId}/tasks/{correlationId}/solutionLogs \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'
-H 'Accept:text/plain'

Response

Response 200

Optimize a model with 4 rows, 4 columns and 16 nonzeros
Model fingerprint: 0x331b37fc
Variable types: 0 continuous, 4 integer (0 binary)
Coefficient statistics:
Matrix range     [3e+00, 3e+02]
Objective range  [2e+01, 3e+02]
Bounds range     [7e+00, 7e+00]
RHS range        [7e+02, 7e+02]
Found heuristic solution: objective 2394.0000000
Presolve time: 0.00s
Presolved: 4 rows, 4 columns, 16 nonzeros
Variable types: 0 continuous, 4 integer (0 binary)
Found heuristic solution: objective 2208.0000000

Root relaxation: objective 1.398644e+03, 3 iterations, 0.00 seconds (0.00 work units)

   Nodes    |    Current Node    |     Objective Bounds      |         Work   
Expl Unexpl |  Obj  Depth IntInf | Incumbent    BestBd   Gap | It/Node Time

  0     0 1398.64424    0    3 2208.00000 1398.64424  36.7%     -    0s
  H    0     0                    1820.0000000 1398.64424  23.2%     -    0s

Explored 1 nodes (3 simplex iterations) in 0.01 seconds (0.00 work units)

Solution count 3: 1820 2208 2394

Optimal solution found (tolerance 1.00e-04)
Best objective 1.820000000000e+03, best bound 1.820000000000e+03, gap 0.0000%

User-callback calls 152, time in user-callback 0.00 sec