GCM Credentials (PUT)

Set Google Cloud Messaging (GCM) credentials of the application with the application ID, environment, and version.

Roles

Users in the following roles are authorized to perform this operation:

worklightadmin
worklightdeployer
worklightmonitor
worklightoperator

Method

PUT

Path

/management-apis/1.0/runtimes/runtime-name/notifications/applications/application-name/gcmConf/application-env/application-version/

Example

https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/notifications/applications/myapplication/gcmConf/android/1.0/?locale=de_DE

Path Parameters

runtime-name: The name of the runtime. This is the context root of the runtime web application, without the leading slash.
application-name: The name of the application.
application-env: The application environment.
application-version: The application version number.

Query Parameters

Query parameters are optional.

locale: The locale used for error messages.

Consumes

application/json

Produces

application/json, application/xml, text/xml

Payload

The payload in JSON format has values for apiKey and senderId.

JSON Example

{
  "apiKey" : "AIzaSyDSJrrrrrrrrrrZZZZZZZX7ZTmnoRLkwiU",
  "senderId" : "1099999999999",
}

Payload Properties

The payload has the following properties:

apiKey: The key value received from GCM.
senderId: The project ID received from GCM.

Response

The status of set GCM credentials.

JSON Example

{
  "productVersion" : {
    "productVersion" : "7.0.0",
  },
  "project" : {
    "name" : "PushNotifications",
  },
  "status" : "Success",
  "type" : "SET_GCM_CREDENTIALS",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<setGCMCredentialsStatus
  status="Success"
  type="SET_GCM_CREDENTIALS">
  <productVersion productVersion="7.0.0"/>
  <project name="PushNotifications"/>
</setGCMCredentialsStatus>

Response Properties

The response has the following properties:

productVersion: The exact product version.
project: Project name.
status: The GCM credentials are saved successfully.
type: Transaction type.

The productVersion has the following properties:

productVersion: The exact product version

The project has the following properties:

name: Name of the project

Errors

403

The user is not authorized to call this service.

404

The corresponding runtime is not found or not running.

500

An internal error occurred.