Oracle Enterprise ManagerのREST API

インシデントの注釈のリスト

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/incidents/{incidentId}/annotations

デフォルトでは最も最近の注釈を先頭に示す、インシデントの注釈のリストを返します。

リクエスト

パス・パラメータ

incidentId(必須): string(raw)

インシデントのID

問合せパラメータ

limit: integer(int32)

現在のコールで返されるアイテムの数を制限します。アイテムを追加でフェッチするには、レスポンスからのself/previous/nextリンクを使用します。

デフォルト値: 50
page: string

取得するアイテムのセットを特定します。レスポンスのlinksリストのhref要素により、このパラメータのエンコードされた値が提供されます。href要素の値は、それぞれのアイテム・セットをフェッチする場合はそのまま使用する必要があります。

デフォルト値: Base64エンコード値0 つまり、MA==
sort: string
サポートされているリソース属性(id、message、type、timeCreated、createdByなど)で結果をソートします
例:
```
type:ASC,timeCreated:DESC
```

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

操作成功 - そのインシデントに関連するすべての注釈をフェッチする

ルート・スキーマ: AnnotationCollection

型: object

注釈のリスト

ソースの表示

count: integer (int32)

戻される行の数

例: 1
items(必須): array items

注釈サマリーのリスト
links: object links

読取り専用: true

ページ分割されたリソースへのURLリンク。

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of rows returned",
            "format":"int32",
            "example":"1"
        },
        "links":{
            "required":[
                "self"
            ],
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"URL links to paginated resource(s).",
            "readOnly":true,
            "example":{
                "self":{
                    "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MQ%3D%3D&limit=50"
                },
                "next":{
                    "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=Mg%3D%3D&limit=50"
                },
                "previous":{
                    "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MA%3D%3D&limit=50"
                }
            }
        },
        "items":{
            "type":"array",
            "description":"List of the annotation summary",
            "items":{
                "$ref":"#/components/schemas/AnnotationSummary"
            }
        }
    },
    "description":"List of annotations"
}

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

型: array

注釈サマリーのリスト

ソースの表示

配列: object AnnotationSummary

注釈の詳細

{
    "type":"array",
    "description":"List of the annotation summary",
    "items":{
        "$ref":"#/components/schemas/AnnotationSummary"
    }
}

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

型: object

読取り専用: true

ページ分割されたリソースへのURLリンク。

ソースの表示

next: object Link

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

リンクを表します(self、previous、nextのいずれか)
self(必須): object Link

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

{
    "required":[
        "self"
    ],
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"URL links to paginated resource(s).",
    "readOnly":true,
    "example":{
        "self":{
            "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MQ%3D%3D&limit=50"
        },
        "next":{
            "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=Mg%3D%3D&limit=50"
        },
        "previous":{
            "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MA%3D%3D&limit=50"
        }
    }
}

例:

{
    "self":{
        "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MQ%3D%3D&limit=50"
    },
    "next":{
        "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=Mg%3D%3D&limit=50"
    },
    "previous":{
        "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MA%3D%3D&limit=50"
    }
}

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

型: object

注釈の詳細

ソースの表示

createdBy: string

読取り専用: true

注釈の作成者 - ユーザーまたはSYSTEM

例: SYSMAN
id: string

読取り専用: true

現在のオブジェクトのコンテキストにおける、注釈の一意の識別子

例: 131
message(必須): string

最小長: 1

最大長: 4000

注釈のテキスト

例: 根本にある問題が解決されたため抑止が削除されましたSuppression removed as the underlying issue resolved
timeCreated: string (datetime)

読取り専用: true

注釈が作成された時間

例: 2021-07-21T06:25:43.000Z
type(必須): string

指定可能な値: [ "USER_COMMENT", "NOTIFICATION", "SYSTEM" ]

注釈タイプ

例: USER_COMMENT

{
    "required":[
        "message",
        "type"
    ],
    "type":"object",
    "properties":{
        "message":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string",
            "description":"Text for the annotation",
            "example":"Suppression removed as the underlying issue resolved"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of the annotation in context of the current object",
            "readOnly":true,
            "example":"131"
        },
        "type":{
            "type":"string",
            "description":"Annotation type",
            "example":"USER_COMMENT",
            "enum":[
                "USER_COMMENT",
                "NOTIFICATION",
                "SYSTEM"
            ]
        },
        "timeCreated":{
            "type":"string",
            "description":"Time when the annotation is created",
            "format":"datetime",
            "readOnly":true,
            "example":"2021-07-21T06:25:43.000Z"
        },
        "createdBy":{
            "type":"string",
            "description":"Creator of the annotation - User or SYSTEM",
            "readOnly":true,
            "example":"SYSMAN"
        }
    },
    "description":"Details of an annotation"
}

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

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

404レスポンス

見つかりません

ルート・スキーマ: 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"
        }
    }
}

先頭に戻る