Jump to

• Request
• Response

Get Subscription Report of Targets

post

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

Get subscription details of targets

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

• exclusions: array exclusions
  Array of details to be excluded in response
• limit: number
  Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)

  Example: 10
• page: string
  Base 64 encoded page

  Example: b2Zmc2V0OjA
• sort: string
  Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName', 'targetType', 'hostName', 'dataguardRole', 'release', 'platform', 'targetStatus', 'clusterName', 'isSubscribed', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.

  Example: name:asc

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsSubscriptionReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName', 'targetType', 'hostName', 'dataguardRole', 'release', 'platform', 'targetStatus', 'clusterName', 'isSubscribed', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"name:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":10
        },
        "exclusions":{
            "description":"Array of details to be excluded in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "TARGETS_DISTRIBUTION",
                    "TOTAL"
                ]
            }
        }
    }
}

Match All

Show Source

• object TargetsSubscriptionReportFilter
  Filters for targets subscription report

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsSubscriptionReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName', 'targetType', 'hostName', 'dataguardRole', 'release', 'platform', 'targetStatus', 'clusterName', 'isSubscribed', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"name:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":10
        },
        "exclusions":{
            "description":"Array of details to be excluded in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "TARGETS_DISTRIBUTION",
                    "TOTAL"
                ]
            }
        }
    }
}

Nested Schema : exclusions

Type: array

Array of details to be excluded in response

Show Source

• Array of: string
  Allowed Values: [ "TARGETS_DISTRIBUTION", "TOTAL" ]

{
    "description":"Array of details to be excluded in response",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "TARGETS_DISTRIBUTION",
            "TOTAL"
        ]
    }
}

Nested Schema : TargetsSubscriptionReportFilter

Type: object

Filters for targets subscription report

Show Source

• platform: string
  Platform of the target

  Example: linux_x64_86
• releaseMatches: string
  Wildcard search on release of the target

  Example: 19.14%
• subscriptionType: string
  Default Value: BOTH

  Allowed Values: [ "SUBSCRIBED", "NOT_SUBSCRIBED", "BOTH" ]

  It describes the subscription type
• targetNameMatches: string
  Wildcard search on the target name

  Example: %orcl%
• targetProperties: object targetProperties
  Properties of target
• targetTypes: array targetTypes
  Array of target types

{
    "description":"Filters for targets subscription report",
    "type":"object",
    "properties":{
        "targetTypes":{
            "description":"Array of target types",
            "type":"array",
            "items":{
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "cluster",
                    "has"
                ]
            }
        },
        "targetProperties":{
            "description":"Properties of target",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TargetPropertyFilter"
                }
            ],
            "type":"object"
        },
        "targetNameMatches":{
            "description":"Wildcard search on the target name",
            "type":"string",
            "example":"%orcl%"
        },
        "releaseMatches":{
            "description":"Wildcard search on release of the target",
            "type":"string",
            "example":"19.14%"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"linux_x64_86"
        },
        "subscriptionType":{
            "description":"It describes the subscription type",
            "type":"string",
            "enum":[
                "SUBSCRIBED",
                "NOT_SUBSCRIBED",
                "BOTH"
            ],
            "default":"BOTH"
        }
    }
}

Nested Schema : targetProperties

Type: object

Properties of target

Match All

Properties of target

Show Source

• object TargetPropertyFilter
  Target property filters

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

Nested Schema : targetTypes

Type: array

Array of target types

Show Source

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

{
    "description":"Array of target types",
    "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 properties Filter on Target properties and exclude 'targetsDistribution' Filter subscribed targets and exclude 'targetsDistribution'

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. Subscription report of targets retrieved.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object TargetsSubscriptionReport
  Target subscription details, which are subscribed/not subscribed to gold image

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

Nested Schema : TargetsSubscriptionReport

Type: object

Target subscription details, which are subscribed/not subscribed to gold image

Show Source

• count: number
  Count of targets in the current fetch

  Example: 10
• currentPage: string
  Base 64 encoded current page

  Example: b2Zmc2V0OjA
• items: array items
  Target details
• nextPage: string
  Base 64 encoded next page

  Example: b2Zmc2V0OjA
• previousPage: string
  Base 64 encoded previous page

  Example: b2Zmc2V0OjA
• targetsDistribution: array targetsDistribution
  Statistics of targets grouped by targettype, release and platform
• total: number
  Total count of targets

  Example: 20

{
    "description":"Target subscription details, which are subscribed/not subscribed to gold image",
    "type":"object",
    "properties":{
        "targetsDistribution":{
            "description":"Statistics of targets grouped by targettype, release and platform",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetsDistributionStatistics"
                    }
                ]
            }
        },
        "currentPage":{
            "description":"Base 64 encoded current page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "previousPage":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "total":{
            "description":"Total count of targets",
            "type":"number",
            "example":20
        },
        "count":{
            "description":"Count of targets in the current fetch",
            "type":"number",
            "example":10
        },
        "items":{
            "description":"Target details",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetSubscriptionDetails"
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

Target details

Show Source

• Array of: items

{
    "description":"Target details",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetSubscriptionDetails"
            }
        ]
    }
}

Nested Schema : targetsDistribution

Type: array

Statistics of targets grouped by targettype, release and platform

Show Source

• Array of: items

{
    "description":"Statistics of targets grouped by targettype, release and platform",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetsDistributionStatistics"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object allOf TargetSubscriptionDetails
  Target details

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

Nested Schema : TargetSubscriptionDetails

Type: object

Target details

Show Source

• dbMachineName: string
  DB Machine name

  Example: myDbMachine.oracle.com
• isSubscribed: boolean
  Flag to indicate if target is subscribed

  Example: false

{
    "description":"Target details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetDetails"
        }
    ],
    "properties":{
        "isSubscribed":{
            "description":"Flag to indicate if target is subscribed",
            "type":"boolean",
            "example":false
        },
        "dbMachineName":{
            "description":"DB Machine name",
            "type":"string",
            "example":"myDbMachine.oracle.com"
        }
    }
}

Match All

Target details

Show Source

• object TargetDetails
  details of target

{
    "description":"Target details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetDetails"
        }
    ],
    "properties":{
        "isSubscribed":{
            "description":"Flag to indicate if target is subscribed",
            "type":"boolean",
            "example":false
        },
        "dbMachineName":{
            "description":"DB Machine name",
            "type":"string",
            "example":"myDbMachine.oracle.com"
        }
    }
}

Nested Schema : TargetDetails

Type: object

details of target

Show Source

• clusterName: string
  name of the cluster

  Example: phxem0405c
• dataguardRole: string
  Enum for Data Guard role
• displayName: string
  display name of the target

  Example: sdb2ra00
• hostname: string
  name of the host

  Example: myHostName.mycompany.com
• isCdb: string
  Flag to indicate if the DB is CDB

  Example: true
• platform: string
  Platform of the target

  Example: Linux_AMD64
• release: string
  database release

  Example: 19.14.0.0.0
• targetId: string
  Id of the target

  Example: 09216A9333889316155C3B7DFF9820C7
• targetName: string
  name of the target

  Example: sdb2ra00
• targetStatus: number
  status of the target

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

  type of the target

{
    "description":"details of target",
    "type":"object",
    "properties":{
        "targetId":{
            "description":"Id of the target",
            "type":"string",
            "example":"09216A9333889316155C3B7DFF9820C7"
        },
        "targetName":{
            "description":"name of the target",
            "type":"string",
            "example":"sdb2ra00"
        },
        "targetType":{
            "description":"type of the target",
            "type":"string",
            "enum":[
                "rac_database",
                "oracle_database",
                "cluster",
                "has"
            ]
        },
        "targetStatus":{
            "description":"status of the target",
            "type":"number",
            "example":1
        },
        "displayName":{
            "description":"display name of the target",
            "type":"string",
            "example":"sdb2ra00"
        },
        "dataguardRole":{
            "$ref":"#/components/schemas/DataguardRoleEnum"
        },
        "isCdb":{
            "description":"Flag to indicate if the DB is CDB",
            "type":"string",
            "example":"true"
        },
        "hostname":{
            "description":"name of the host",
            "type":"string",
            "example":"myHostName.mycompany.com"
        },
        "clusterName":{
            "description":"name of the cluster",
            "type":"string",
            "example":"phxem0405c"
        },
        "release":{
            "description":"database release",
            "type":"string",
            "example":"19.14.0.0.0"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"Linux_AMD64"
        }
    }
}

Nested Schema : items

Match All

Show Source

• object TargetsDistributionStatistics
  Statistics of targets based on release and platform

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

Nested Schema : TargetsDistributionStatistics

Type: object

Statistics of targets based on release and platform

Show Source

• count: number
  Count of targets

  Example: 10
• platform: string
  Platform of the target

  Example: linux_x86_64
• release: string
  Database release

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

  Target type

{
    "description":"Statistics of targets based on release and platform",
    "type":"object",
    "properties":{
        "targetType":{
            "description":"Target type",
            "type":"string",
            "enum":[
                "oracle_database",
                "rac_database",
                "has",
                "cluster"
            ]
        },
        "count":{
            "description":"Count of targets",
            "type":"number",
            "example":10
        },
        "release":{
            "description":"Database release",
            "type":"string",
            "example":"19.14.0.0.0"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"linux_x86_64"
        }
    }
}

Examples

Select an example Filter on Target properties Filter on Target properties and exclude 'targetsDistribution' Filter subscribed targets and exclude 'targetsDistribution'

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top