Retrieving Pending Operations From SAP Mobile Server

General Rules

Authentication – the same set of rules used for accessing SAP Mobile Server REST APIs also apply to pending operation access. See these topics in the Developer Guide: REST API Applications:
- Authentication
- HTTP Headers and Cookies
Authorization – to access the HTTP services, the user requires the "SUP DCN User" role, and this DCN user is only authorized to access packages that are associated with the security configuration against which the user is authenticated. Anonymous access is not allowed.
Headers – use X-SUP-DOMAIN and X-SUP-SC to override the domain derived from the URL and the default security configuration of the domain. See HTTP Headers and Cookies in the Developer Guide: REST API Applications.
Response code –
- If any request parameter format is invalid, SAP Mobile Server responds with 400 Bad Request.
- If any request parameter value (domain, package) is not found in the system, SAP Mobile Server responds with 404 Not Found.
- If a request is unauthorized, SAP Mobile Server responds with 401 Unauthorized.
- If any other failures are encountered when processing the request, SAP Mobile Server responds with 500 Internal Error.

Querying Pending Operations

The HTTP client can query the list of PendingOperations by making a GET request to this URL:

http://domain:port/end2end.rdb:1.0/PendingOperations?username=test&amp;
remoteId=cc134c3a-1e7b-41cf-821c-900ec61eef91&amp;$skip=0&amp;$top=10

All parameters are optional. If username and remoteId are not provided, SAP Mobile Server returns all pending operations for the package. Successful invocation generates get response 200 OK with the entity set in JSON format in the response body:

[ 
{"data":"{\"id\":1,\"lname\":\"lname2\",\"fname\":\"fname1\",\"id1\":3520011}",
"entityName":"topicCustomer","operation":"ChangeNameNeedManager","requestId":3520012,
"remoteId":"582b509f-677e-4879-b1fb-d2e0f11d9deb","username":"test"}, 
{"data":"{\"id\":2,\"lname\":\"lname4\",\"fname\":\"fname3\",\"id1\":3520013}",
"entityName":"topicCustomer","operation":"ChangeNameNeedManager","requestId":3520014,
"remoteId":"582b509f-677e-4879-b1fb-d2e0f11d9deb","username":"test"} 
]

Updating Pending Operations

The HTTP client can update a list of PendingOperations by making a PUT request to this URL:

http://domain:port/end2end.rdb:1.0/UpdatePendingOperations

with this put string:

{"data":[
   {
   "remoteId":"13ac059a-ad00-47e2-b85e-f659c6865651",
   "results":[
      {"lid":900,"hid":909,"success":false,"errorMessage":"They must all fail!","eisCode":"14"}, 
      {"lid":910,"hid":1000,"success":true}, 
      {"lid":1001,"success":false,"errorMessage":"It must fail!","eisCode":"1234"},
      {"lid":1002,"hid":1010,"success":false,"errorMessage":"They must all fail too!","eisCode":"5678"}
   ]
   },
{
   "remoteId":"25ac059a-bc00-4ag2-bc5e-f659c6234887",
   "results":[
      {"lid":2000,"success":true}, 
      {"lid":2001,"success":false,"errorMessage":"It must fail!","eisCode":"1234"},
      {"lid":2002,"hid":2100,"success":true},
      {"lid":2101,"success":false,"errorMessage":"It must fail!","eisCode":"1234"}
   ]
   }
]}

The above example request contains two sub-requests. Each sub-request is required to specify a “remoteId” attribute. This remoteId is the same remoteId SAP Mobile Server uses to notify the EIS of the operation uploads. It identifies the device that submitted all the operations listed in the “results” attribute. Upon completion of operation updates, SAP Mobile Server sends a notification to the device identified by the “remoteId”. The “results” attribute can contain a list of single operation, or range of operations. If “lid” and “hid” are both specified (hid >= lid), all operations with requestId value between “lid” and “hid” (inclusive) are updated. If only “lid” is specified, only one operation is updated. The values of “lid” and “hid” should be the values of the “requestId” in the PendingOperations query results. The range of values between “lid” and “hid” might not be continuous within the scope of one remoteId.

Note: Overlapping ranges in a request are not supported.

The following interface has been deprecated beginning with SAP Mobile Platform version 2.3 SP03. Continuing to use this deprecated interface may result in poor performance:

{"data":[ 
{"success":false,"requestId":13930007,"errorMessage":"It must fail!","eisCode":"1234"},
{"success":false,"requestId":13930009,"errorMessage":"It must fail!","eisCode":"1234"}, 
{"success":true,"requestId":13930008}]}