REST API for Oracle Enterprise Manager

List global target propertiess

get

https://EM_HOST:8080/em/api/globalTargetProperties

This api returns a list of global target properties filtered with the given criteria.

Request

Query Parameters

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 property
nameMatches: array[string]
name pattern of the target property
Example:
```
my_property_*
```
page: string

System generated page token used in the self, next and previous links.
sort: string
The sort field and the sort direction. Allowed sort fields are id, name, displayName. Allowed directions are DESC and ASC
Example:
```
name:ASC
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : GlobalTargetPropertyCollection

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/GlobalTargetPropertySummary"
            }
        },
        "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/targetProperties?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/targetProperties?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/targetProperties?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : items

Type: array

the target references

Show Source

Array of: object GlobalTargetPropertySummary

This is a target reference.

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

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/targetProperties?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/targetProperties?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/targetProperties?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

Nested Schema : GlobalTargetPropertySummary

Type: object

This is a target reference.

Show Source

displayName(required): string

the property display name in the client locale

Example: Location
id(required): string

the target property id

Example: orcl_gtp_location
links: object links

the target related links
name(required): string

the target property name

Example: Location

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a target reference.",
    "type":"object",
    "required":[
        "id",
        "name",
        "displayName"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"the target property id",
            "example":"orcl_gtp_location"
        },
        "name":{
            "type":"string",
            "description":"the target property name",
            "example":"Location"
        },
        "displayName":{
            "type":"string",
            "description":"the property display name in the client locale",
            "example":"Location"
        },
        "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/targetProperties/orcl_gtp_location"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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/targetProperties/orcl_gtp_location"
                    }
                }
            ]
        }
    }
}

Nested Schema : self

Match All

The link to the target

Show Source

object Link

A link referencing a REST API.
The link to the target
Example: { "href":"/em/api/targetProperties/orcl_gtp_location" }

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

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

The link to the next page in the result set

Show Source

object Link

A link referencing a REST API.
The link to the next page in the result set
Example: { "href":"/em/api/targetProperties?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/targetProperties?page=THE_NEXT_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : previous

Match All

The link to the previous page in the result set

Show Source

object Link

A link referencing a REST API.
The link to the previous page in the result set
Example: { "href":"/em/api/targetProperties?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/targetProperties?page=THE_PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : self

Match All

The link to the curent page in the result set

Show Source

object Link

A link referencing a REST API.
The link to the curent page in the result set
Example: { "href":"/em/api/targetProperties?page=THIS_PAGE_TOKEN" }

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

400 Response

in the case of illegal arguments like unsupported sort direction

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.

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.

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.

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