Configuring the Request
The id will be used as the display name of the job and to look up the job details in the app interface.
The Compute Interface will accept LP, MIP, and NLP jobs and will default to solving the problem as provided unless the problemType is used to force the solver to interpret the problem differently.
Simple Request Configuration for Solver Job
{
"id": "my-unique-reference",
"computeJobType": "SOLVER",
"solver":
{
"resultsToInclude": ["SOLUTION"],
"controls":
{
"XPRS_MAXTIME": -1800
}
}
}
| Field | Permitted Values Default shown in italics |
Notes |
| id | Job Id | Required Must be <=60 characters [A-Za-z0-9_-.] Must be unique in the current state of the system |
| computeJobType | SOLVER | Required |
| dependency | NULL | See section on Using Dependencies |
| runlogMessages | false true |
Enables run log events via Progress Events API |
| execution | { "executionService": "value" "threads": null or value } |
Optional executionService must exist, otherwise the request will be rejected with a 422 request response. threads must either be null or between 1 and 256 otherwise the request will be rejected with a 422 request response.
Note The
threads attribute takes precedence over the
XPRS_THREADS control if present.
|
| solver > action | OPTIMIZE IIS |
|
| solver > problemType | null LP MIP |
null == solver decides based on problem characteristics |
| solver > flags | None DUAL PRIMAL BARRIER NETWORK |
null == solver defaults (typically concurrent lp) |
| solver > controls | null { "control": "value" } |
Object map of controls to values.
Control names must be prefixed. For example,
|
| solver > resultsToInclude | null SOLUTION ATTRIBUTES BASIS SAVE IIS |
Array of string values IIS result file is only available when action=IIS SOLUTION file is only available when action=OPTIMIZE or NULL |
| solver > callbacks | null BARLOG CUTLOG GLOBALLOG LPLOG GAPNOTIFY INTSOL |
Array of string values CALLBACKS require integration with the Progress Events API. |
Simple Request Configuration for Mosel Job
{
"id": "myId",
"computeJobType": "MOSEL",
"dependency": "my attachment.zip",
"runLogMessages": true,
"execution": {
"executionService":"SECONDARY",
"threads": 2,
},
"mosel": {
"parameters": {
"param1": "value1"
},
}
}
All Configuration Properties for a Mosel Job
| Field | Permitted Values Default shown in italics |
Notes |
| id | Job Id | Required Must be <=60 characters [A-Za-z0-9_-.] Must be unique in the current state of the system |
| computeJobType | MOSEL | Required |
| dependency | null | See section on Using Dependencies |
| runlogMessages | false true |
Enables run log events via Progress Events API |
| execution | { "executionService": "value" "threads": null or value } |
Optional executionService must exist, otherwise the request will be rejected with a 422 request response. threads must either be null or between 1 and 256 otherwise the request will be rejected with a 422 request response. |
| mosel > parameters | none { "param1": "value1" } |
Object map of model parameter name to string value |