marketplace.Installation

ExecuteAction (appid, session, appUniqueName, [action], [settingsId], [params], [lang] ) :

Executes a custom action that is available for the installed application from the Marketplace.

URL

https://[hoster-api-host]/1.0/marketplace/installation/rest/executeaction

Parameters

• appid : “string”
  

  unique identifier of the application for which the session was created (optional).

• session : “string”
  

  user session or personal access token.

• appUniqueName : “string”
  

  unique identifier of the particular installation.

• action : “string” (optional)
  

  unique identifier of the custom action name to be executed.

• settingsId : “string” (optional)
  

  unique identifier of the settings section of the manifest. Default settings form ID is ‘main’.

• params : “string” (optional)
  

  JSON object with custom settings for the JPS manifest.

• lang : “string” (optional)
  

  target localization language.

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/installation/rest/executeaction?appUniqueName=[string]&session=[string]&appid=[string]&action=[string]&settingsId=[string]&params=[string]&lang=[string]

Response

• InstallResponse
  

  {
     "action": "string",
     "appid": "string",
     "data": "JSONObject",
     "error": "string",
     "message": "string",
     "reason": "string",
     "response": "Object",
     "result": "int",
     "startPage": "string",
     "successText": "string",
     "type": "string",
     "uniqueName": "string"
  }
  

GetEnvAppid (appid, session, appUniqueName ) :

Returns a unique identifier of the environment using the installed Marketplace application identifier.

URL

https://[hoster-api-host]/1.0/marketplace/installation/rest/getenvappid

Parameters

• appid : “string”
  

  unique identifier of the application for which the session was created (optional).

• session : “string”
  

  user session or personal access token.

• appUniqueName : “string”
  

  unique identifier of the particular installation.

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/installation/rest/getenvappid?appUniqueName=[string]&session=[string]&appid=[string]

Response

• GetScriptingAppidResponse
  

  {
     "appid": "string",
     "error": "string",
     "response": "Object",
     "result": "int"
  }
  

GetInfo (appid, session, appUniqueName ) :

Returns information about the specified installed application from the Marketplace.

URL

https://[hoster-api-host]/1.0/marketplace/installation/rest/getinfo

Parameters

• appid : “string”
  

  unique identifier of the application for which the session was created (optional).

• session : “string”
  

  user session or personal access token.

• appUniqueName : “string”
  

  unique identifier of the particular installation.

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/installation/rest/getinfo?appUniqueName=[string]&session=[string]&appid=[string]

Response

• AppInfoResponse
  

  {
     "app": "JSONObject",
     "error": "string",
     "response": "Object",
     "result": "int",
     "settings": "JSONObject"
  }
  

GetScriptingAppid (appid, session ) :

Returns a user-specific application identifier, created on demand for scripting within the Backend-as-a-Service system.

URL

https://[hoster-api-host]/1.0/marketplace/installation/rest/getscriptingappid

Parameters

• appid : “string”
  

  unique identifier of the application for which the session was created (optional).

• session : “string”
  

  user session or personal access token.

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/installation/rest/getscriptingappid?session=[string]&appid=[string]

Response

• GetScriptingAppidResponse
  

  {
     "appid": "string",
     "error": "string",
     "response": "Object",
     "result": "int"
  }
  

GetSettings (appid, session, appUniqueName, [settingsId], [lang] ) :

Returns information on the specified application custom settings.

URL

https://[hoster-api-host]/1.0/marketplace/installation/rest/getsettings

Parameters

• appid : “string”
  

  unique identifier of the application for which the session was created (optional).

• session : “string”
  

  user session or personal access token.

• appUniqueName : “string”
  

  unique identifier of the particular installation.

• settingsId : “string” (optional)
  

  unique identifier of the settings section of the manifest. Default settings form ID is ‘main’.

• lang : “string” (optional)
  

  target localization language.

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/installation/rest/getsettings?appUniqueName=[string]&session=[string]&appid=[string]&settingsId=[string]&lang=[string]

Response

• SettingsResponse
  

  {
     "error": "string",
     "response": "Object",
     "result": "int",
     "settings": "JSONObject"
  }
  

Uninstall (appid, session, appUniqueName, [force] ) :

Uninstalls the specified application installed from the Marketplace.

URL

https://[hoster-api-host]/1.0/marketplace/installation/rest/uninstall

Parameters

• appid : “string”
  

  unique identifier of the application for which the session was created (optional).

• session : “string”
  

  user session or personal access token.

• appUniqueName : “string”
  

  unique identifier of the particular installation.

• force : “boolean” (optional)
  

  defines whether to proceed (true) or interrupt (false) the operation in case of errors.

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/installation/rest/uninstall?appUniqueName=[string]&session=[string]&appid=[string]&force=[boolean]

Response

• Response
  

  {
     "error": "string",
     "response": "Object",
     "result": "int"
  }