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 references.

Show Source

• count(required): integer
  the number of items in this page

  Example: 20
• items(required): array items
  the target references
• links(required): object links
  the result set navigation links
• total: integer
  the total number of results

  Example: 42

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of list of target references.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of items in this page",
            "example":20
        },
        "total":{
            "type":"integer",
            "description":"the total number of results",
            "example":42
        },
        "items":{
            "type":"array",
            "description":"the target references",
            "items":{
                "$ref":"#/components/schemas/TargetSummary"
            }
        },
        "links":{
            "type":"object",
            "description":"the result set navigation links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the curent page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the previous page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets?page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the next page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : items

Type: array

the target references

Show Source

• Array of: object TargetSummary
  This is a target reference.

{
    "type":"array",
    "description":"the target references",
    "items":{
        "$ref":"#/components/schemas/TargetSummary"
    }
}

Nested Schema : links

Type: object

the result set navigation links

Show Source

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

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

Nested Schema : TargetSummary

Type: object

This is a target reference.

Show Source

• displayName(required): string
  the display of the target

  Example: My Database Instance
• id(required): string
  the target if

  Example: D91786E288D35455C3ADA1B329B49BB5
• links: object links
  the target related links
• name(required): string
  the target name

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

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

  This is the representation of a target status.
• typeDisplayName(required): string
  the type display name of the target

  Example: Datenbankinstanz
• typeName: string
  the target type name

  Example: oracle_database

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a target reference.",
    "type":"object",
    "required":[
        "type",
        "name",
        "id",
        "displayName",
        "typeDisplayName",
        "owner"
    ],
    "properties":{
        "typeName":{
            "type":"string",
            "description":"the target type name",
            "example":"oracle_database"
        },
        "name":{
            "type":"string",
            "description":"the target name",
            "example":"my_database"
        },
        "id":{
            "type":"string",
            "description":"the target if",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "displayName":{
            "type":"string",
            "description":"the display of the target",
            "example":"My Database Instance"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"the type display name of the target",
            "example":"Datenbankinstanz"
        },
        "owner":{
            "type":"string",
            "description":"the owner of the target",
            "example":"scott"
        },
        "status":{
            "$ref":"#/components/schemas/TargetStatus"
        },
        "links":{
            "type":"object",
            "description":"the target related links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the target"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : links

Type: object

the target related links

Show Source

• self: self

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

Nested Schema : self

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• The link to the target
• Example: { "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5" }

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

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Nested Schema : next

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• The link to the next page in the result set
• Example: { "href":"/em/api/targets?page=THE_NEXT_PAGE_TOKEN" }

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

Nested Schema : previous

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• The link to the previous page in the result set
• Example: { "href":"/em/api/targets?page=THE_PREVIOUS_PAGE_TOKEN" }

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

Nested Schema : self

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• The link to the curent page in the result set
• Example: { "href":"/em/api/targets?page=THIS_PAGE_TOKEN" }

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

400 Response

in the case of illegal arguments like unsupported sort direction

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

client is not authenticated

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 error serving 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"
        }
    }
}

503 Response

indicates that a required service is not available.

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