Managing and Upload Offline Stores¶
GET Offline Store Upload¶
HTTP Method: GET
Service Document for GET Offline Store Upload¶
URL: https://<mobile services host>/mobileservices/application/{application}/offlinestoreupload/v1/admin/
Response Status and Error Codes¶
| Code | Description |
|---|---|
| 200 | Service document. |
| 500 | Unexpected error |
Metadata Document¶
URL: https://<mobile services host>/mobileservices/application/{application}/offlinestoreupload/v1/admin/$metadata
Response Status and Error Codes for GET Offline Store Upload¶
| Code | Description |
|---|---|
| 200 | Metadata document. |
| 500 | Unexpected error |
Entity Set PolicySet¶
This method allows you to get the entities from the entity set PolicySet.
URL: https://<mobile services host>/mobileservices/application/{application}/offlinestoreupload/v1/admin/PolicySet
Response Status and Error Codes for GET Entity Set PolicySet¶
| Code | Description |
|---|---|
| 200 | Entity set PolicySet |
| 404 | Not found. |
| 500 | Unexpected error |
PolicySet by Key¶
This method allows you to get the entity from PolicySet by key, and it returns the entity with the key from the
PolicySet.
URL: https://<mobile services host>/Admin/offlinestoreupload/PolicySet('{applicationId}')
Request Parameters for PolicySet by Key¶
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
applicationId |
Required | key: applicationId | String |
Response Status and Error Codes for PolicySet by Key¶
| Code | Description |
|---|---|
| 200 | Entity set PolicySet. |
| 404 | Not found. |
| 500 | Unexpected error. |
Entity Set OfflineStoreSet¶
This method allows you to get the entities from the entity set OfflineStoreSet.
URL: https://<mobile services host>/Admin/offlinestoreupload/OfflineStoreSet
Response Status and Error Codes for Entity Set OfflineStoreSet¶
| Code | Description |
|---|---|
| 200 | Entity set PolicySet. |
| 500 | Unexpected error. |
OfflineStoreSet by Key¶
This method allows you to get the entity from OfflineStoreSet by key, and returns the entity with the key from
OfflineStoreSet
URL: https://<mobile services host>/Admin/offlinestoreupload/OfflineStoreSet('{id}')
Request Parameters for OfflineStoreSet by Key¶
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
id |
Required | key: id | String |
Response Status and Error Codes for OfflineStoreSet by Key¶
| Code | Description |
|---|---|
| 200 | Entity set OfflineStoreSet. |
| 404 | Not found. |
| 500 | Unexpected error. |
OfflineStoreSet Value¶
This method allows you to get the zip file, which includes the two databases for the offline store.
URL: https://<mobile services host>/Admin/offlinestoreupload/OfflineStoreSet('{id}')/$value
Request Parameters for OfflineStoreSet Value¶
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
id |
Required | key: id |
String |
Response Status and Error Codes for OfflineStoreSet Value¶
| Code | Description |
|---|---|
| 200 | The binary content of the zip file. |
| 404 | Not found. |
| 500 | Unexpected error. |
POST Offline Store Upload¶
This method allows you to post a new entity to entity set PolicySet.
HTTP Method: POST
URL: https://<mobile services host>/mobileservices/application/{application}/offlinestoreupload/v1/admin/PolicySet
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
Policy |
Yes | The new entity.
|
|
Response Status and Error Codes for POST Offline Store Upload¶
| Code | Description |
|---|---|
| 201 | Created entity |
| 409 | Offline Store Upload policy already exists |
| 500 | Unexpected error |
PATCH Offline Store Upload¶
This method allows you to update the entity in Entity set PolicySet.
HTTP Method: PATCH
URL: https://<mobile services host>/mobileservices/application/{application}/offlinestoreupload/v1/admin/PolicySet('{applicationId}')
Request Parameters:
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
applicationId |
Required | key: applicationId | String |
Policy |
Required | The new entity.
|
|
Response Status and Error Codes for PATCH Offline Store Upload¶
| Code | Description |
|---|---|
| 204 | Blank response |
| 404 | Not found |
| 500 | Unexpected error |
DELETE Offline Store Upload¶
HTTP Method: DELETE
DELETE Entity Set PolicySet¶
This method allows you to delete the entity in Entity set PolicySet.
URL: https://<mobile services host>/mobileservices/application/{application}/offlinestoreupload/v1/admin/PolicySet('{applicationId}')
Request Parameters:
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
applicationId |
Required | key: applicationId | string |
Response Status and Error Codes for DELETE Entity Set PolicySet¶
| Code | Description |
|---|---|
| 204 | Blank response |
| 404 | Not found |
| 500 | Unexpected error |
DELETE Entity Set OfflineStoreSet¶
This method allows you to delete the entity in Entity set OfflineStoreSet.
URL: https://<mobile services host>/Admin/offlinestoreupload/OfflineStoreSet('{id}')
Request Parameters:
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
id |
Required | key: id | String |
Response Status and Error Codes for DELETE Entity Set OfflineStoreSet¶
| Code | Description |
|---|---|
| 204 | Blank response |
| 404 | Not found |
| 500 | Unexpected error |