検索

API でユーザーページにカスタム列を作成する

  • 更新

LMS365では、LMS365 APIを使用するか、LMS365グローバル設定＞LMS設定の「ユーザーページの列」を使用して、ユーザープロファイルの列を作成したり、いくつかの特定の列を除き、独自のデータソースを表示することができます。

ここでは、LMS365 API を使用して、新しいカスタム列を作成して、それらの列をユーザーページの列に反映する方法についてご説明します。

カスタム同期のオプションは、各列に対して個別に有効にできます。

カスタム同期を特定の列で有効にすると、LMS365はその特定の列のMicrosoft Azure ADからのデータを同期しなくなりますが、API経由でデータソースからそのフィールドにデータを入力することはできます。

カスタム列とシステム列の更新については、APIでユーザーページの列のデータを更新する をご参照ください。

新しいカスタム列の作成は、以下の手順で行います。

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

２．Users セクションを展開し、POST /odata/v2/UserFields Creates new user field を選択し、開いた画面で右上の「Try it out」を選択します。

Create custom columns1.png

３．パラメータを設定します。

  • "Title": "string" ："string" を列の名前に置き換えます。任意の名前を付けることができます。
  • "Description": "string" ："string" を列の説明文に置き換えます。
  • "Type": "integer" ：列に入るデータの型を指定します。列の作成後にデータの型を変更することはできません。
    既定のデータ型は文字列（String）です。その他 Boolean（Yes or No）、数値（number）、日付（date）があります。
    APIリクエストでは、次のいずれかの値でデータの型を指定します。
    String（または0），Boolean（または1），Number（または2），DateTime（または3）

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

"IsVisible "パラメータを使用して、ユーザーページへの列を表示／非表示を設定することができます。

設定値：true（ユーザーページに表示します），false（ユーザーページに表示しません）

以下はこの APIリクエストの例です。

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

Create custom columns2.png

４．準備ができたら「Execute」を選択してリクエストを実行します。

５．Responses ブロックで結果を確認します。

  • Codeの下にある２ＸＸ（例：200）という数字は、リクエストが正しく動作したことを示します。
  • Response body では、リクエストの結果が表示されます。
    作成された列は、グローバル設定＞LMS設定の「ユーザーページの列」、およびユーザーページで確認、設定の変更（データタイプを除く）ができます。
  • Downloadオプションを使用すると、APIリクエストの結果を JSON 形式でローカルデバイスに保存できます。

Create custom columns3.png