GET /gui_app_framework/applications/{application_id}

Retrieve an installed application.

Retrieved details include the application manifest and current status.

Table 1. GET /gui_app_framework/applications/{application_id} resource details
MIME Type
application/json

Table 2. GET /gui_app_framework/applications/{application_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
application_id	path	Required	Number (Integer)	text/plain	Required - The application identifier.

Table 3. GET /gui_app_framework/applications/{application_id} response codes
HTTP Response Code	Unique Code	Description
200		The application was retrieved.
404	1002	The application identifier could not be found.
409	33700	The application framework is currently disabled.
500	1020	The request could not be completed.

Response Description

Application details:

application_state
- application_id - String - Application identifier.
- status - String
  - CREATING - the application install has not yet completed.
  - UPGRADING - the application upgrade has not yet completed.
  - RUNNING - the application is running.
  - STOPPED - the application has been stopped manually.
  - ERROR - the application is no longer running due to an error. The reason is in error_message.
- error_message - String - Any error message associated with the application.
- memory - Integer - The amount of memory allocated to the application
manifest - Object - The application's JSON manifest.

Response Sample


{
    "application_state":{
        "application_id":"1001",
        "status":"RUNNING",
        "memory":200,
        "external_port":25092
    },
    "manifest":{
 
        "name":"Sample Application",
        "description":"An example of how to create an application manifest",
        "version":"0.0.1",
 
        "areas": [
            {
                "id":"Qapp1_HelloWorld",
                "url":"http://9.21.118.58:5000",
                "text":"QApp1",
                "description":"Loading a dockerised web app into a tab inside Qradar",
                "required_capabilities":["ADMIN"]
            }
        ],
 
        "dashboard_items": [
            {
                "text":"Sample Item",
                "description":"Sample dashboard item that is a copy of most recent offenses",
                "rest_method":"sampleDashboardItem",
               "required_capabilities":["ADMIN"]
            }
        ],
 
        "rest_methods": [
            {
                "name":"sampleDashboardItem",
                "url":"/static/sampleDashboardItemResponse.json",
                "method":"GET",
                "argument_names":[],
                "required_capabilities":["ADMIN"]
            },
            {
                "name":"sampleToolbarMethod",
                "url":"/static/sampleToolbarButtonResponse.json",
                "method":"GET",
                "argument_names":["context"],
                "required_capabilities":["ADMIN"]
            },
            {
                "name":"sampleIPInformation",
                "url":"/static/sampleIPInformationResponse.json",
                "method":"GET",
                "argument_names":["metaDataContext"],
                "required_capabilities":["ADMIN"]
            },
            {
                "name":"sampleUserInformation",
                "url":"/static/sampleUserInformationResponse.json",
                "method":"GET",
                "argument_names":["metaDataContext"],
                "required_capabilities":["ADMIN"]
            },
            {
                "name":"sampleURLInformation",
                "url":"/static/sampleURLInformationResponse.json",
                "method":"GET",
                "argument_names":["metaDataContext"],
                "required_capabilities":["ADMIN"]
            },
            {
                "name":"addToReferenceSet",
                "url":"/addToReferenceSet",
                "method":"GET",
                "argument_names":["data"]
            }
        ],
 
        "configuration_pages": [
            {
                "text":"Open IBM.com",
                "description":"Loading IBM.com in a new window",
                "icon":null,
                "url":"https://www.ibm.com/us/en/",
                "required_capabilities":["ADMIN"]
            }
        ],
 
        "gui_actions": [
            {
                "id":"addToReferenceSet",
                "text":"Add To Reference Set",
                "description":"Adds to a reference set",
                "icon":null,
                "rest_method":"addToReferenceSet",
                "javascript":"alert(result)",
                "groups":[ "ipPopup" ],
                "required_capabilities":[ "ADMIN" ]
            },
            {
                "id":"sampleToolbarButton",
                "text":"Sample Toolbar Button",
                "description":"Sample toolbar button that calls a REST method, passing an offense ID along",
                "icon":null,
                "rest_method":"sampleToolbarMethod",
                "javascript":"alert(result)",
                "groups":[ "OffenseListToolbar" ],
                "required_capabilities":[ "ADMIN" ]
            }
        ],
 
        "page_scripts": [
            {
                "app_name":"SEM",
                "page_id":"OffenseList",
                "scripts":["/static/sampleScriptInclude.js"]
            }
        ],
     
        "metadata_providers": [
            {
                "rest_method":"sampleIPInformation",
                "metadata_type":"ip"
            },
            {
                "rest_method":"sampleUserInformation",
                "metadata_type":"userName"
            },
            {
                "rest_method":"sampleURLInformation",
                "metadata_type":"ariel:URL"
            }
        ]
    },
    "installed_by": "admin",
    "installed_on": "1513766636242",
    "managed_host_id": "53"
}