Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

getCaseEditLock(caseID, context)

Updated on July 20, 2021

Locks a case so that it can be edited.


A promise that when resolved indicates that acquiring the lock of the case is successful.


caseIDstringThe ID of the case that must be locked.
contextstringThe name of the context where the API is being called.

Usage example

In this example, the API obtains a successful lock on the case so that it can be edited.

const context = 'app/primary_1';

PCore.getDataApiUtils().getCaseEditLock(caseID, context)
.then(response => {
   //The response of this API is as shown below:
     uiResources: {
       resources: {},
       components: [],
       root: {}
     data: {
       caseInfo: {
         ID: // case ID,
         content: {}
   //Having the above structure in the response indicates that the lock has been acquired successfully.
.catch(error => {

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us