נקודות קצה של צוותים

צוותים מייצגים קבוצה שאפשר להקצות לה סוכן, ואז אפשר להקצות אותה לתור. כל אובייקט מייצג צוות אחד.

יש שלוש נקודות קצה של צוותים:

• ‫/team – מציג רשימה של חברי הצוות.

• ‫/team/tree – משיכת צוותים במבנה עץ.

• ‫/team/{:id} – משיכת משאב יחיד של צוות.

כדאי לעיין במודל הבא כדי לזהות אילו שדות עשויים להכיל פרטים אישיים מזהים.

[
  {
    "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	לא נכון	String	מיון התגובה על סמך שדה כלשהו באובייקט התגובה.
sort_direction	לא נכון	‫ASC או DESC	הערה לגבי כיוון המיון, בסדר עולה או יורד
ייפתח	לא נכון	String	התאמה לכל דף כדי לציין את מספר הדף של הרשומות. לדוגמה, אם הערך של per הוא 200 והערך של page הוא 2, התגובה תכיל את רשומות 201 עד 400, כי דף 1 יכיל את רשומות 1 עד 200.
לכל	לא נכון	String	השדה הזה משויך לדף ומציין כמה רשומות ייכללו בדף של רשומות. לדוגמה, אם הערך של per הוא 200 והערך של page הוא 2, התגובה תכיל את רשומות 201 עד 400, כי דף 1 יכיל את רשומות 1 עד 200.
agents_count[from]	לא נכון	מספר	יוצרת רף תחתון של שדה מספר הסוכנים. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן.
agents_count[to]	לא נכון	מספר	יוצרת גבול עליון של שדה ספירת הסוכנים. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן.
id[]	לא נכון	Array[String]	‫Array[Strings]. מזהה הרשומות שרוצים לחפש ולהחזיר
name[]	לא נכון	Array[String]	הפונקציה מחזירה רשומות על סמך שם המשאב.
parent_id[]	לא נכון	Array[String]	הפונקציה מחזירה רשומות על סמך מזהה ההורה של הרשומות שצוינו
position[]	לא נכון	Array[String]	הפונקציה מחזירה רשומות על סמך המיקום של תפריט
with_deleted	לא נכון	בוליאני	הפונקציה מחזירה רשומות שנמחקו (True) או לא כוללת רשומות שנמחקו (False)

נקודת קצה (endpoint):

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

דוגמאות נוספות לבקשות ולתשובות:

בקשה לדוגמה: רשימת צוות

Body: None

דוגמה לתגובה: רשימת צוותים

[
  {
    "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	לא נכון	String	החזרת רשומה ספציפית על סמך מזהה
with_deleted	לא נכון	בוליאני	הפונקציה מחזירה רשומות שנמחקו (True) או לא כוללת רשומות שנמחקו (False)

נקודת קצה (endpoint):

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

דוגמאות נוספות לבקשות ולתשובות:

דוגמה לבקשה: צוות יחיד

Body: None

דוגמה לתגובה: צוות יחיד

    {
        "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

עץ הצוות

נקודת קצה (endpoint):

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

דוגמאות נוספות לבקשות ולתשובות:

בקשה לדוגמה: עץ צוות

Body: None

דוגמה לתגובה: תרשים מבנה ארגוני

[
  {
    "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