Marketplace

marketplace.Console

Estimated reading: 3 minutes 516 views
Namespace: Marketplace
REST: https://[hoster-api-host]/1.0/marketplace/console/rest/{method-name}
Scripting: marketplace.console.{method-name}
The Console service provides the ability to read and write a user’s application installation log. Learn more about console log in the linked documentation.

Methods

ClearLog (appid, session ) :

Clears all messages in the console log.

URL

https://[hoster-api-host]/1.0/marketplace/console/rest/clearlog

Parameters

  • appid : “string”

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

  • session : “string”

Example

Method: POST

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

Response

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

ReadLog (appid, session ) :

Returns the last messages in the console log.

URL

https://[hoster-api-host]/1.0/marketplace/console/rest/readlog

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

Response

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

WriteLog (appid, session, message ) :

Writes a specified custom message to the console log.

URL

https://[hoster-api-host]/1.0/marketplace/console/rest/writelog

Parameters

  • appid : “string”

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

  • session : “string”

    user session or personal access token.

  • message : “string”

    a custom message to be added to the console log.

Example

Method: POST

https://[hoster-api-host]/1.0/marketplace/console/rest/writelog?session=[string]&appid=[string]&message=[string]

Response

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

Leave a Comment