API workflows

Many of the Maximo® PQI SaaS Visual Insights API calls have prerequisites, or correlations with other API calls. Also, only certain user roles are given access to each API call. Therefore, it is important to understand the API workflow for each role.

Model manager

The model manager generally uses the API calls in the following sequence:
  • Create a data group. Refer to Create a data group in Data group services.
  • Upload a data file to a data group. Refer to Upload data files to a data group in Data file services.
  • Create a model. Refer to Create a model in Model services.
  • Create a model instance. Refer to Create a model instance in Model instance services.
  • Train the model. Refer to Train model instance. The training process takes several minutes to hours depending on the number of images and the training parameters. To check the status of the model instance, refer to Get one model instance.
  • After the online training is completed, the model manager can validate the model. Refer to Validate model instance.
  • Create an edge. Refer to Create edge in Edge services.
  • Deploy the model to the edge or reject the model. Refer to Deploy model instance or Reject model instance in Model instance action services.
  • Retrain or undeploy the deployed model. Refer to Retrain model instance or Undeploy model instance in Model instance action services.

Inspector

The inspector generally uses the API calls in the following sequence:
  • Score an image. Refer to Score an image in Score service.
  • Get the inspection result cell overview. Refer to Get the inspection result cell overview in Inspection result services.
  • Get the inspection result list. Refer to Get the inspection result list in Inspection result services.
  • Confirm inspection results. Refer to Confirm inspection results in Inspection result services.

Supervisor

The supervisor generally uses the API calls in the following sequence:
  • Score an image. Refer to Score image in Score service.
  • Get the inspection result cell overview. Refer to Get the inspection result cell overview in Inspection result services.
  • Get the inspection result list. Refer to Get the inspection result list in Inspection result services.
  • Confirm inspection results. Refer to Confirm inspection results in Inspection result services.
  • Get defect image rate file. Refer to Get defect image rate file in QEWS integration service.

Stand-alone edge administrator

The stand-alone edge administrator must have credentials for the stand-alone edge machine. The stand-alone edge administrator generally uses the API calls in the following sequence:
  • Get available models. Refer to Get available models in Stand-alone edge services.
  • Deploy a model. Refer to Deploy a model in Stand-alone edge services.
  • Deploy all models. Refer to Deploy all models in Stand-alone edge services.
  • Upload and score an image on the edge. Refer to Upload and score image on the edge in Stand-alone edge services. The production line or external services typically use this API.
  • Sync the inspection result from the edge to the center application. Refer to Sync inspection result from the edge to the center application in Stand-alone edge services.
  • Clean up the inspection result that you have synced to the center application. Refer to Clean up inspection result that you have synced to the center application in Stand-alone edge services.
  • Undeploy a model. Refer to Undeploy a model in Stand-alone edge services.