Abteilungen über die Perform & Engage 365 API abrufen

Mit der Perform & Engage 365 API können Sie:

• Eine Liste der Abteilungen abrufen.
• Details zu einer bestimmten Abteilung anhand ihrer ID abrufen.

Eine Liste der Abteilungen abrufen

GET /api/v2/departments/

Mit dieser Anfrage können Sie eine Liste der Abteilungen in Ihrer Organisation abrufen.

Optionale Abfrageparameter

• Name (Zeichenkette). Der Name der Abteilung ohne Berücksichtigung der Groß-/Kleinschreibung oder ein Teil des Namens.
• Limit (Ganzzahl). Die maximale Anzahl der Abteilungen in der Antwort.
• Offset (Ganzzahl). Der Anfangsindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Beispiel für eine Anfrage

GET /api/v2/departments/?name=IT

Parameter im Antworttext

Der Antworttext umfasst:

• Anzahl (Ganzzahl). Die Anzahl der Ergebnisse.
• Weiter und Zurück (Zeichenketten). URLs zu den Seiten „Weiter“ und „Zurück“ (wenn Sie in der ursprünglichen Anfrage Paginierung verwendet haben).
• Ergebnisse (Array). Die Liste der Abteilungen. Jede Abteilung verfügt über folgende Parameter:
  • name (String). Der Abteilungsname.
  • api_id (String). Die Abteilungs-ID. Sie können diese ID verwenden, um weitere Details zur Abteilung abzurufen.
  • admin (Array). Die Liste der Abteilungsadmins. Jeder Abteilungsadmin hat folgende Parameter:
    • name (String). Der vollständige Name des Abteilungsadmins.
    • email (String). Die E-Mail-Adresse des Abteilungsadmins.
    • api_id (String). Die Benutzer-ID des Abteilungsadmins.

Beispiel für den Antwort-Body

Die erfolgreiche 200-Antwort gibt einen Body zurück, der in etwa so aussieht:

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "name": "IT Team",
      "api_id": "6045BDD1-ECA5-1EEF-8D8E-B29013F9F3EA",
      "admins": []
    },
    {
      "name": "IT Team 2",
      "api_id": "6045BDD1-ECA5-1EEF-8D8F-AF2D319F93EC",
      "admins": [
        {
          "name": "Michael Test",
          "email": "mtest@test.com",
          "api_id": "f88ab8b9-4e41-4025-ad77-519006ba855f"
        }
      ]
    }
  ]
}

Rufen Sie die Details einer bestimmten Abteilung anhand ihrer ID ab

GET api/v2/departments/{api_id}/

Nachdem Sie in der Antwort auf previous request die Abteilungs-api_id erhalten haben, können Sie diese ID verwenden, um Informationen über die Abteilung abzurufen.

Erforderlicher Pfadparameter

• api_id (String). Die Abteilungs-ID, die Sie erhalten, indem Sie die GET-Anfrage /api/v2/departments/ senden.

Beispielanfrage

GET /api/v2/departments/acac5180-6186-4058-a9b6-c8d19723fdfa/

Parameter des Antworttextes

Zusätzlich zu denselben Parametern, die das results-Array in der GET-/api/v2/departments/-Antwort enthält, enthält die GET-/api/v2/departments/{api_id}/-Antwort das members-Array, eine Liste der Abteilungsmitglieder. Das members-Array enthält:

• Name (string). Der vollständige Name des Abteilungsmitglieds.
• email (string). Die E-Mail-Adresse des Abteilungsmitglieds.
• api_id (string). Die Benutzer-ID des Abteilungsmitglieds.
• person_properties (array). Das Array enthält die Eigenschaften des Abteilungsmitglieds als Name- und value-Paar von Zeichenfolgenparametern. Zum Beispiel kann es sich dabei um die Rolle des Abteilungsmitglieds im Unternehmen handeln.
• manager (object). Die Liste der Vorgesetzten des Abteilungsmitglieds enthält:
  • Name (string). Der vollständige Name des Vorgesetzten.
  • email (string). Die E-Mail-Adresse des Vorgesetzten.
  • person_properties (array). Die Eigenschaften des Vorgesetzten als Name- und value-Paare von Zeichenfolgenparametern.
  • department (string). Die Abteilung, zu der der Vorgesetzte gehört.

Beispiel für den Antworttext

Die erfolgreiche 200-Antwort gibt einen Antworttext ähnlich diesem zurück:

{
  "name": "Datenbankadministration",
  "api_id": "acac5180-6186-4058-a9b6-c8d19723fdfa",
  "admins": [],
  "members": [
    {
      "name": "Hans Test",
      "email": "htest@test.com",
      "api_id": "b8f2809d-5aa6-4f4a-a0c2-fa7d9074fb6f",
      "person_properties": [],
      "manager": null
    },
    {
      "name": "Patrick Test",
      "email": "ptest@test.com",
      "api_id": "01973036-b10e-4310-b1df-230277817c08",
      "person_properties": [],
      "manager": {
        "name": "Test Manager",
        "email": "tmanager@test.com",
        "person_properties": [],
        "department": "Human Success"
      }
    }
  ]
}