Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET Applications

Returns the list of predefined and user-defined applications.

Since Product Version: 3.4

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/data/Applications

Response Parameters

Attribute Description

applicationId int

Id of the application.

applicationName String

Name of the application.

businessCritical boolean

Is the application business critical?

category String

A first-level categorization for each Application Id.

encrypted ApplicationFeatureAvailabilityEnum

Specifies if the application is an encrypted networking protocol.

Allowed values:

  • YES
  • NO
  • UNASSIGNED

engineId String

A unique identifier for the engine that determined the Selector Id.

instanceOrigin InstanceOriginEnum

Allowed values:

  • UNCONCERNED
  • APPLICATION
  • NETWORK

instanceTenantId Integer

This is a tenant id for this instance.

modified Date

Specifies the date when the application was modified.

outOfBox boolean

Is the application predefined? When 'true' then the application is predefined, otherwise it is user-defined.

p2p ApplicationFeatureAvailabilityEnum

Specifies if the application is based on peer-to-peer technology.

Allowed values:

  • YES
  • NO
  • UNASSIGNED

selector int

Selector Id. It is a a unique identifier of the application for a specific Engine ID.

serviceGroup Arrow image ApplicationServiceGroup[]

Service groups the application is the member of

subcategory String

A second-level categorization for each Application Id.

tunnel ApplicationFeatureAvailabilityEnum

Specifies if the application is used as a tunnel technology.

Allowed values:

  • YES
  • NO
  • UNASSIGNED

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Payload

https://localhost/webacs/api/v4/data/Applications/15

<?xml version="1.0" ?>
<queryResponse type="Applications" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/Applications/15" rootUrl="https://localhost/webacs/api/v4/data">
  <entity dtoType="applicationsDTO" type="Applications" url="https://localhost/webacs/api/v4/data/Applications/15">
    <applicationsDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
      <applicationId>1</applicationId>
      <applicationName>String value</applicationName>
      <businessCritical>true</businessCritical>
      <category>String value</category>
      <encrypted>YES</encrypted>
      <engineId>String value</engineId>
      <modified>2018-12-21T12:09:18.454+07:00</modified>
      <outOfBox>true</outOfBox>
      <p2p>YES</p2p>
      <selector>1</selector>
      <serviceGroups>
        <serviceGroup>
          <serviceGroupId>2</serviceGroupId>
          <serviceGroupName>String value</serviceGroupName>
        </serviceGroup>
        <serviceGroup>
          <serviceGroupId>12</serviceGroupId>
          <serviceGroupName>Another string value</serviceGroupName>
        </serviceGroup>
      </serviceGroups>
      <subcategory>String value</subcategory>
      <tunnel>YES</tunnel>
    </applicationsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v4/data/Applications/15.json

{
  "queryResponse" : {
    "@type" : "Applications",
    "@requestUrl" : "https://localhost/webacs/api/v4/data/Applications/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "applicationsDTO",
      "@type" : "Applications",
      "@url" : "https://localhost/webacs/api/v4/data/Applications/15",
      "applicationsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@instanceTenantId" : "String value",
        "@uuid" : "String value",
        "applicationId" : 1,
        "applicationName" : "String value",
        "businessCritical" : true,
        "category" : "String value",
        "encrypted" : "YES",
        "engineId" : "String value",
        "modified" : "2018-12-21T05:09:18.454Z",
        "outOfBox" : true,
        "p2p" : "YES",
        "selector" : 1,
        "serviceGroups" : {
          "serviceGroup" : [ {
            "serviceGroupId" : 2,
            "serviceGroupName" : "String value"
          }, {
            "serviceGroupId" : 12,
            "serviceGroupName" : "Another string value"
          } ]
        },
        "subcategory" : "String value",
        "tunnel" : "YES"
      }
    } ]
  }
}