Jump to

• Request
• Response

List Targets Subscribed to Image

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/targets

Lists targets subscribed to image

Request

Path Parameters

• goldImageId(required): string
  ID of the image

Query Parameters

• limit: integer(int32)
  Limit count of the items in the response

  Example:

  10

• page: string
  Marker indicating the next set (page) of items

  Example:

  b2Zmc2V0OjA

• sort: string
  Comma separated list of fields along with an optional sort direction. The supported attributes of sorting are 'targetName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.

  Example:

  targetName:asc

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. Image subscription details retrieved.

Body ()

Root Schema : GoldImageTargetCollection

Type: object

Image subscription response

Show Source

• items(required): array items
  List of the image subscription summary

{
    "type":"object",
    "description":"Image subscription response",
    "required":[
        "items"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        }
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of the image subscription summary",
            "items":{
                "$ref":"#/components/schemas/ImageSubscriptionSummary"
            }
        }
    }
}

Match All

Image subscription response

Show Source

• object Pagination
  Collection of items with links

{
    "type":"object",
    "description":"Image subscription response",
    "required":[
        "items"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        }
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of the image subscription summary",
            "items":{
                "$ref":"#/components/schemas/ImageSubscriptionSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of the image subscription summary

Show Source

• Array of: object ImageSubscriptionSummary
  Image subscription summary

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

Nested Schema : Pagination

Type: object

Collection of items with links

Show Source

• count: integer
  Count of this fetch

  Example: 40
• links: object Links
  Represents the array of links
• total: integer
  total count

  Example: 40

{
    "description":"Collection of items with links",
    "properties":{
        "total":{
            "type":"integer",
            "description":"total count",
            "example":40
        },
        "count":{
            "type":"integer",
            "description":"Count of this fetch",
            "example":40
        },
        "links":{
            "$ref":"#/components/schemas/Links"
        }
    }
}

Nested Schema : ImageSubscriptionSummary

Type: object

Image subscription summary

Show Source

• imageId: string
  ID of the image

  Example: 4B7738536B6E7888E053057FB10ACF8C
• parentId: string
  ID of the parent target

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

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

  Example: sales_db1
• targetType: string
  Target type

  Example: oracle_database
• timeSubscribed: string (date-time)
  Time of subscription

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

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

Nested Schema : Links

Type: object

Represents the array of links

Show Source

• next: object Link
  A link
• previous: object Link
  A link
• self: object Link
  A link

{
    "description":"Represents the array of links",
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : Link

Type: object

A link

Show Source

• href: string
  URL for link.

{
    "description":"A link",
    "type":"object",
    "properties":{
        "href":{
            "description":"URL for link.",
            "type":"string"
        }
    }
}

Examples

Select an example Payload

400 Response

Bad Request.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

401 Response

Unauthorized.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

403 Response

Forbidden.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

404 Response

Not Found.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

500 Response

Internal Server Error.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

503 Response

Service Unavailable

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

Back to Top