Skip to main content

OptimizationStatusResponse

Status of an optimization job, without iterations or partial data.

jobIdstringrequired

Identifier of the job. Opaque: it is the {jobId} of this operation.

statusstringrequired

Current status of the job. SUCCEEDED, FAILED, CANCELLED and EXPIRED are terminal; the status can also go back from RUNNING to QUEUED. Always act on the latest value you read.

Enum ValueDescription
QUEUEDAccepted and waiting for a free execution slot.
RUNNINGThe engine is calculating.
SUCCEEDEDFinished with at least one plan: read it with the result operation.
FAILEDFinished without a result: the result operation returns the reason.
CANCELLEDCancelled outside this API.
EXPIREDSucceeded, but its result was deleted after the retention period.

Possible values: [QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELLED, EXPIRED]

createdAtstring<date-time>required

When the job was accepted, in UTC.

finishedAtstring<date-time>

When the job finished, in UTC (for EXPIRED, when it succeeded). Present only in terminal statuses.

retryAfterSecondsinteger<int32>

Minimum seconds to wait before polling again. It is a fixed recommendation (currently 30), not an estimate of the remaining time. Present only while the job is QUEUED or RUNNING.

OptimizationStatusResponse
{
"jobId": "string",
"status": "QUEUED",
"createdAt": "2024-07-29T15:51:28.071Z",
"finishedAt": "2024-07-29T15:51:28.071Z",
"retryAfterSeconds": 0
}