Version

Description: Returns version and device information

Method: GET

URL: http://pmapi/version

Output: Status code 200, data in JSON dictionary form with the following keys:

Note: The [] lists which SDKs support the fields

Keys:

• predix_mobile_sdk_version : Version number of the Predix Mobile SDK - [iOS, Android, JavaSDK]
• predix_mobile_sdk_build_version : Build version number of the Predix Mobile SDK - [iOS, Android, JavaSDK]
• application_version : Version number of the current container app - [iOS]
• application_build_version : Build version number of the current container app - [iOS]
• application_bundle_id : Bundle Id of the iOS container app - [iOS]
• java_version : Version number of Java - [JavaSDK]
• server_hostname : Configured server hostname - [iOS, Android, JavaSDK]
• device_model : Hardware description or device type - [iOS, Android]
• device_OS : Operating system name - [iOS, Android, JavaSDK]
• device_OS_version : Operating system version number - [iOS, Android, JavaSDK]
• database_version : Database version number - [iOS, Android, JavaSDK]
• locale : Current running locale - [iOS, Android, JavaSDK]

These keys provide for compatibility. May be deprecated in the future.

• PredixMobileVersion : Matches predix_mobile_sdk_build_version
• ContainerVersion : Matches application_build_version
• SyncGateway : Matches server_hostname

Platform Differences:

Due to differences in platforms, not all keys are supported.

The iOS client will not include this key:

• java_version

The Android SDK will not include these keys:

• java_version
• application_version
• application_bundle_id
• application_build_version

Platforms built with Java SDK will not include these keys by default:

• application_version
• application_bundle_id
• application_build_version
• device_model

Example response:

{
    "locale":"en_US",
    "PredixMobileVersion":"1.7.361",
    "SyncGateway":"abc1234.run.aws-usw02-pr.ice.predix.io",
    "server_hostname":"abc1234.run.aws-usw02-pr.ice.predix.io",
    "ContainerVersion":"1.7",
    "database_version":"1.2.1 (unofficial)",
    "device_model":"iPhone",
    "application_bundle_id":"com.ge.ent.PredixMobileReferenceApp",
    "predix_mobile_sdk_version":"1.7",
    "device_OS":"iPhone OS",
    "device_OS_version":"9.3",
    "application_build_version":"1.7",
    "predix_mobile_sdk_build_version":"1.7.361",
    "application_version":"1.7"
}