1. index
  2. 監視
  3. 設定
  4. コマンド
  5. その他

externallinkgroup オブジェクト

externallinkgroupオブジェクトは、X-MONの外部リンク設定を操作するオブジェクトです。

externallinkgroup.add外部リンクグループの新規作成

externallinkgroup.addは、外部リンクグループを新規作成するためのメソッドです。

対応X-MONバージョン
  • 3.5.0 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

リクエストパラメータ

カラム名称 概要
title 必須 string

外部リンクグループ名称を指定します。

edit_style 必須 integer

外部リンクグループ内のリンクの編集権限を指定します。

1
管理者と責任者のみ
2
管理者と責任者、オペレータ
3
管理者と責任者、指定されたオペレータ
user_group array

edit_styleに3を指定した場合、編集を許可するオペレータが所属するユーザグループIDを指定します。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

externallinkgroup.delete外部リンクグループの削除

externallinkgroup.deleteは、外部リンクグループを削除するためのメソッドです。

対応X-MONバージョン
  • 3.5.0 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

リクエストパラメータ

カラム名称 概要
id 必須 string

外部リンクグループIDを指定します。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

externallinkgroup.get外部リンクグループ設定の取得

externallinkgroup.getは、外部リンクグループ設定を取得するためのメソッドです。

対応X-MONバージョン
  • 3.5.0 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

リクエストパラメータ

カラム名称 概要
id string

外部リンクグループIDを指定します。

edit_style integer

外部リンクグループ内のリンクの編集権限を指定します。

1
管理者と責任者のみ
2
管理者と責任者、オペレータ
3
管理者と責任者、指定されたオペレータ
title string

外部リンクグループ名称を指定します。

link_title string

外部リンクグループ内のリンクのタイトルを指定します。

url string

外部リンクグループ内のリンクのURLを指定します。

sort string

ソートの対象を指定します。

id
外部リンクグループIDによる並べ替え
title
外部リンクグループ名称による並べ替え
edit_style
外部リンクグループ内のリンクの編集権限による並べ替え
create_date
外部リンクグループの作成日時による並べ替え
update_date
外部リンクグループの更新日時による並べ替え

省略時は、create_dateが指定されます。

ascdesc string

ソートの順序を指定します。

asc
結果を昇順で取得します。
desc
結果を降順で取得します。

省略時は、descが指定されます。

レスポンスカラム

カラム名称 概要
id string

外部リンクグループID

title string

外部リンクグループ名称

edit_style integer

外部リンクグループ内のリンクの編集権限

1
管理者と責任者のみ
2
管理者と責任者、オペレータ
3
管理者と責任者、指定されたオペレータ
create_date string

外部リンクグループの作成日時

update_date string

外部リンクグループの更新日時

link array

外部リンクグループ内のリンク情報

contact_group string

編集を許可するオペレータが所属するユーザグループ

externallinkgroup.update外部リンクグループの更新

externallinkgroup.updateは、既存の外部リンクグループを編集するためのメソッドです。

対応X-MONバージョン
  • 3.5.0 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

リクエストパラメータ

カラム名称 概要
id 必須 string

リンクグループIDをを指定します。

title 必須 string

外部リンクグループ名称を指定します。

edit_style 必須 integer

外部リンクグループ内のリンクの編集権限を指定します。

1
管理者と責任者のみ
2
管理者と責任者、オペレータ
3
管理者と責任者、指定されたオペレータ
user_group array

edit_styleに3を指定した場合、編集を許可するオペレータが所属するユーザグループIDを指定します。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。