PUT v1/application/{environment}/{orgId}/{appId}

Use this method to update an application Name, EULA, Platform version or MaaS Access Key and Secret Key. No other application fields can be updated through this method at the moment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
environment

Environment where the org id was generated from.

string

Required

orgId

MaaS Organization unique identifier.

integer

Required

appId

MaaS Application unique Identifier.

integer

Required

Body Parameters

Data to be updated for the specified app id. Note that properties not committed will be ignored, therefore, you are free to send only the data you which to update.

ApplicationModel
NameDescriptionTypeAdditional information
name

Application name

string

None.

major

Major version number (This is used for display purposes, should reflect the actual app version)

integer

None.

minor

Minor version number (This is used for display purposes, should reflect the actual app version)

integer

None.

revision

Revision number (This is used for display purposes, should reflect the actual app version)

integer

None.

build

Build number (This is used for display purposes, should reflect the actual app version)

integer

None.

afPlatform

App Framework Platform Simple Version the app references.

decimal number

None.

eula

End user license agreement.

string

None.

maasId

MaaS Application Identifier

integer

None.

orgId

MaaS Org Identifier

integer

None.

appKey

MaaS Application Key

string

None.

secretKey

MaaS Application Secret Key

string

None.

supportedDevices

Supported Device Type, when creating an app, the only value needed to be populated is the DeviceKind member of this class. Examples of valid device kind are: ios, iphone, ipad, android, blackberry, windowsphone, verizonfios, webbrowser. If you are creating a MaaS Application, the only device kind you will be using at the moment are: iphone, android

Collection of DeviceType

None.

hasLevels

Optionally included via endpoints that allow for query levels. This field if present, will have true or false values depending on the app having nested content levels or not.

boolean

None.

id

Entity unique identifier.

UUID

None.

type

Type of entity this abstract class represents.

EntityLinkType

None.

parent

Parent entity, i.e. if this was a property (Venue), the company that the property belongs to.

Entity

None.

Request Formats

application/json, text/json

Sample:
{
	"name" : "My Updated App",
	"afPlatform" : 4.0,
	"eula" : "Test EULA",
	"appKey" : "Test Key",
	"secretKey" : "Test Secret"
}

Response Information

Resource Description

Returns the updated application structure.

ApplicationModel
NameDescriptionTypeAdditional information
name

Application name

string

None.

major

Major version number (This is used for display purposes, should reflect the actual app version)

integer

None.

minor

Minor version number (This is used for display purposes, should reflect the actual app version)

integer

None.

revision

Revision number (This is used for display purposes, should reflect the actual app version)

integer

None.

build

Build number (This is used for display purposes, should reflect the actual app version)

integer

None.

afPlatform

App Framework Platform Simple Version the app references.

decimal number

None.

eula

End user license agreement.

string

None.

maasId

MaaS Application Identifier

integer

None.

orgId

MaaS Org Identifier

integer

None.

appKey

MaaS Application Key

string

None.

secretKey

MaaS Application Secret Key

string

None.

supportedDevices

Supported Device Type, when creating an app, the only value needed to be populated is the DeviceKind member of this class. Examples of valid device kind are: ios, iphone, ipad, android, blackberry, windowsphone, verizonfios, webbrowser. If you are creating a MaaS Application, the only device kind you will be using at the moment are: iphone, android

Collection of DeviceType

None.

hasLevels

Optionally included via endpoints that allow for query levels. This field if present, will have true or false values depending on the app having nested content levels or not.

boolean

None.

id

Entity unique identifier.

UUID

None.

type

Type of entity this abstract class represents.

EntityLinkType

None.

parent

Parent entity, i.e. if this was a property (Venue), the company that the property belongs to.

Entity

None.

Response Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "major": 2,
  "minor": 3,
  "revision": 4,
  "build": 5,
  "afPlatform": 7.1,
  "eula": "sample string 8",
  "maasId": 9,
  "orgId": 10,
  "appKey": "sample string 11",
  "secretKey": "sample string 12",
  "supportedDevices": [
    {
      "os": "sample string 1",
      "deviceKind": "sample string 2",
      "name": "sample string 3"
    },
    {
      "os": "sample string 1",
      "deviceKind": "sample string 2",
      "name": "sample string 3"
    }
  ],
  "hasLevels": true,
  "type": 1,
  "parent": {
    "type": 1
  }
}