Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

View Exact Data Sent to the Device

You can use the same API URL which is used by the mobile devices to see what data will be sent to the phone or web application during a sync.

View Restore Data for Any Mobile User in HQ

View All Data Associated with a User:

http://www.commcarehq.org/a/{my-project-space}/phone/restore/?as={user}@{my-project-space}.commcarehq.org&version=2.0

App Specific:

http://www.commcarehq.org/a/{my-project-space}/phone/restore/{app_id}/?as={user}@{my-project-space}.commcarehq.org&version=2.0 (assumes current state of the app, not particular build)

Build Specific:

http://www.commcarehq.org/a/{my-project-space}/phone/restore/{build_id}/?as={user}@{my-project-space}.commcarehq.org&version=2.0

Additional Parameters

since={previous restore id}

Incremental response since the previous sync.

items=true

Include the item number in the response.

overwrite_cache=true

Don't return a cached value but rather recompute the response. Deletes the cache, so the next time you sync on the phone, it will use the newly computed result.

raw=true

Raw restore response without the UI.

device_id={device_id}

Fake a restore from a particular device id. WebApps uses a device ID of the form "WebAppsLogin".

app_id={app_id}

Restore using app aware sync. This will only sync down the reports for that particular application.

case_sync={clean_owners | livequery}

Select which case sync algorithm to use with this restore

hide_xml=true

Shows only aggregate case counts, without loading associated XML data

fail_hard=true

Useful to debug issues where restore has missing or unexpected data. Instead of swallowing up UCR fixture errors during a restore, this forces a 500 error which a dev can investigate to find the root cause.