Skip to content

Retrieving Service Documents

Get the service document for the application connection.

Usage

Retrieving the service document allows the client to discover the capabilities and locations of the available collections.

Request

URL: https://<mobile services host>/odata/applications/<service version>/<appid>

HTTP Method: GET

Request Parameters

Parameter Type Description
<appid> Mandatory ID that uniquely identifies an application
<service version> Mandatory v1 onwards

Request Header Example

GET /odata/applications/v1/com.sap.myapp HTTP/1.1
Host: mobile-ops-subscriber-development-qa-xapp8.cfapps.sap.hana.ondemand.com
Authorization: Basic REVWMDAwMTppbml0aWFs

Response Body Example

<?xml version='1.0' encoding='utf-8'?>
<service xmlns="http://www.w3.org/2007/app"
         xml:base="http://host:port/appSettings/odata/v1/appid/"
         xmlns:atom="http://www.w3.org/2005/Atom"
         xmlns:app="http://www.w3.org/2007/app">
    <workspace>
        <atom:title>Default</atom:title>
        <collection href="Connections">
            <atom:title>Connections</atom:title>
        <collection href="Endpoints">
            <atom:title>Endpoints</atom:title>
        </collection>
    </workspace>
 </service>

Response

Code Description
200 OK Returns service document

Last update: August 12, 2020