チーム エンドポイント

チームは、エージェントを割り当てることができるグループを表します。チームはキューに割り当てることができます。各オブジェクトは 1 つのチームを表します。

チーム エンドポイントは 3 つあります。

  • /team - チームのリストを取得します。

  • /team/tree - チームをツリー構造で取得します。

  • /team/{:id} - 単一のチームリソースを取得します。

次のモデルを確認して、どのフィールドに PII が含まれている可能性があるかを判断します。

[
  {
    "id": 0,
    "name": "string",
    "parent_id": 0,
    "position": 0,
    "deleted": true,
    "agents_count": 0,
    "assignees": {
      "id": 0,
      "name": "string", // This may be considered PII
      "last_name": "string", // This may be considered PII
      "first_name": "string", // This may be considered PII
      "agent_number": "string", // This may be considered PII
      "avatar_url": "string"
    }
  }
]

チーム リスト

パラメータ 必須 データ型 定義
sort_column FALSE 文字列 レスポンス オブジェクトの任意のフィールドに基づいてレスポンスを並べ替えます。
sort_direction FALSE ASC または DESC 並べ替えの方向（昇順または降順）を記録します。
ページ FALSE 文字列 「per」と組み合わせて、レコードのページ番号を示します。たとえば、per が 200 で page が 2 の場合、レスポンスにはレコード 201 ～ 400 が含まれます。ページ 1 には 1 ～ 200 が含まれます。
/ FALSE 文字列 ページとペアになって、レコードのページに含まれるレコードの数を示します。たとえば、per が 200 で page が 2 の場合、レスポンスにはレコード 201 ～ 400 が含まれます。ページ 1 には 1 ～ 200 が含まれます。
agents_count[from] FALSE 数値 エージェント数のフィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。
agents_count[to] FALSE 数値 エージェント数の上限フィールドを作成します。返されるすべてのレコードは、入力された値より前のものになります。
id[] FALSE Array[String] Array[Strings]。検索して返すレコードの ID
name[] FALSE Array[String] リソース名に基づいてレコードを返します。
parent_id[] FALSE Array[String] 指定されたレコードの親 ID に基づいてレコードを返します
position[] FALSE Array[String] メニューの位置に基づいてレコードを返す
with_deleted FALSE ブール値 削除されたレコードを返す（True）か、削除されたレコードを含めない（False）かを指定します。

エンドポイント:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams

リクエスト/レスポンスのその他の例:

リクエストの例: チームリスト

本文: なし

レスポンスの例: チームリスト

[
  {
    "id": 11,
    "name": "Forest Moon of Endor Team",
    "parent_id": null,
    "position": 28,
    "agents_count": 3,
    "deleted": false,
    "assignees": [
      {
        "id": 19,
        "agent_number": "77",
        "name": "Storm Trooper 1",
        "last_name": "Storm",
        "first_name": "Trooper 1"
      },
      {
        "id": 20,
        "agent_number": "78",
        "name": "Storm Trooper 2",
        "last_name": "Storm",
        "first_name": "Trooper 2"
      },
      {
        "id": 21,
        "agent_number": "79",
        "name": "Storm Trooper 3",
        "last_name": "Storm",
        "first_name": "Trooper 3"
      }
    ]
  },
  {
    "id": 12,
    "name": "Death Star Team",
    "parent_id": null,
    "position": 28,
    "agents_count": 3,
    "deleted": false,
    "assignees": [
      {
        "id": 34,
        "agent_number": "80",
        "name": "Storm Trooper 5",
        "last_name": "Storm",
        "first_name": "Trooper 5"
      },
      {
        "id": 35,
        "agent_number": "81",
        "name": "Storm Trooper 6",
        "last_name": "Storm",
        "first_name": "Trooper 6"
      },
      {
        "id": 36,
        "agent_number": "82",
        "name": "Storm Trooper 7",
        "last_name": "Storm",
        "first_name": "Trooper 7"
      }
    ]
  }
]

ステータス コード: 200

単一のチーム

パラメータ 必須 データ型 定義
record_id FALSE 文字列 ID に基づいて特定のレコードを返します
with_deleted FALSE ブール値 削除されたレコードを返す（True）か、削除されたレコードを含めない（False）かを指定します。

エンドポイント:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams/{​{team_id}​}

リクエスト/レスポンスのその他の例:

リクエストの例: 単一チーム

本文: なし

回答例: 単一チーム

    {
        "id": 11,
        "name": "Forest Moon of Endor Team",
        "parent_id": null,
        "position": 28,
        "agents_count": 3,
        "deleted": false,
        "assignees": [
            {
                "id": 19,
                "agent_number": "77",
                "name": "Storm Trooper 1",
                "last_name": "Storm",
                "first_name": "Trooper 1"
            },
            {
                "id": 20,
                "agent_number": "78",
                "name": "Storm Trooper 2",
                "last_name": "Storm",
                "first_name": "Trooper 2"
            },
            {
                "id": 21,
                "agent_number": "79",
                "name": "Storm Trooper 3",
                "last_name": "Storm",
                "first_name": "Trooper 3"
            }
        ]
    }

ステータス コード: 200

チームツリー

エンドポイント:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams/tree

リクエスト/レスポンスのその他の例:

リクエストの例: チームツリー

本文: なし

レスポンスの例: チームツリー

[
  {
    "id": 147,
    "name": "Storm Trooper Reigment",
    "parent_id": null,
    "position": 1,
    "agents_count": 9,
    "deleted": false,
    "children": [
      {
        "id": 34,
        "name": "Storm Trooper 1st Regiment",
        "parent_id": 147,
        "position": 1,
        "agents_count": 2,
        "deleted": false,
        "children": []
      }
    ]
  }
]

ステータス コード: 200