<< Click to Display Table of Contents >> Navigation: Optimizer API > Get Images |
Fetch the load diagrams after the optimization is complete. It is important that this call is made only after the job in question has a status of "completed" (see Get Progress).
HTTP requests:
Return all images related to this optimization:
GET opt/v1/images/{job-id}
Return only the container indicated:
GET opt/v1/images/{job-id}/{containerindex}
Authentication: BASIC
Parameters:
Name |
Location |
Type |
Description |
jobid |
URL |
string |
Unique id of the job for which you want the diagram(s) |
container index |
URL |
string |
(optional) index of the loaded container you wish to see. Container index starts at 001 and counts up to to the total number of loaded containers |
Response:
This method will return an encoded ZIP file containing one or more image files. Depending upon your BlackBox configuration this may may contain one or more of JPG, PNG, and/or PDF documents.
Please contact MagicLogic for examples.