Skip to main content

 –

Retrieving the model update status

Suggest edit Updated on January 19, 2022

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

For example:

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}
For example:

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}
For example:

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

NameTypeDescription
ModelUpdateStatusStringThe status of the model update.
LastMessageStringThe last status in the model update process before the current status was reached.
UpdateTimeStampStringThe date and time of the last status change.
BranchNameStringThe branch in Pega Platformthat contains the status update.
BranchAvailableBoolean (True, False)True indicates that a branch exists. False indicates that a branch has not been created yet or was deleted.
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us