Jump to

• Request
• Response

Subscribe Targets to an Image

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/actions/subscribeTargets

Subscribes targets to an image. Targets can be of the same release (for patching purposes) or can be of a lower release from which a direct upgrade path is available.

Request

Path Parameters

• goldImageId(required): string
  ID of the image

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match All

Show Source

• object allOf SubscribeTargetsDetails
  Details of subscription of targets

{
    "type":"object",
    "required":[
        "targetList",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/SubscribeTargetsDetails"
        }
    ]
}

Nested Schema : SubscribeTargetsDetails

Type: object

Details of subscription of targets

Match All

Details of subscription of targets

Details of subscription of targets

Show Source

• object TargetList
  List of targets
• object SubscribeTargetCommonDetails
  Common details for subscription of a target to the image

{
    "description":"Details of subscription of targets",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/SubscribeTargetCommonDetails"
        }
    ]
}

Nested Schema : TargetList

Type: object

List of targets

Show Source

• targetList: array targetList
  Array of target names
• targetType: string
  Target type

  Example: oracle_database

{
    "description":"List of targets",
    "type":"object",
    "properties":{
        "targetList":{
            "description":"Array of target names",
            "type":"array",
            "items":{
                "type":"string",
                "example":"db1, db2"
            }
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

Nested Schema : SubscribeTargetCommonDetails

Type: object

Common details for subscription of a target to the image

Show Source

• isGimr: boolean
  GIMR Flag
• isNoCascade: boolean
  Default Value: false

  Flag to indicate the subscription of PDBs in a CDB
• isStandbyAutoSubscribe: boolean
  Default Value: true

  Flag to indicate the auto subscription of a standby database

{
    "description":"Common details for subscription of a target to the image",
    "type":"object",
    "properties":{
        "isStandbyAutoSubscribe":{
            "description":"Flag to indicate the auto subscription of a standby database",
            "type":"boolean",
            "default":true
        },
        "isNoCascade":{
            "description":"Flag to indicate the subscription of PDBs in a CDB",
            "type":"boolean",
            "default":false
        },
        "isGimr":{
            "description":"GIMR Flag",
            "type":"boolean"
        }
    }
}

Nested Schema : targetList

Type: array

Array of target names

Show Source

• Array of: string
  Example: db1, db2

{
    "description":"Array of target names",
    "type":"array",
    "items":{
        "type":"string",
        "example":"db1, db2"
    }
}

Examples

Select an example Payload

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. Targets subscribed.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object allOf GoldImageSubscribeTargets
  Targets subscription response

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

Nested Schema : GoldImageSubscribeTargets

Type: object

Targets subscription response

Match All

Targets subscription response

Show Source

• object GoldImageTargetsSubscriptionSummary
  Targets subscription details

{
    "description":"Targets subscription response",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageTargetsSubscriptionSummary"
        }
    ]
}

Nested Schema : GoldImageTargetsSubscriptionSummary

Type: object

Targets subscription details

Show Source

• failed: integer
  Count of Failed targets
• items: array items
  List of subscription summary
• successful: integer
  Count of Successful targets
• total: integer
  Count of Total targets

{
    "description":"Targets subscription details",
    "type":"object",
    "properties":{
        "failed":{
            "description":"Count of Failed targets",
            "type":"integer"
        },
        "successful":{
            "description":"Count of Successful targets",
            "type":"integer"
        },
        "total":{
            "description":"Count of Total targets",
            "type":"integer"
        },
        "items":{
            "description":"List of subscription summary",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubscriptionSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of subscription summary

Show Source

• Array of: object SubscriptionSummary
  Target subscription summary

{
    "description":"List of subscription summary",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubscriptionSummary"
    }
}

Nested Schema : SubscriptionSummary

Type: object

Target subscription summary

Show Source

• code: integer
  HTTP status code
• message: string
  Message of subscription
• targetId: string
  ID of the target

  Example: 01DB50F6963F0E39C72F8651DCC93A6A
• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Target type

  Example: oracle_database

{
    "description":"Target subscription summary",
    "type":"object",
    "properties":{
        "code":{
            "description":"HTTP status code",
            "type":"integer"
        },
        "targetId":{
            "description":"ID of the target",
            "type":"string",
            "example":"01DB50F6963F0E39C72F8651DCC93A6A"
        },
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        },
        "message":{
            "description":"Message of subscription",
            "type":"string"
        }
    }
}

Examples

Select an example Payload

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