Retrieve App Policies
get
/mobile/platform/appconfig/client
Returns the app policies that have been set for a mobile backend.
Permissions
The request can be performed anonymously or by a user who's a member of the realm that's associated with the mobile backend.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The information was retrieved successfully.
This object contains the App Policies key/value properties
Root Schema : appPolicies
Type:
object
Additional Properties Allowed
Show Source
This object contains the App Policies key/value properties
Show Source
Example Response (application/json)
{
"fifTechBgImage":"/mobile/platform/storage/collections/appObjects/objects/bgImage42",
"fifTechWelcomeMsg":"Hello",
"fifTechReqTimeout":100000
}
400 Response
The request failed because an exception occurred during processing.
Root Schema : Error
Type:
object
Title:
Error
The error JSON object returned by Mobile Cloud Service.
Show Source
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
Mobile Cloud Service error code.
-
o:errorDetails(optional):
array o:errorDetails
Minimum Number of Items:
0
List of the issues that cause the error. Included when the error is caused by multiple issues. -
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : o:errorDetails
Type:
array
Minimum Number of Items:
0
List of the issues that cause the error. Included when the error is caused by multiple issues.
Show Source
-
Array of:
object Error Detail
Title:
Error Detail
Nested Schema : Error Detail
Type:
object
Title:
Show Source
Error Detail
-
instance:
string
The URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
Mobile Cloud Service error code.
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Examples
The following example shows how to get the app policy values. For more information about cURL, see Use cURL.
curl -i -X GET -u mobile.user@example.com:mypassword -H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" https://fif.cloud.oracle.com/mobile/platform/appconfig/client
Example of Response Header
The following shows an example of the response header.
200 OK Content-Type: application/json Date: Thu, 18 Jun 2015 00:26:10 GMT
Example of Response Body
The following example shows, in JSON format, the contents of the response body, which lists all the app policies:
{ "fifTechReqTimeout":100000, "fifTechWelcomeMsg":"Hello", "fifTechBgImage":"/mobile/platform/storage/collections/appObjects/objects/bgImage42" }