Jump to

• Request
• Response

Query entities

get

/serviceapi/entityModel/data/entities/license

Gets the license details of entities.

API View: Standard

Request

Supported Media Types

• application/json

Query Parameters

• addOnPackage(optional): string
  the Add on package of the entities to be looked up
• displayNamePattern(optional): string
  the displayNamePattern of the entities to be looked up
• entityName(optional): array
  Collection Format: multi

  the entity name of the entities to be looked up

  • [0]: string

  {
      "name":"entityName",
      "in":"query",
      "description":"the entity name of the entities to be looked up",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "x-example":"myHost"
  }

• entityNamePattern(optional): array
  Collection Format: multi

  Pattern of an entity name to be looked up

  • [0]: string

  {
      "name":"entityNamePattern",
      "in":"query",
      "description":"Pattern of an entity name to be looked up",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "x-example":"MyHost%"
  }

• entityType(optional): array
  Collection Format: multi

  the entity type of the entities to be looked up

  • [0]: string

  {
      "name":"entityType",
      "in":"query",
      "description":"the entity type of the entities to be looked up",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "x-example":"[\"omc_host_linux\",\"omc_db\"]"
  }

• licensePackage(optional): string
  the license package of the entities to be looked up
• limit(optional): integer(int32)
  the number of entries in the result to be returned in one REST call

  Default Value: 2000
• offset(optional): integer(int32)
  the offset into the result list when doing a query with limit

  Default Value: 0
• orderBy(optional): string
  a comma separated list of attributes with order (asc/desc) to be used for ordering the returned entities.Accepted attributes: entityType, entityName

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LicenseEntityQueryResponse

  Describes output for REST end point to query the license details of entities for a tenant.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LicenseEntityQueryResponse"
    }
}

Nested Schema : LicenseEntityQueryResponse

Type: object

Describes output for REST end point to query the license details of entities for a tenant.

Show Source

• addOnPackage(optional): string
  The Add On Package

  API View: Standard

  Example: PREMIUM
• entityName(optional): string
  The Entity Name

  API View: Standard

  Example: MyLinuxHost
• entityType(optional): string
  The Entity Type

  API View: Standard

  Example: omc_host_linux
• licensePackage(optional): string
  The license package

  API View: Standard

  Example: ENTERPRISE

{
    "type":"object",
    "properties":{
        "addOnPackage":{
            "type":"string",
            "example":"PREMIUM",
            "description":"The Add On Package<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "entityName":{
            "type":"string",
            "example":"MyLinuxHost",
            "description":"The Entity Name<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "entityType":{
            "type":"string",
            "example":"omc_host_linux",
            "description":"The Entity Type<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "licensePackage":{
            "type":"string",
            "example":"ENTERPRISE",
            "description":"The license package<p>API View: Standard</p>",
            "x-api-view":"default"
        }
    },
    "description":"<p>Describes output for REST end point to query the license details of entities for a tenant.</p>"
}

Back to Top