【API】 ユーザーのスキルの消去(完全削除)

  • 更新

Learn365 では、API を使用してユーザーが持つスキルを消去(完全削除)することができます。

この操作を実行すると、対象ユーザーが持つ特定のスキルに関する情報は、Learn365 テナントから完全に削除されます。

ここでは、API を通じてユーザーの特定のスキルを消去する手順を説明します。

注記:

従来の Competencies 関連のエンドポイントは、今後の Learn365 リリースで廃止される予定です。新しい Skills エンドポイントへの移行を推奨します。

 

ユーザーのスキルを消去するには、以下の情報が必要です。

  • courseCatalogId:消去するスキルが含まれているコースカタログの ID。コースカタログ ID の取得については、こちらをご参照ください。 

補足:

  • スキルのステータス(有効 / 失効)にかかわらず、指定したスキルの情報を消去(完全削除)することができます。
  • 複数のレベルからなる一連のスキルのうち、いずれか 1 つのスキルが削除されると、関連するすべてのスキルが削除されます。

 

UserSkills セクションで取り消す

手順:

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

2.UserSkills セクションに移動し、

POST /services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/PurgeSkill
Purge skill(s) of a specific user 

を選択し、右上の[Try it out]をクリックします。

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

swagger_purge_skill_example.png

 

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

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

  • Code 204 は、リクエストが正しく動作したことを示します。
  • エラーの場合、Response body には、問題を説明するコードとメッセージ キーを持つエラー オブジェクトが含まれます。

swagger_purge_skill_via_api_response.png

 

Learn365 管理センター>グローバル設定>「監査証跡」で、消去したスキルに関する詳細な情報を確認することができます。

フィルター パネルの「活動」フィールドで 「受講者のスキルが消去されました」を選択し適用します。検索結果で該当するレコードを選択すると、詳細情報が表示されます。

Purge skills via the API-3.png

 

Learn365 監査証跡については、こちらをご覧ください。

 

Users セクションで取り消す(従来)

注意!Users セクションのエンドポイントは、今後の Learn365 リリースで廃止される予定です。

手順:

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

2.Users セクションに移動し、POST /odata/v2/Users('{LoginName}')/PurgeCompetency
Purge competency(skill) for a specific user を選択し、右上の[Try it out]をクリックします。

Purge skills via the API-1.png

 

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

  • LoginName:「Key:LoginName」フィールドに、対象ユーザーのログイン名を入力します。
  • parameters * competencyId:「Edit Value」フィールドで、以下を入力します。
    • "competencyId": "string" :「string」を、消去するスキルの ID に置き換えます。

Purge skills via the API-2.png

 

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

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

  • Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
  • エラーの場合、Response body には、問題を説明するコードとメッセージ キーを持つエラー オブジェクトが含まれます。

Learn365 管理センター>グローバル設定>「監査証跡」で、消去したスキルに関する詳細な情報を確認することができます。

フィルター パネルの「活動」フィールドで「受講者のスキルが消去されました」を選択し適用します。検索結果で該当するレコードを選択すると、詳細情報が表示されます。