Jump to

• Request
• Response

List targets

get

https://EM_HOST:8080/em/api/targets

This api returns a list of targets filtered with the given criteria.

Request

Query Parameters

• displayName: array[string]
  display name of the target
• displayNameMatches: array[string]
  display name pattern of the target
• exclude: string
  an excludeId with comma-separated list of bind variables. This uses a registered sql query to exclude targets from the result set. This is supporting EM console UI.

  Example:

  notThisTypeExcludeId,host

• include: string
  a comma-separated list which indicates if status or total number of results shall be returned. Valid values are targetStatus and total.

  Example:

  targetStatus,total

• limit: integer(int32)
  Minimum Value: 1

  Maximum Value: 2000

  To limit the number of rows returned. If the result set is greater, follow the previous and next links in the results.

  Example:

  20

• name: array[string]
  name of the target
• nameMatches: array[string]
  name pattern of the target

  Example:

  my_target_%

• owner: array[string]
  owner of the target
• page: string
  System generated page token used in the self, next and previous links.
• sort: string
  A comma-separated list of sort field and direction. Allowed sort fields are name, type, displayName, typeDisplayName, owner and status. Allowed directions are DESC and ASC

  Example:

  type:ASC,name:DESC

• status: array[]
  the status of the target
• typeDisplayName: array[string]
  type display name in the client locale
• typeDisplayNameMatches: array[string]
  type display name pattern in the client locale
• typeName: array[string]
  type of the target
• typeNameMatches: array[string]
  type pattern

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : TargetCollection

Type: object

This is the representation of list of target summaries.

Show Source

• count(required): integer
  Number of targets in this page.

  Example: 1
• items(required): array items
  Target summaries.
• links(required): object links
  Result set navigation links.

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of list of target summaries.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of targets in this page.",
            "example":"1"
        },
        "items":{
            "type":"array",
            "description":"Target summaries.",
            "items":{
                "$ref":"#/components/schemas/TargetSummary"
            }
        },
        "links":{
            "type":"object",
            "description":"Result set navigation links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the current page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the previous page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the next page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Target summaries.

Show Source

• Array of: object TargetSummary
  Summary information about a target.

{
    "type":"array",
    "description":"Target summaries.",
    "items":{
        "$ref":"#/components/schemas/TargetSummary"
    }
}

Nested Schema : links

Type: object

Result set navigation links.

Show Source

• next: next
• previous: previous
• self: self

{
    "type":"object",
    "description":"Result set navigation links.",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the current page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the previous page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THE_PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the next page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

Nested Schema : TargetSummary

Type: object

Summary information about a target.

Show Source

• displayName(required): string
  Display of the target

  Example: My Database Instance
• id(required): string
  Target ID

  Example: D91786E288D35455C3ADA1B329B49BB5
• links: object links
  Target related links
• name(required): string
  Target Name

  Example: my_database
• owner(required): string
  Owner of the target

  Example: SYSMAN
• status: string
  Allowed Values: [ "DOWN", "UP", "METRIC_ERROR", "AGENT_DOWN", "UNREACHABLE", "BLACKOUT", "PENDING", "REMOTE_HOST_UNREACHABLE" ]

  This is the representation of a target status.

  Example: UP
• statusDisplayName: string
  Localized status

  Example: Hochgefahren
• statusIconPath: string
  Path to the status icon which is used in UI

  Example: /sdk/core/uifwk/images/status/stat_arrowup_16.png
• typeDisplayName(required): string
  Localized type display name of the target

  Example: Datenbankinstanz
• typeName(required): string
  Target Type Name

  Example: oracle_database

{
    "x-em-sdk-level":"emSDK",
    "description":"Summary information about a target.",
    "type":"object",
    "required":[
        "typeName",
        "name",
        "id",
        "displayName",
        "typeDisplayName",
        "owner"
    ],
    "properties":{
        "typeName":{
            "type":"string",
            "description":"Target Type Name",
            "example":"oracle_database"
        },
        "name":{
            "type":"string",
            "description":"Target Name",
            "example":"my_database"
        },
        "id":{
            "type":"string",
            "description":"Target ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "displayName":{
            "type":"string",
            "description":"Display of the target",
            "example":"My Database Instance"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Localized type display name of the target",
            "example":"Datenbankinstanz"
        },
        "owner":{
            "type":"string",
            "description":"Owner of the target",
            "example":"SYSMAN"
        },
        "status":{
            "$ref":"#/components/schemas/TargetStatus"
        },
        "statusDisplayName":{
            "type":"string",
            "description":"Localized status",
            "example":"Hochgefahren"
        },
        "statusIconPath":{
            "type":"string",
            "description":"Path to the status icon which is used in UI",
            "example":"/sdk/core/uifwk/images/status/stat_arrowup_16.png"
        },
        "links":{
            "type":"object",
            "description":"Target related links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the target"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Target related links

Show Source

• self: self

{
    "type":"object",
    "description":"Target related links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the target"
                },
                {
                    "example":{
                        "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5"
                    }
                }
            ]
        }
    }
}

Nested Schema : self

Match All

Link to the target

Show Source

• object Link
  A link referencing a REST API.
• Link to the target
• Example: { "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the target"
        },
        {
            "example":{
                "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5"
            }
        }
    ]
}

Nested Schema : Link

Type: object

A link referencing a REST API.

Show Source

• href: string
  Link URL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

Nested Schema : next

Match All

Link to the next page in the result set.

Show Source

• object Link
  A link referencing a REST API.
• Link to the next page in the result set.
• Example: { "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THE_NEXT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the next page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THE_NEXT_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : previous

Match All

Link to the previous page in the result set.

Show Source

• object Link
  A link referencing a REST API.
• Link to the previous page in the result set.
• Example: { "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THE_PREVIOUS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the previous page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THE_PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : self

Match All

Link to the current page in the result set.

Show Source

• object Link
  A link referencing a REST API.
• Link to the current page in the result set.
• Example: { "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THIS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the current page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackouts/BLACKOUT_ID/targets?page=THIS_PAGE_TOKEN"
            }
        }
    ]
}

400 Response

in the case of illegal arguments like unsupported sort direction

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

Client is not authenticated.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal error serving the request.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

Indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top