externallinkオブジェクトは、X-MONの外部リンク設定内のリンクを操作するオブジェクトです。
外部リンク設定の操作はexternallinkgroupオブジェクトから行うことができます。
externallink.addは、外部リンク設定内のリンクを新規作成するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、権限を与えられているグループに所属するリンク情報のみ操作を行えます。
| カラム名称 | 型 | 概要 |
|---|---|---|
| title 必須 | string |
リンクのタイトルを指定します。 |
| url 必須 | string |
リンクのURLを指定します。 |
| group_id 必須 | string |
対象外部リンクグループIDを指定します。 |
このメソッドは、実行結果が boolean型で返ってきます。
externallink.deleteは、外部リンク設定内のリンクを削除するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、権限を与えられているグループに所属するリンク情報のみ操作を行えます。
| カラム名称 | 型 | 概要 |
|---|---|---|
| id 必須 | string |
リンクIDを指定します。 |
このメソッドは、実行結果が boolean型で返ってきます。
externallink.getは、外部リンク設定内のリンクを取得するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
このメソッドにはパラメータは不要です。
| カラム名称 | 型 | 概要 |
|---|---|---|
| id | string |
リンクID |
| title | string |
リンクタイトル |
| url | string |
リンクのURL |
| sort | integer |
リンクの並び順 |
| group_id | string |
外部リンクグループID |
externallink.updateは、外部リンク設定内のリンクを編集するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、権限を与えられているグループに所属するリンク情報のみ操作を行えます。
| カラム名称 | 型 | 概要 |
|---|---|---|
| id 必須 | string |
リンクIDを指定します。 |
| title 必須 | string |
リンクのタイトルを指定します。 |
| url 必須 | string |
リンクのURLを指定します。 |
| group_id 必須 | string |
対象外部リンクグループIDを指定します。 |
このメソッドは、実行結果が boolean型で返ってきます。