2.11.1 Obtaining Application List

The API acquires a list of applications.

Execution permission

Admin, Modify

API version

Request format

GET http[s]://host:port/Analytics/version/objects/Applications

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "applicationType":"...",
            "applicationDetailType":"...",
            "ipAddress":"...",
            "description":"...",
            "collectorID":"...",
            "collectorName":"...",
            "applicationHosts":[{
                "resourceID":"...",
                "resourceType":"..."
            },
            :
            ],
            "applicationContainers":[{
                "resourceID":"...",
                "resourceType":"..."
            },
            :
            ],
            "autoCollectionType":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "usedCredentialID":"...",
            "accessPointType":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	Application[]	A list of Application objects. For details about Application, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions.

data (Type: Application)

Attribute	Type	Description
instanceID	long	Instance ID
name	string	Name of the detected application
applicationType	enum	Application type (For details about the specifiable values, see the table ApplicationType in List of enumerators.) The specifiable values are as follows: AJS_MANAGER AJS_AGENT PFM_SERVICERESPONSE PFM_AJS3 PFM_DOMINO PFM_EXCHANGE PFM_SAPSYSTEM PFM_IBMWEBSPHEREMQ PFM_OPENTP1 PFM_COSMINEXUS PFM_IIS PFM_WEBLOGICSERVER PFM_WEBSPHEREAPPLICATIONSERVER PFM_DB2 PFM_HIRDB PFM_SQL PFM_RMSQLSERVER PFM_ORACLE PFM_RMORACLE PFM_RMPLATFORM PFM_UNIX PFM_WINDOWS IM_OS PFM_RMVIRTUALMACHINE PFM_VIRTUALMACHINE CUSTOM
applicationDetailType	string	Type of the custom application
ipAddress	string	IP address of the application
description	string	Detailed information about the application
collectorID	long	ID identifying the collector used for detection
collectorName	string	Name of the collector used for detection
applicationHosts	ApplicationHost[]	Resources to which the application belongs
applicationContainers	ApplicationContainer[]	Containers to which the application belongs
autoCollectionType	enum	Settings for periodic execution of the collector (For details about the specifiable values, see the table ConnectType in List of enumerators.)
groupIDs	long[]	ID identifying the consumer to which the application is allocated
groupNames	string[]	Name of the consumer to which the application is allocated
gradeNames	string[]	Grade of the consumer to which the application is allocated
gradeOrders	integer[]	Priority of the grade of the consumer to which the application is allocated
usedCredentialID	long	ID identifying the authentication information used at detection
accessPointType	enum	Type of collector used at detection (For details about the specifiable values, see the table ProtocolType in List of enumerators.)
accessPointIpAddress	string	IP address or host name of the authentication information
accessPointUser	string	User ID used to connect to monitoring targets or management software

applicationHosts (Type: ApplicationHost)

Attribute	Type	Description
resourceID	long	ID of the resource to which the application belongs
resourceType	enum	Type of the resource to which the application belongs (For details about the specifiable values, see the table ApplicationResourceType in List of enumerators.) The specifiable values are as follows: VirtualMachine Host ServiceInstance

Attribute

Type

Description

resourceID

long

ID of the resource to which the application belongs

resourceType

enum

Type of the resource to which the application belongs

(For details about the specifiable values, see the table ApplicationResourceType in List of enumerators.)

The specifiable values are as follows:

VirtualMachine
Host
ServiceInstance

applicationContainers (Type: ApplicationContainer)

Attribute	Type	Description
resourceID	long	ID of the resource to which the application belongs
resourceType	enum	Type of the resource to which the application belongs (For details about the specifiable values, see the table ApplicationResourceType in List of enumerators.) The specifiable values are as follows: Pod