Retrieving the model update status
Use this endpoint to load the status of a model update that was started by using Machine Learning Operations (MLOps).
GET /predictions/model_update/{referenceID}/status
- Method
GET
- Endpoint
/predictions/model_update/{referenceID}/status
- Sample URL
- http://IP:PORT/prweb/api/application/v2/predictions/model_update/M-5104/status
{referenceID} is an identifier of a model update that you want to approve or reject, for example, M-5104. A request that starts a model update returns this reference ID. For more information, see Starting a model update.
Response
The following example shows a response when the model configuration is in progress:
{
"ModelUpdateStatus":"Configuration in progress",
"LastMessage":"Model update case M-6028 created. Preparing for
artifacts creation.",
"UpdateTimeStamp":"December 30, 2020 01:44 EST",
"BranchName":"M-5104",
"BranchAvailable":false
}
The following example shows a response when the model configuration failed:
{
"ModelUpdateStatus":"Configuration failed",
"LastMessage":"Unable to find the model to update.Specify the
component name of the model to be updated in the request.",
"UpdateTimeStamp":"January 13, 2021 07:49 EST",
"BranchName":"M-5104",
"BranchAvailable":false
}
The following example shows a response when the model is ready for review:
{
"ModelUpdateStatus":"Ready for review",
"LastMessage":"Awaiting approval",
"UpdateTimeStamp":"December 29, 2020 02:18 EST",
"BranchName":"M-5104",
"BranchAvailable":true
}
Response parameters
Name | Type | Description |
ModelUpdateStatus | String | The status of the model update. |
LastMessage | String | The last status in the model update process before the current status was reached. |
UpdateTimeStamp | String | The date and time of the last status change. |
BranchName | String | The branch in Pega Platformthat contains the status update. |
BranchAvailable | Boolean (True, False) | True indicates that a branch exists. False indicates that a branch has not been created yet or was deleted. |
Previous topic Reviewing a model update Next topic Accessing and testing V2 Prediction API