LMS365では LMS365 API を使用して、カスタム列と一部を除くシステム列のユーザー情報を更新することができます。
ここでは、その方法についてご説明します。
|
カスタム同期オプションは、各列に対して個別に有効になります。 特定の列でカスタム同期を有効にすると、LMS365はその列のMicrosoft Azure ADからのデータを同期しなくなり、ユーザ列に表示されるデータを設定できます。 カスタム同期が無効になっている列については、データは自動的にAzure Active Directoryから取得されます。 |
APIでカスタム列のフィールドのデータを更新する
API でカスタム列のデータを更新するには、以下の手順で行います。
１．https://api.365.systems/ にアクセスし、APIキーで認証します。
２．Users セクションを展開し、 POST /odata/v2/Users('{LoginName}')/ UpdateUserFieldValues Update user's filed values を選択し、開いた画面で右上の「Try it out」を選択します。
３．パラメータを設定します。
- key: LoginName：データを更新するユーザーのログイン名を入力します。
Edit Value の次の値を入力します。
- "UserId": "guid"： 該当ユーザーのIDを入力します。
- "FieldId": "guid"：列のIDを入力します。
FieldIdは、UserFields セクションの GET method /odata/v2/UserFields with the Returns all user fields で取得することができます。
右上の「Try it out」 を選択し、「Execute」を選択してリクエストを実行します。Response body で、該当の列のIDを見つけることができます。
”IsPredefined : true” の場合、Predefined の値は更新することはできませんのでご注意ください。
- "Value": "{}"：列のデータ型と一致する値を入力します。
例えば、数値型の列の場合、正数または小数（小数点以下2桁まで）を入力できます。
列のデータ型のパラメータは、FieldId を取得するレスポンスで確認できます。
以下は、ユーザーの国を変更するリクエストの例です。
{
"UserFieldValues": [
{"UserId": "6db804bd-f790-4844-a592-a21cb6acd875",
"FieldId": "7dd89e71-470a-4932-904d-6890b7f06f82",
"Value": "Denmark"}
]
}
４．準備ができたら、「Execute 」ボタンを選択してリクエストを実行します。
５．Responses ブロックで結果を確認します。
- Codeの下にある２ＸＸ（例：200）という数字は、リクエストが正しく動作したことを示します。
- Response body には、リクエストの結果が表示されます。更新された列の情報は、ユーザーページで確認できます。
APIでシステム列のフィールドのデータを更新する
API でシステム列のデータを更新するには、以下の手順で行います。
| PUTメソッドは、入力された情報だけでなく、すべての情報を更新します。そのため、パラメータには値を入力する必要があり、パラメータに値が入力されていない場合、データがない状態で上書きされますので注意してください。 |
１．https://api.365.systems/ にアクセスし、APIキーで認証します。
２．Users セクションを展開し、 PUT /odata/v2/Users('{LoginName}') update user's info を選択し、開いた画面で右上の「Try it out」を選択します。
３．パラメータを設定します。
- key: LoginName：このパラメータは必須です。データを更新するユーザーのログイン名（すべての接頭辞を含む）を入力する必要があります。
Edit Value の次の値を入力します。
- "Title": "string"：このパラメータは必須です。"string" をユーザーページに表示されるユーザー名に置き換えます。
フィールドに用意されたその他のオプションパラメータで、ユーザーの情報を更新するフィールドの値を入力します。
以下は、ユーザーの City（都市）、Country（国）、Office（オフィス）、Job Position（役職）、Company（会社）情報を更新する API リクエストの例です。
{
"Title": "Grady Archie",
"City": "Nebraska",
"Country": "United States",
"Office": "115/088",
"JobTitle": "Legacy Branding Analyst",
"Company": "CCRT"
}
４．準備ができたら、「Execute 」ボタンを選択してリクエストを実行します。
５．Responses ブロックで結果を確認します。
- Codeの下にある２ＸＸ（例：200）という数字は、リクエストが正しく動作したことを示します。
- Response body には、リクエストの結果が表示されます。更新された列の情報は、ユーザーページで確認できます。