REST API Reference for Oracle Mobile Cloud Enterprise - Platform APIs

Retrieve App Policies

get

/mobile/platform/appconfig/client

Returns the app policies that have been set for a mobile backend.

Permissions

You can access this operation as a social user, a virtual user, an anonymous user, or a mobile user. If you access this operation as a virtual user or a mobile user, then you must have the role that's associated with the mobile backend.

Request

There are no request parameters for this operation.

Response

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

string

{
    "description":"This object contains the App Policies key/value properties",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object",
    "properties":{
    }
}

This object contains the App Policies key/value properties

Show Source

{
    "description":"This object contains the App Policies key/value properties",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object",
    "properties":{
    }
}

Example Response (application/json)

{
    "fifTechWelcomeMsg":"Hello",
    "fifTechBgImage":"/mobile/platform/storage/collections/appObjects/objects/bgImage42",
    "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 the 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

The service's error code.
o:errorDetails: 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.

{
    "description":"The error JSON object returned by the service.",
    "title":"Error",
    "type":"object",
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "minItems":0,
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/errorDetail"
            }
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    }
}

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

[0]: object Error Detail

Title: Error Detail

{
    "minItems":0,
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/errorDetail"
    }
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

instance: string

The URI to the link that provides more detailed information about the error.
o:errorCode: string

The service's 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.

{
    "title":"Error Detail",
    "type":"object",
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "properties":{
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        }
    }
}

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:password
-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"
}