Oracle Enterprise ManagerのREST API

パブリック配信不可: 2025-05-14

ブラックアウト理由のリスト

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/reasons

このAPIは、既知の事前定義済ブラックアウト理由およびユーザー定義ブラックアウト理由のリストを返します。事前定義済のブラックアウト理由の場合は、ローカライズされた表示名もあります。ユーザー定義の理由の場合、表示名は理由と同じです。

リクエスト

問合せパラメータ

id: integer
指定されたIDでのフィルタ
例:
```
23
```
limit: integer(int32)
最小値: 1

最大値: 2000

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

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

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: BlackoutReasonCollection

型: object

ブラックアウト理由のコレクション。

ソースの表示

count(必須): integer

このページ内のアイテムの数

例: 1
items(必須): array items

ブラックアウト理由
links(必須): object links

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

このリクエストでのアイテムの合計数。これはリクエストに明示的に含める必要があります。

{
    "x-em-sdk-level":"emSDK",
    "description":"Collection of blackout reasons.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of items in this page.",
            "example":1
        },
        "total":{
            "type":"integer",
            "description":"Total number of items in this request. This has to be explicitly included in the request."
        },
        "items":{
            "type":"array",
            "description":"blackout reasons",
            "items":{
                "$ref":"#/components/schemas/BlackoutReasonSummary"
            }
        },
        "links":{
            "type":"object",
            "description":"Result set navigation links.",
            "required":[
                "self"
            ],
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the current page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackoutReasons?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the previous page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackoutReasons?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/blackoutReasons?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

型: array

ブラックアウト理由

ソースの表示

配列: object BlackoutReasonSummary

単一のブラックアウト理由。

{
    "type":"array",
    "description":"blackout reasons",
    "items":{
        "$ref":"#/components/schemas/BlackoutReasonSummary"
    }
}

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

型: object

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

ソースの表示

next: next
previous: previous
self(必須): self

{
    "type":"object",
    "description":"Result set navigation links.",
    "required":[
        "self"
    ],
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the current page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackoutReasons?page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the previous page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackoutReasons?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/blackoutReasons?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

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

型: object

単一のブラックアウト理由。

すべてに一致

単一のブラックアウト理由。

ソースの表示

object allOf BlackoutReason

単一のブラックアウト理由。

{
    "x-em-sdk-level":"emSDK",
    "description":"A single blackout reason.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BlackoutReason"
        }
    ]
}

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

型: object

単一のブラックアウト理由。

ソースの表示

reasonDisplayName: string

ローカライズされた事前定義済理由、またはユーザーが指定したユーザー定義理由。

{
    "x-em-sdk-level":"emSDK",
    "description":"A single blackout reason.",
    "type":"object",
    "properties":{
        "reasonDisplayName":{
            "type":"string",
            "description":"Localized predefined reason or the user defined reason as provided by the user."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ReasonId"
        },
        {
            "$ref":"#/components/schemas/Reason"
        }
    ]
}

すべてに一致

単一のブラックアウト理由。

ソースの表示

object ReasonId

ブラックアウトの理由ID。
object Reason

ブラックアウトの理由。

{
    "x-em-sdk-level":"emSDK",
    "description":"A single blackout reason.",
    "type":"object",
    "properties":{
        "reasonDisplayName":{
            "type":"string",
            "description":"Localized predefined reason or the user defined reason as provided by the user."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ReasonId"
        },
        {
            "$ref":"#/components/schemas/Reason"
        }
    ]
}

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

型: object

ブラックアウトの理由ID。

ソースの表示

id: string

ブラックアウトの理由ID。

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Reason id of a blackout.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Reason id of a blackout."
        }
    }
}

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

型: object

ブラックアウトの理由。

ソースの表示

reason: string

英語での事前定義済理由、またはユーザー定義理由。

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Reason of a blackout.",
    "properties":{
        "reason":{
            "type":"string",
            "description":"Predefined reason in English or a user defined reason."
        }
    }
}

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

すべてに一致

結果セット内の次ページへのリンク。

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の次ページへのリンク。
例: { "href":"/em/api/blackoutReasons?page=THE_NEXT_PAGE_TOKEN" }

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

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

すべてに一致

結果セット内の前ページへのリンク。

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の前ページへのリンク。
例: { "href":"/em/api/blackoutReasons?page=THE_PREVIOUS_PAGE_TOKEN" }

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

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

すべてに一致

結果セット内の現在のページへのリンク。

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の現在のページへのリンク。
例: { "href":"/em/api/blackoutReasons?page=THIS_PAGE_TOKEN" }

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

ネストされたスキーマ: 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"
        }
    }
}

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

先頭に戻る