製品ドキュメント

OpsNotesを取得する

最終更新日: 22 年 2020 月 XNUMX 日

LogicMonitorのRESTAPIを使用して、プログラムでOpsNotesを取得できます。 OpsNotesリソースを使用すると、次のことができます。

  1. OpsNotesのリストを取得する
  2. 特定のOpsNoteに関する情報を取得する

すべてのAPI呼び出しと同様に、 認証が必要です.

 

 

OpsNotesのリストを取得する

OpsNotesのリストを返します

 

HTTPメソッド：GET

URI：/ settings / opsnotes

リクエストパラメータ： デフォルトでは、50opsノートのリストが返されます。 リクエストに並べ替え、フィルター、フィールド、サイズ、オフセットのパラメーターを含めて、応答に含まれるデータとそのフォーマット方法を制御できます。 クエリパラメータはリソースパスの一部とは見なされないため、LMv1認証署名の計算に含めるべきではないことに注意してください。

プロパティ

構文

説明

URIの例
sort sort = {+または-} property 昇順（+）または降順（-）のいずれかで指定されたプロパティで応答を並べ替えます / settings / opsnotes？sort = -id
filter filter = property {operator} value 指定された演算子と値に従って応答をフィルタリングします。 *を使用して複数の文字に一致させることができることに注意してください。 タグ、createdBy、happenedOn、monitorObjectGroups、monitorObjectNames、および_allフィールドでフィルタリングでき、複数のフィルターをコンマで区切ることができます。 

演算子は次のとおりです。

  • 以上： >:
  • 以下： <:
  • 大なり記号： >
  • 未満： <
  • 等しくない： !:
  • 等しい： :
  • 以下の構成です: ~
 / settings / opsnotes？filter = note〜upgrade
フィールド fields = {コンマで区切られたプロパティのリスト} 応答をフィルタリングして、各オブジェクトの次のフィールドのみを含めます / settings / opsnotes？fields = note、id
サイズ size = integer 表示する結果の数。 最大は1000です。 / settings / opsnotes？size = 5
オフセット offset = integer 表示された結果を相殺する結果の数 / settings / opsnotes？offset = 2

 

特定のOpsNoteに関する情報を取得する

特定のopsノートの詳細を返します

 

HTTPメソッド：GET

URI：設定/ opsnotes / {id}

リクエストパラメータ： 応答に表示されるフィールドを制御するフィルターパラメーターを含めることができます。

プロパティ

構文

説明

URIの例
フィールド fields = {コンマで区切られたプロパティのリスト} 応答をフィルタリングして、各オブジェクトの次のフィールドのみを含めます / settings / opsnotes / {id}？fields = note、id

 

記事上で