2.7.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:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	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.

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	page
pageSize	integer	Size of the pages
numPages	integer	Number of the pages
totalCount	integer	Number of the objects

Application

{
        "instanceID":"...",
        "name":"...",
        "applicationType":"...",
        "applicationDetailType":"...",
        "ipAddress":"...",
        "description":"...",
        "collectorID":"...",
        "collectorName":"...",
        "applicationHosts":[{
            "resourceID":"...",
            "resourceType":"..."
        },
        :
        ],
        "autoCollectionType":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...],
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

Application (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
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
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
usedCredentials	string	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.)

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.)

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/Applications HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja


[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 3ffa18cbf3e9f46049c06aaf52a1c5444c5e2c3a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "pagination" : {
    "page" : 1,
    "pageSize" : 1,
    "numPages" : 569,
    "totalCount" : 569
  },
  "data" : [ {
    "instanceID" : 568,
    "name" : "IMM-HOST02",
    "applicationType" : "IM_OS",
    "ipAddress" : "IMM-HOST02",
    "description" : "10.197.73.120",
    "collectorID" : 4,
    "collectorName" : "10.197.73.120",
    "applicationHosts":
    [
        {
            "resourceID": 13,
            "resourceType": "Host"
        }
    ],
    "autoCollectionType": "AutoConnect",
    "groupIDs":
    [
        0
    ],
    "groupNames":
    [
        "#Unassigned Resources"
    ],
    "gradeNames":
    [
        ""
    ],
    "gradeOrders":
    [
        -1
    ],
    "usedCredentialID" : 17,
    "accessPointType" : "IM",
    "accessPointIpAddress" : "10.197.73.120",
    "accessPointUser" : "Administrator"
  },
  {
      "instanceID": 567,
      "name": "Zabbix server1",
      "applicationType": "CUSTOM",
      "applicationDetailType": "App Zabbix Server",
      "ipAddress": "192.168.1.251",
      "description": "XX Monitoring System",
      "collectorID": 3,
      "collectorName": "customCollector",
      "applicationHosts":
      [
      ],
      "autoCollectionType": "AutoConnect",
      "groupIDs":
      [
          0
      ],
      "groupNames":
      [
          "#Unassigned Resources"
      ],
      "gradeNames":
      [
          ""
      ],
      "gradeOrders":
      [
          -1
      ],
      "usedCredentialID": 0,
      "accessPointType": "CUSTOM"
  } ],
  "count" : 2
}