ESM Data Load Rule Status API

Use the IsESMDataLoadLockedWithLogin SOAP API to check whether an ESM Data Load Rule (DLR) is currently locked. When the system executes a DLR, it places a lock to prevent simultaneous updates or multiple executions.

Note:

This API is only applicable to the ESM Data Load Rule.

This API lets you quickly verify if a specific DLR is locked due to an ongoing execution. It helps you manage execution workflows efficiently, avoid conflicts, and prevent redundant data load operations.

Call this API whenever you need to confirm the availability of a DLR before triggering a new execution.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:IsESMDataLoadLockedWithLogin>
             <ns:LoginName>********@planful.com</ns:LoginName>
                <ns:Password>********</ns:Password>
                  <ns:TenantCode>DPTenantHRMaster</ns:TenantCode>
           <ns:Rule>ESMDLRname</ns:Rule>
      </ns:IsESMDataLoadLockedWithLogin>
   </soapenv:Body>
</soapenv:Envelope>

Arguments List

Response

The API returns the status of the specified ESM Data Load Rule, along with a success flag and a descriptive message.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <soap:Body>
 <IsESMDataLoadLockedWithLoginResponse xmlns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
         <IsESMDataLoadLockedWithLoginResult>
            <Success>true</Success>
            <message>Unlocked</message>
         </IsESMDataLoadLockedWithLoginResult>
      </IsESMDataLoadLockedWithLoginResponse>
   </soap:Body>
</soap:Envelope>

Response Elements