のために: 管理者
管理キーを持つロールを読み取る
ハブの役割を一覧表示し、それぞれの役割の権限を読み取ることで、ソフトウェアが適切な役割を持つ担当者をケースに割り当てられるようにします。
この記事では5 セクション
始める前に
このページでは、ユーザーをケースに登録する際に送信されるロール役割 スタッフやクライアントなど、特定の人物が案件に関して何を見たり、何を実行したりできるかを決定する一連の権限。の情報について説明しています。パスはhttps://prd-api-manage.caseactive.com/v1/<hub id>の下にあります。キーを使ってロールを読み取ることはできますが、ロールを作成、変更、または削除することはできません。
電話
| 電話 | その機能 |
|---|---|
GET /roles | 自分のハブが担っている役割を一覧表示します。 |
GET /roles/<role_id> | 1つの役割を読み取ります。その役割に関連する権限も含まれています。 |
GET /rolesは、limit(デフォルトでは20)とstart_keyを取ります。また、前のページから得られたstartKeyも含まれます。ハブには最大20個の役割がありますので、limit=20を使って呼び出すことで、すべての役割にアクセスできます。
役割ID
そのロールのIDはrole::であり、その名前はrole::senior-paralegalのような形です。各ハブには、3つの内蔵されているロールがあります。
| 役割ID | 対象者 |
|---|---|
role::clients | 顧客 |
role::staff | あなたのチーム |
role::bots | あなたのパートナー/配偶者 バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。, どのAPIキーも、そういう役割を果たします。絶対に他の人に渡してはいけません。 |
役割が担うもの
GET /rolesは、各役割のrole_id、name、role_typeに対応しています。また、3つの内蔵されている役割に対してはsystemを、自分自身の役割に対してはcustomを使用します。さらに、description、color、users_ctもあり、これらは各役割が場合において占める位置を示す数値です。
{
"data": {
"items": [
{"role_id": "role::clients", "name": "clients", "role_type": "system", "color": "#10B981", "users_ct": 214},
{"role_id": "role::senior-paralegal", "name": "senior-paralegal", "role_type": "custom", "description": "Paralegals who run intake", "color": "#6366F1", "users_ct": 9}
],
"currentItemCount": 2,
"selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles"
}
}
GET /roles/<role_id> に以下の内容を追加します:
| 分野 | 中身 |
|---|---|
permissions | 各セクションにおいて、そのロールが果たすことができる役割は、case、convos、events、posts、forms、signs、invoices、notes、tasks、teamです。各セクションには、list_postsのような名前が記載されています(それらを見てください)。また、put_postでは、自分自身でその名前を追加したり編集したりすることができます。delete_post、put_comment、moderatorでは、全員の名前を管理することができます。 |
case_read_fields, case_write_fields | このケースでは、その役割がどのように行われるか、また、その役割がどのように変わり得るかが詳しく説明されています。 |
user_read_fields, user_write_fields | この件に関わる他の人々のプロフィールの詳細は、その役割によって変わる可能性があります。 |
file_size | 該当のロールがアップロードできる最大ファイルサイズは、MB単位で、以下のいずれかです:audios、docs、files、images、schemas、videos |
そのリストには、何の役割も含まれていないので、答えの中にはそれは含まれていません。
デフォルトでは、 role::staff そして、 role::bots そのケースに関するすべてのことを管理することができます。 role::clients ケースや各セクションを見ることができます。また、ノートやコメントを追加したり、自分自身のイベントやフォーム、電子署名、タスクなどを追加したり、請求書を支払ったりすることもできます。ユーザーの設定によって、これらの機能が変更されているかもしれません。各権限で何が可能かについては、詳細を確認してください。 すべてのロールの権限を確認してください。.
電話が拒否された場合
| 状態 | message | なぜ |
|---|---|---|
| 404 | ItemNotFoundException | あなたのハブは、そのIDとは何の関係もありません。 |
| 403 | BotNotAllowedException | ロールを作成、変更、または削除しようとしました。 |