Jump to

• Request
• Response

Get Target Subscription

post

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

Gets the image information of which the specified target is subscribed to.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match All

Show Source

• object schema
  Target details

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

Nested Schema : schema

Type: object

Target details

Show Source

• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Type of the target

  Example: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

Examples

Select an example Payload

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. Target subscription details retrieved.

Body ()

Root Schema : DatabaseGoldImageTargetSubscription

Type: object

Target subscription input

Show Source

• imageId: string
  ID of the image

  Example: 4B7738536B6E7888E053057FB10ACF8C
• imageName: string
  Name of the image

  Example: FM_DB19_14_image
• parentId: string
  ID of the parent

  Example: 01DB50F6963F0E39C72F8651DCC93A6A
• targetId: string
  ID of the target

  Example: 4B620EC24DCE61FAE053057FB10AC7D0
• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Target type
• timeSubscribed: string (date-time)
  Subscription time

  Example: 2022-01-13 15:52:28.0

{
    "type":"object",
    "description":"Target subscription input",
    "properties":{
        "targetId":{
            "description":"ID of the target",
            "type":"string",
            "example":"4B620EC24DCE61FAE053057FB10AC7D0"
        },
        "targetName":{
            "type":"string",
            "description":"Name of the target",
            "example":"sales_db1"
        },
        "targetType":{
            "type":"string",
            "description":"Target type"
        },
        "imageId":{
            "description":"ID of the image",
            "type":"string",
            "example":"4B7738536B6E7888E053057FB10ACF8C"
        },
        "imageName":{
            "description":"Name of the image",
            "type":"string",
            "example":"FM_DB19_14_image"
        },
        "timeSubscribed":{
            "description":"Subscription time",
            "type":"string",
            "format":"date-time",
            "example":"2022-01-13 15:52:28.0"
        },
        "parentId":{
            "description":"ID of the parent",
            "type":"string",
            "example":"01DB50F6963F0E39C72F8651DCC93A6A"
        }
    }
}

Examples

Select an example Payload

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