Solve parameters

To control solve behavior, you can specify solve parameters in you request as named value pairs.

For example:
"solve_parameters" : {
This will allow you to collect the engine log tail during the solve and the whole engine log as output at the end of the solve.

You can use these parameters in your request.

Name Type Description
oaas.timeLimit Number You can use this parameter to set a time limit in milliseconds.
oaas.resultsFormat Enum
  • JSON
  • XML
  • TEXT
  • XLSX
Specifies the format for returned results. JSON is the default format. Other formats might or might not be supported by each application type.
oaas.oplRunConfig String Specifies the name of the OPL run configuration to be executed.
oaas.logTailEnabled Boolean Allows you to include the log tail in the solve status.
oaas.logAttachmentName String If defined, this allows you to attach engine logs as a job output attachment.
oaas.engineLogLevel Enum
  • OFF
  • INFO
  • FINE
You can use this to define the level of detail provided by engine log. The default value is INFO.
oaas.logLimit Number Maximum log-size limit in number of characters.
oaas.dumpZipName Can be viewed as Boolean (see Description) If defined, a job dump (inputs and outputs) zip file is provided with this name as a job output attachment. Name can contain placeholder ${job_id}. If defined with no value, dump_${job_id}.zip attachmentName is used. If not defined, by default, no job dump zip file is attached.
oaas.dumpZipRules String If defined this generates a zip file according to specific job rules (RFC 1960-based Filter). It must be used in conjunction with the {@link DUMP_ZIP_NAME} parameter. Filters can be defined on the duration and the following {@link} properties:
  • duration
  • solveState.executionStatus
  • solveState.interruptionStatus
  • solveState.solveStatus
  • solveState.failureInfo.type
 or (&(duration<1000)(!(solveState.solveStatus=OPTIMAL_SOLUTION)))
 or (|(solveState.interruptionStatus=OUT_OF_MEMORY)
 or (&(duration<1000)(!(solveState.solveStatus=OPTIMAL_SOLUTION)))
 or (|(solveState.interruptionStatus=OUT_OF_MEMORY)