|
<< Click to Display Table of Contents >> Navigation: Optimizer API > Get Progress |
Query the BlackBox to discover the current status of the optimzation call you submitted at some earlier time.
This call should be made before attempting to retrieve the optimization results, so that you can check and confirm that the job has completed. The call should be throttled by the client to no more than 1 check per second per optimization call you have outstanding.
The response contains the status of the job and also some detailed progress information so that it is possible to present some reassuring feedback to the user if required. This includes an incremental container and product count, processing time and an approximate completion time.
HTTP request
GET opt/v1/progress/{job-id}
Authentication: BASIC
Parameters: None
Response:
{
"jobid":"00001348-00000001-127.0.0.1-10101",
"age":"44",
"status":"Completed",
"position":"0",
"averagetime":"00:00:00",
"containercnt":"1",
"containerix":"1",
"curiter":"30",
"maxiter":"30",
"realsec":"1",
"maxsec":"1",
"numloaded":"42",
"bestvolumeperc":"87.2424",
"bestweightperc":"74.8746"
}
Property |
Description |
jobid |
copy of the input job id |
age |
time in seconds since this job was accepted by the BlackBox |
status |
current status of this job. One of Queued, In Progress, Completed, Not Found or Interrupted |
position |
if the job is queued due to prior jobs still being processed, this is the position in the queue before the job will begin. Counts down to zero |
averagetime |
expected time to completion for this job. This value is approximate, being based on data from previous jobs |
containercnt |
number of containers in the loading result |
containerix |
current index of the container |
curiter |
current number of iterations performed by the processing loop of the optimizer |
maxiter |
total number of iterations the processing loop will perform |
realsec |
number of seconds that the optimizer has spent loading the current container at this point |
maxsec |
total number of seconds the optimizer may spend |
numloaded |
number of items l(aka products or SKUs) oaded so far |
bestvolumeperc |
percentage of the container volume that has been filled |
bestweightperc |
percentage of the container's maximum weight capacity that has been fiilled |