【API】 ユーザー 画面にカスタム列を作成する

  • 更新

Learn365では、Learn365 管理センター、または Learn365 API を通じて、ユーザー 画面に独自の列(カスタム列)を追加することができます。

ここでは、Learn365 API を通じて新しいカスタム列を作成する手順を説明します。

注記:

カスタム同期は、各列ごとに個別に有効化できます。

特定の列でカスタム同期を有効にすると、その列については Microsoft Entra ID からのデータ同期は行われなくなりますが、API を使用して、独自のデータソースからそのフィールドにデータを設定することができます。

カスタム列とシステム列の情報を更新する方法については、こちらをご参照ください。

 

手順:

1.https://api.365.systems/  にアクセスし、API  キーで認証します。

2.UserFields セクションに移動し、POST /odata/v2/UserFields Creates new user field を選択し、右上の[Try it out]をクリックします。

Create custom columns-1.png

 

3.パラメータを入力します。

userField:「Edit Value」フィールドで、以下の必須のパラメータを入力します。

  • "Title": "string":列の名前を入力します。「string」を任意の列の名前に置き換えます。
  • "Description": "string":列の説明。「string」を列の説明文に置き換えます。
  • Type": "integer" : 列に入るデータの型を指定します。既定のデータ型は「String(文字列)」です。その他、Boolean(Yes/ No)、number(数字)、date(日付形式)を指定できます。列の作成後にデータの型を変更することはできません。

    API では次の値でデータの型を指定します。
    • String または 0
    • Boolean または 1
    • Number または 2
    • DateTime または 3

たとえば、"Type": "Boolean "または "Type":1 "  のどちらでも同じ結果となります。

補足:

"IsVisible "パラメータを使用して、ユーザー 画面での列の表示を制御できます。

 "IsVisible": "boolean":「"boolean」を true(表示),または false(非表示)に置き換えます。

例:

{
"Title":"Department Supervisor",
"Description":"Reporting",
"IsVisible":true,
"Type":"0"
}

 

Create custom columns-2.png

 

4.[Execute]を選択してリクエストを実行します。

5.Responses ブロックで結果を確認します。

  • Code 2xx(201など)は、リクエストが正しく動作したことを示します。
  • Response body には、リクエストの結果が表示されます。
  • 作成した列は、、管理センター>ユーザーとグループ>ユーザー 画面、およびグローバル設定>LMS 設定「ユーザーページの列」で確認できます。※ 「ユーザーページの列」では、編集(データタイプを除く)することもできます。

Create custom columns-3.png