marketplace.Jps

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

Deprecated (use the ExecuteAction method instead).

URL

https://[hoster-api-host]/1.0/marketplace/jps/rest/executeappaction

Deprecated

Parameters

• appid : “string”
  
• session : “string”
  
• appUniqueName : “string”
  
• action : “string” (optional)
  
• settingsId : “string” (optional)
  
• params : “string” (optional)
  
• lang : “string” (optional)
  

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/jps/rest/executeappaction?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"
  }
  

GetAppInfo (appid, session, [jps], [lang], [ownerUid] ) :

Returns information about the specified custom JPS manifest.

URL

https://[hoster-api-host]/1.0/marketplace/jps/rest/getappinfo

Parameters

• appid : “string”
  

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

• session : “string”
  

  user session or personal access token.

• jps : “string” (optional)
  

  custom JPS (manifest body, link, or application ID from the Marketplace).

• lang : “string” (optional)
  

  target installation language.

• ownerUid : “int” (optional)
  

  unique identifier of the target user account.

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/jps/rest/getappinfo?session=[string]&appid=[string]&jps=[string]&lang=[string]&ownerUid=[int]

Response

• AppInfoResponse
  

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

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

Deprecated (use the GetSettings method instead).

URL

https://[hoster-api-host]/1.0/marketplace/jps/rest/getappsettings

Deprecated

Parameters

• appid : “string”
  
• session : “string”
  
• appUniqueName : “string”
  
• settingsId : “string” (optional)
  
• lang : “string” (optional)
  

Example

Method: POST

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

Response

• Response
  

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

GetEngineVersion (appid, session ) :

Returns the current version of the Cloud Scripting engine.

URL

https://[hoster-api-host]/1.0/marketplace/jps/rest/getengineversion

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/jps/rest/getengineversion?session=[string]&appid=[string]

Response

• GetEngineVersionResponse
  

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

GetScriptingAppid (appid, session ) :

Deprecated (use the GetScriptingAppid method instead).

URL

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

Deprecated

Parameters

• appid : “string”
  
• session : “string”
  

Example

Method: POST

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

Response

• GetScriptingAppidResponse
  

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

Install (appid, session, jps, [envName], [settings], [nodeGroup], [displayName], [region], [envGroups], [ownerUid], [logsPath], [loggerName], [writeOutputTasks], [skipNodeEmails] ) :

Installs a custom JPS manifest.

URL

https://[hoster-api-host]/1.0/marketplace/jps/rest/install

Parameters

• appid : “string”
  

  unique identifier of the target application (required for authentication).

• session : “string”
  

  user session or personal access token.

• jps : “string”
  

  custom JPS (manifest body, link, or application ID from the Marketplace).

• envName : “string” (optional)
  

  target environment name.

• settings : “string” (optional)
  

  JSON object with custom settings for the JPS manifest.

• nodeGroup : “string” (optional)
  

  unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

• displayName : “string” (optional)
  

  custom alias (display name) for the deployed JPS application.

• region : “string” (optional)
  

  target environment region.

• envGroups : “string” (optional)
  

  target environment group name or JSON array of group names.

• ownerUid : “int” (optional)
  

  unique identifier of the target user account.

• logsPath : “string” (optional)
  

  a relative path to the JPS installation log file, which is created in the user’s application in the Backend-as-a-Service system. ‘cs.log’ by default.

• loggerName : “string” (optional)
  

  a name that will appear in the log file (to differentiate between various installations of the same application).

• writeOutputTasks : “boolean” (optional)
  

  defines whether write internal installation events (true) or not (false). It is used with the nested manifest installations.

• skipNodeEmails : “boolean” (optional)
  

  defines whether to send emails after the new nodes creation (false) or not (true).

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/jps/rest/install?settings=[string]&envGroups=[string]&logsPath=[string]&session=[string]&displayName=[string]&skipNodeEmails=[boolean]&jps=[string]&nodeGroup=[string]&envName=[string]&appid=[string]&region=[string]&ownerUid=[int]&loggerName=[string]&writeOutputTasks=[boolean]

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"
  }
  

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

Deprecated (use the Uninstall method instead).

URL

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

Deprecated

Parameters

• appid : “string”
  
• session : “string”
  
• appUniqueName : “string”
  
• force : “boolean” (optional)
  

Example

Method: POST

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

Response

• Response
  

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