SAP Fiori launchpad on cloud API documentation version v1

https://{CP_LandscapeHost}/fiori/api/v1

Home

SAP Fiori launchpad on cloud account configuration APIs.

OAuth 2.0 Protection

Base URI: https://{CP_LandscapeHost}/fiori/api/oauth2/v1
Supported grant types: Client Credentials Grant

To use this REST API, you need to get OAuth client credentials (client ID and secret) from SAP HANA Cloud Platform using the cockpit. After that, you need to pass the obtained client credentials and the relevant scope to the SAP HANA Cloud Platform token endpoint to obtain an access token. In the requests to this API, include the access token as a header with name Authorization and value Bearer <token value>

Supported Scopes: read (for GET requests), write (for POST and UPDATE requests) and delete (for DELETE requests).

CSRF Protection

In order to use the SAP Fiori launchpad on cloud API to modify objects, you must pass a valid CSRF token. You can get such a token by calling this URL. For more details on how to fetch the token, see the GET Request section.

Note: It is important to keep the session that is started with getting the token.

get

get

Retrieves CSRF token

Manage Custom UI5 version Interface [MUI]

Manages the SAPUI5 version for the account.

get post delete

get

Gets the current configured SAPUI5 version for the account.

post

Adds/updates a new custom SAPUI5 version property for the account.

delete

Removes the SAPUI5 custom version configuration for the account.

Adds/updates a new custom SAPUI5 version property for the account.

Secured by OAuth 2.0

Supports OAuth 2.0.

Query Parameters

  • version: required (string)

    the needed custom SAPUI5 version

    Example:

    1.36.11

HTTP status code 200

Custom SAPUI5 version was set for the current tenant.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Custom UI5 version",
  "type": "object",
    "properties": {
      "customSAPUI5Version": {
        "description": "The value of the configured custom SAPUI5 versions.",
        "type": "string"
      }
    },
    "required": [
      "customSAPUI5Version"
    ]
}

Example:

{
  "customSAPUI5Version": "1.36.11"
}

HTTP status code 400

version parameter is not valid. call /customUI5Version/versions to get available supported versions.

Secured by OAuth 2.0

get

get

Get supported SAPUI5 versions

Manage Translation Interface (MTI)

The Manage Translation Interface (MTI) enables you to download the master_language.zip from your site, and to upload the properties file with the translated content back to the site. You can use this API for automating the translation process.

post

post

Uploads a zip file that contains the translated content (properties files) to a given site.

Uploads a zip file that contains the translated content (properties files) to a given site.

Secured by OAuth 2.0

Supports OAuth 2.0.

URI Parameters

  • siteId: required (string)

    The ID of the site to which to upload the properties files.

    Example:

    b24f5a5b-23d6-4478-9691-6d23e2de633b

Headers

  • Authorization: required (string)

    The Authorization header has to specify the Bearer token that you created for the "write" scope.

    Example:

    Authorization : Bearer dcda7a8d792586eec5acb73077309d96
  • Content-Type: required (string)

    The Content-Type header must be multipart/form-data.

    Example:

    Content-Type : multipart/form-data

Body

Type: multipart/form-data

Form Parameters
  • Translation-File: required (file)

    The file to be uploaded.

  • Content-Type: required (string)

    The Content-Type header must be application/x-zip-compressed

    Example:

    Content-Type : application/x-zip-compressed

HTTP status code 200

Succesfully uploaded the translation content file.

Secured by OAuth 2.0

get

get

Downloads the master_language.zip file from a given site.

Downloads the master_language.zip file from a given site.

Secured by OAuth 2.0

Supports OAuth 2.0.

URI Parameters

  • siteId: required (string)

    The ID of the site from which to download the file.

    Example:

    b24f5a5b-23d6-4478-9691-6d23e2de633b

Headers

  • Authorization: required (string)

    The Authorization header has to specify the Bearer token that you created for the "read" scope.

    Example:

    Authorization : Bearer dcda7a8d792586eec5acb73077309d96

HTTP status code 200

Succesfully downloaded the master_language.zip file.

Secured by OAuth 2.0