Oracle Enterprise ManagerのREST API

グローバル・ターゲット・プロパティのリスト

get

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

このAPIは、指定された基準でフィルタ処理して、グローバル・ターゲット・プロパティのリストを返します。

リクエスト

問合せパラメータ

limit: integer(int32)
最小値: 1

最大値: 2000

返される行の数を制限するため。結果セットがそれより大きい場合は、結果内のpreviousリンクとnextリンクに従います。
例:
```
20
```
name: array[string]

ターゲット・プロパティの名前
nameMatches: array[string]
ターゲット・プロパティの名前パターン
例:
```
my_property_*
```
page: string

self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。
sort: string
ソート・フィールドおよびソート方向。指定可能なソート・フィールドはid、name、displayNameです。指定可能な方向はDESCとASCです
例:
```
name:ASC
```

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

ルート・スキーマ: GlobalTargetPropertyCollection

型: object

これはターゲット参照のリストを表すものです。

ソースの表示

count(必須): integer

このページにあるアイテムの数

例: 20
items(必須): array items

ターゲット参照
links(必須): object links

結果セットのナビゲーション・リンク
total: integer

結果の合計数

例: 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"
                            }
                        }
                    ]
                }
            }
        }
    }
}

ネストされたスキーマ: items

型: array

ターゲット参照

ソースの表示

配列: object GlobalTargetPropertySummary

これはターゲット参照です。

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

ネストされたスキーマ: links

型: object

結果セットのナビゲーション・リンク

ソースの表示

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

ネストされたスキーマ: GlobalTargetPropertySummary

型: object

これはターゲット参照です。

ソースの表示

displayName(必須): string

クライアント・ロケールでのプロパティ表示名

例: Location
id(必須): string

ターゲット・プロパティID

例: orcl_gtp_location
links: object links

ターゲット関連リンク
name(必須): string

ターゲット・プロパティ名

例: 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"
                            }
                        }
                    ]
                }
            }
        }
    }
}

ネストされたスキーマ: links

型: object

ターゲット関連リンク

ソースの表示

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

ネストされたスキーマ: self

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
ターゲットへのリンク
例: { "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"
            }
        }
    ]
}

ネストされたスキーマ: Link

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

href: string

リンクのためのURL

例: /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"
        }
    }
}

ネストされたスキーマ: next

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の次ページへのリンク
例: { "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"
            }
        }
    ]
}

ネストされたスキーマ: previous

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の前ページへのリンク
例: { "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"
            }
        }
    ]
}

ネストされたスキーマ: self

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の現在のページへのリンク
例: { "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レスポンス

サポートされていないソート方向など、無効な引数の場合

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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レスポンス

クライアントが認証されていません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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レスポンス

リクエスト処理中の内部エラー

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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レスポンス

必要なサービスが使用不可であることを示しています。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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"
        }
    }
}

先頭に戻る