検索

【API】 代理人の割り当て/ 割り当て解除

  • 更新

ここでは、Learn365 API を通じて代理人を割り当て、割り当て解除する方法について説明します。

 

目次

 

代理人の割り当て

現在、1回のリクエストで 1人の代理人に対して 1人のチームメンバーを割り当てることが可能です。複数のメンバーを割り当てる場合は、それぞれにリクエストを実行してください。

事前準備

双方のユーザー ID を取得後、以下の手順を行います。

手順

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

2．Delegates セクションに移動して、POST /services/users/v2/Delegates エンドポイントを選択し、右上の［Try it out］をクリックします。

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

「Edit Value」フィールドの例に従って、それぞれの ID を入力します（置き換えます）。

  • "delegateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "teamMemberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
api Assign or unassign delegates-1.jpg

 

4．［Execute］を選択してリクエストを実行します。

5．Response ブロックで結果を確認します。

  • Code 2xx（201など）は、リクエストが正しく動作したことを示します。
  • Response body には、delegateId（代理人ID）、teamMemberId（代理人が管理するチームメンバー ID）、isDeleted（代理人割り当てが解除されたかどうか）が含まれます。 
  • エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。

Response 例：


{
 "delegateId": "7853ce01-9a6f-4e07-a3e0-1e3a578655d7",
 "teamMemberId": "8a47813f-62c7-4a6f-a721-496692347c14",
 "isDeleted": false
}

 

代理人の割り当て解除

代理人の割り当て解除には、2 つの方法があります。

すべての代理人割り当てを解除する

事前準備

テナント内で割り当てられている代理人を確認しておくことをお勧めします。GET /services/users/v2/Delegates リクエストで、現在の代理人とそのチームメンバーのリストを取得できます。代理人の割り当てを解除するには、代理人 ID が必要です。このリクエストのレスポンスには、代理人 ID も含まれています。リクエストの詳細については、こちらをご参照ください。

代理人 ID を取得後、以下の手順を行います。

手順

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

2．Delegates セクションに移動して、DELETE /services/users/v2/Delegates/{delegateId} Soft deletes all delegate relationships for a specific delegate user エンドポイントを選択し、右上の［Try it out］をクリックします。

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

  • delegateId＊：フィールドに代理人 ID を入力しします。
api Assign or unassign delegates-2.jpg

 

4．［Execute］を選択してリクエストを実行します。

5．Response ブロックで結果を確認します。

  • Code 204 は、リクエストが正しく動作したことを示します。Response body はありません。
  • 代理人が解除された割り当ては、”isDeleted”パラメータが「true」保持され、GET /services/users/v2/Delegates リクエストのレスポンスで取得できます。
  • 解除された割り当ては、後で1つずつ復元できます。

 

特定のチームメンバーの代理人割り当てを解除する

事前準備

代理人の割り当てを解除するには、代理人 ID とチームメンバー ID が必要です。GET /services/users/v2/Delegates リクエストを実行して、レスポンスから、代理人 ID とチームメンバー ID を取得します。リクエストの詳細については、こちらをご参照ください。

代理人 ID とチームメンバー ID を取得後、以下の手順を行います。

手順

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

2．Delegates セクションに移動して、DELETE /services/users/v2/Delegates/{delegateId}/members/{teamMemberId}
Soft deletes a specific delegate relationship エンドポイントを選択し、右上の［Try it out］をクリックします。

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

  • delegateId＊：フィールドに代理人 ID を入力しします。
  • teamMemberId＊：フィールドにチームメンバー ID を入力しします。
api Assign or unassign delegates-3.jpg

 

4．［Execute］を選択してリクエストを実行します。

5．Response ブロックで結果を確認します。

  • Code 204 は、リクエストが正しく動作したことを示します。Response body はありません。
  • 代理人が解除された割り当ては、”isDeleted”パラメータが「true」保持され、GET /services/users/v2/Delegates リクエストのレスポンスで取得できます。 
  • 解除された割り当ては後で復元できます。

 

解除した割り当てを復元する

事前準備

  • 代理人の割り当てを解除するには、代理人 ID とチームメンバー ID が必要です。GET /services/users/v2/Delegates リクエストを実行して、レスポンスから、代理人 ID とチームメンバー ID を取得します。リクエストの詳細については、こちらをご参照ください。
  • 特定の代理人と特定のチームメンバーの割り当てが解除されているかどうかを確認するには、GET/services/users/v2/Delegates/{delegateId}/members/{teamMemberId} リクエスト実行し、特定の代理人割り当てに関する情報を取得します。レスポンスの”isDeleted” の値が「true」の場合、この割当ては解除されています。

代理人 ID とチームメンバー ID を取得後、以下の手順を行います。

手順

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

2．Delegates セクションに移動して、PATCH/services/users/v2/Delegates/{delegateId}/members/{teamMemberId}/update Restores a soft-deleted delegate relationship エンドポイントを選択し、右上の［Try it out］をクリックします。

このリクエストは、特定の代理人と特定のチームメンバーに対して、以前に解除された割り当てを復元します。

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

  • delegateId＊：フィールドに代理人 ID を入力しします。
  • teamMemberId＊：フィールドにチームメンバー ID を入力しします。
api Assign or unassign delegates-4.jpg

 

4．［Execute］を選択してリクエストを実行します。

5．Response ブロックで結果を確認します。

  • Code 204 は、リクエストが正しく動作したことを示します。Response body はありません。
  • 解除された割り当ては復元されます。（"isDeleted": false）