Jump to

• Request
• Response

Get summary of Images and Subscriptions

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/querySummary

Gets Statistics of, compliance of image and targets and subscriptions

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• excludeList: array excludeList
  exclude the given summaries

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GlobalTargetFilter"
        }
    ],
    "properties":{
        "excludeList":{
            "description":"exclude the given summaries",
            "type":"array",
            "items":{
                "enum":[
                    "subscriptions",
                    "images",
                    "targets"
                ]
            }
        }
    }
}

Match All

Show Source

• object GlobalTargetFilter
  Global target property filters

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GlobalTargetFilter"
        }
    ],
    "properties":{
        "excludeList":{
            "description":"exclude the given summaries",
            "type":"array",
            "items":{
                "enum":[
                    "subscriptions",
                    "images",
                    "targets"
                ]
            }
        }
    }
}

Nested Schema : excludeList

Type: array

exclude the given summaries

Show Source

• Array of:
  Allowed Values: [ "subscriptions", "images", "targets" ]

{
    "description":"exclude the given summaries",
    "type":"array",
    "items":{
        "enum":[
            "subscriptions",
            "images",
            "targets"
        ]
    }
}

Nested Schema : GlobalTargetFilter

Type: object

Global target property filters

Show Source

• targetProperties: targetProperties
  Properties of target
• targetTypeList: array targetTypeList
  Target type

{
    "description":"Global target property filters",
    "type":"object",
    "properties":{
        "targetTypeList":{
            "description":"Target type",
            "type":"array",
            "items":{
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "cluster",
                    "has"
                ]
            }
        },
        "targetProperties":{
            "description":"Properties of target",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TargetPropertyFilter"
                }
            ]
        }
    }
}

Nested Schema : targetProperties

Properties of target

Match All

Show Source

• object TargetPropertyFilter
  Target property filters

{
    "description":"Properties of target",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPropertyFilter"
        }
    ]
}

Nested Schema : targetTypeList

Type: array

Target type

Show Source

• Array of:
  Allowed Values: [ "oracle_database", "rac_database", "cluster", "has" ]

{
    "description":"Target type",
    "type":"array",
    "items":{
        "enum":[
            "oracle_database",
            "rac_database",
            "cluster",
            "has"
        ]
    }
}

Nested Schema : TargetPropertyFilter

Type: object

Target property filters

Show Source

• contactList: array contactList
  List of contacts
• costCenterList: array costCenterList
  List of cost centers
• departmentList: array departmentList
  List of departments
• downtimeContactList: array downtimeContactList
  List of downtime contacts
• lifecycleStatusList: array lifecycleStatusList
  List of lifecyclestatus
• lineOfBusinessList: array lineOfBusinessList
  List of line of business
• locationList: array locationList
  List of locations
• siteList: array siteList
  List of sites

{
    "description":"Target property filters",
    "type":"object",
    "properties":{
        "contactList":{
            "description":"List of contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "downtimeContactList":{
            "description":"List of downtime contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costCenterList":{
            "description":"List of cost centers",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "departmentList":{
            "description":"List of departments",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lineOfBusinessList":{
            "description":"List of line of business",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "locationList":{
            "description":"List of locations",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "siteList":{
            "description":"List of sites",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lifecycleStatusList":{
            "description":"List of lifecyclestatus",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : contactList

Type: array

List of contacts

Show Source

• Array of: string

{
    "description":"List of contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : costCenterList

Type: array

List of cost centers

Show Source

• Array of: string

{
    "description":"List of cost centers",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : departmentList

Type: array

List of departments

Show Source

• Array of: string

{
    "description":"List of departments",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : downtimeContactList

Type: array

List of downtime contacts

Show Source

• Array of: string

{
    "description":"List of downtime contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : lifecycleStatusList

Type: array

List of lifecyclestatus

Show Source

• Array of: string

{
    "description":"List of lifecyclestatus",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : lineOfBusinessList

Type: array

List of line of business

Show Source

• Array of: string

{
    "description":"List of line of business",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : locationList

Type: array

List of locations

Show Source

• Array of: string

{
    "description":"List of locations",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : siteList

Type: array

List of sites

Show Source

• Array of: string

{
    "description":"List of sites",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example Filter on Target types and all summaries included Filter on Target properties and exclude 'images' summary Filter on Target properties and exclude 'images', 'targets' summary

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. Summary details retrieved.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object GoldImageAndSubscriptionSummary
  Image and Subscription statistics

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageAndSubscriptionSummary"
        }
    ]
}

Nested Schema : GoldImageAndSubscriptionSummary

Type: object

Image and Subscription statistics

Show Source

• images: array images
  Statistics of images grouped by image status (uptodate, uptodateVersionNotCurrent, needOracleRecommendedPatches)
• subscriptions: array subscriptions
  Statistics of subscriptions grouped by target type
• targets: array targets
  Statistics of targets grouped by patchlevel (current/non-current)

{
    "description":"Image and Subscription statistics",
    "type":"object",
    "properties":{
        "subscriptions":{
            "description":"Statistics of subscriptions grouped by target type",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/SubscriptionStatistics"
                    }
                ]
            }
        },
        "images":{
            "description":"Statistics of images grouped by image status (uptodate, uptodateVersionNotCurrent, needOracleRecommendedPatches)",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/ImageStatistics"
                    }
                ]
            }
        },
        "targets":{
            "description":"Statistics of targets grouped by patchlevel (current/non-current)",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetStatistics"
                    }
                ]
            }
        }
    }
}

Nested Schema : images

Type: array

Statistics of images grouped by image status (uptodate, uptodateVersionNotCurrent, needOracleRecommendedPatches)

Show Source

• Array of: items

{
    "description":"Statistics of images grouped by image status (uptodate, uptodateVersionNotCurrent, needOracleRecommendedPatches)",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/ImageStatistics"
            }
        ]
    }
}

Nested Schema : subscriptions

Type: array

Statistics of subscriptions grouped by target type

Show Source

• Array of: items

{
    "description":"Statistics of subscriptions grouped by target type",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/SubscriptionStatistics"
            }
        ]
    }
}

Nested Schema : targets

Type: array

Statistics of targets grouped by patchlevel (current/non-current)

Show Source

• Array of: items

{
    "description":"Statistics of targets grouped by patchlevel (current/non-current)",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetStatistics"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object ImageStatistics
  Statistics of the images

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ImageStatistics"
        }
    ]
}

Nested Schema : ImageStatistics

Type: object

Statistics of the images

Show Source

• categories: array categories
  Includes the count of images, which are uptodate and needOracleRecommendedPatches
• total: number
  Total number of images

  Example: 100

{
    "description":"Statistics of the images",
    "type":"object",
    "properties":{
        "total":{
            "description":"Total number of images",
            "type":"number",
            "example":100
        },
        "categories":{
            "description":"Includes the count of images, which are uptodate and needOracleRecommendedPatches",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/ImageCategoryStatistics"
                    }
                ]
            }
        }
    }
}

Nested Schema : categories

Type: array

Includes the count of images, which are uptodate and needOracleRecommendedPatches

Show Source

• Array of: items

{
    "description":"Includes the count of images, which are uptodate and needOracleRecommendedPatches",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/ImageCategoryStatistics"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object ImageCategoryStatistics
  Statistics of image category

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ImageCategoryStatistics"
        }
    ]
}

Nested Schema : ImageCategoryStatistics

Type: object

Statistics of image category

Show Source

• count: number
  Count of images

  Example: 50
• name: string
  Allowed Values: [ "uptodate", "needOracleRecommendedPatches" ]

  Name of the image category

{
    "description":"Statistics of image category",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the image category",
            "type":"string",
            "enum":[
                "uptodate",
                "needOracleRecommendedPatches"
            ]
        },
        "count":{
            "description":"Count of images",
            "type":"number",
            "example":50
        }
    }
}

Nested Schema : items

Match All

Show Source

• object SubscriptionStatistics
  Statistics of the subscriptions

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SubscriptionStatistics"
        }
    ]
}

Nested Schema : SubscriptionStatistics

Type: object

Statistics of the subscriptions

Show Source

• targetType: string
  Allowed Values: [ "oracle_database", "rac_database", "cluster", "has" ]

  Target type
• total: number
  Count of targets

  Example: 100
• unsubscribedCount: number
  Count of unsubscribed targets

  Example: 50

{
    "description":"Statistics of the subscriptions",
    "type":"object",
    "properties":{
        "targetType":{
            "description":"Target type",
            "type":"string",
            "enum":[
                "oracle_database",
                "rac_database",
                "cluster",
                "has"
            ]
        },
        "total":{
            "description":"Count of targets",
            "type":"number",
            "example":100
        },
        "unsubscribedCount":{
            "description":"Count of unsubscribed targets",
            "type":"number",
            "example":50
        }
    }
}

Nested Schema : items

Match All

Show Source

• object TargetStatistics
  Statistics of the targets

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetStatistics"
        }
    ]
}

Nested Schema : TargetStatistics

Type: object

Statistics of the targets

Show Source

• categories: array categories
  Includes the count of the targets subscribed to current and non-current image version
• total: number
  Total number of subscribed targets

  Example: 100

{
    "description":"Statistics of the targets",
    "type":"object",
    "properties":{
        "total":{
            "description":"Total number of subscribed targets",
            "type":"number",
            "example":100
        },
        "categories":{
            "description":"Includes the count of the targets subscribed to current and non-current image version",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetCategoryStatistics"
                    }
                ]
            }
        }
    }
}

Nested Schema : categories

Type: array

Includes the count of the targets subscribed to current and non-current image version

Show Source

• Array of: items

{
    "description":"Includes the count of the targets subscribed to current and non-current image version",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetCategoryStatistics"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object TargetCategoryStatistics
  Statistics of the target category

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetCategoryStatistics"
        }
    ]
}

Nested Schema : TargetCategoryStatistics

Type: object

Statistics of the target category

Show Source

• count: number
  Count of the targets subscribed to the image category

  Example: 70
• name: string
  Allowed Values: [ "current", "notCurrent" ]

  Category name of the image

{
    "description":"Statistics of the target category",
    "type":"object",
    "properties":{
        "name":{
            "description":"Category name of the image",
            "type":"string",
            "enum":[
                "current",
                "notCurrent"
            ]
        },
        "count":{
            "description":"Count of the targets subscribed to the image category",
            "type":"number",
            "example":70
        }
    }
}

Examples

Select an example Filter on Target types and all summaries included Filter on Target properties and exclude 'images' summary Filter on Target properties and exclude 'images', 'targets' summary

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top