{ "opencollection": "1.0.0", "info": { "name": "Helpcenter Locking Information S API", "version": "1.0.0" }, "items": [ { "info": { "name": "Locking Information S", "type": "folder" }, "items": [ { "info": { "name": "To retrieve the locking information details of locked records", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:moduleName/:recordId/Locking_Information__s", "params": [ { "name": "moduleName", "value": "", "type": "path", "description": "The API name of the module to which the locked record belongs." }, { "name": "recordId", "value": "", "type": "path", "description": "The ID of the record from which the lock is to be removed." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of field API names to be included in the response." } ] }, "docs": "Use the Get Record Locking Information API to retrieve the locking information details of locked records in different modules." }, { "info": { "name": "To lock a record of a module", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:moduleName/:recordId/Locking_Information__s", "params": [ { "name": "recordId", "value": "", "type": "path", "description": "The ID of the record from which the lock is to be removed." }, { "name": "moduleName", "value": "", "type": "path", "description": "The API name of the module to which the locked record belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use the Lock Record API to lock records in different modules." }, { "info": { "name": "To update the locking reason of a locked record", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:moduleName/:recordId/Locking_Information__s/:lockId", "params": [ { "name": "moduleName", "value": "", "type": "path", "description": "The API name of the module to which the record belongs." }, { "name": "recordId", "value": "", "type": "path", "description": "The unique identifier of the record whose locking reason needs to be updated." }, { "name": "lockId", "value": "", "type": "path", "description": "The ID of the lock to be removed from the locked record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use the Update Record Locking Infromation API to modify locking information of locked records in different modules." }, { "info": { "name": "Remove Lock from Locked Records", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:moduleName/:recordId/Locking_Information__s/:lockId", "params": [ { "name": "moduleName", "value": "", "type": "path", "description": "The API name of the module to which the locked record belongs." }, { "name": "recordId", "value": "", "type": "path", "description": "The ID of the locked record from which the lock is to be removed." }, { "name": "lockId", "value": "", "type": "path", "description": "The ID of the lock to be removed from the locked record." } ] }, "docs": "Use the Remove Lock from Locked Records API to remove locks from locked records in different modules." } ] } ], "bundled": true }