Benutzer über die Perform & Engage 365 API beziehen

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

• Eine Liste der Benutzer abrufen
• Die Details eines bestimmten Benutzers anhand seiner ID abrufen

Eine Liste der Benutzer abrufen

GET /api/v2/users/

Mit dieser Anfrage können Sie eine Liste von Benutzern in Ihrer Organisation abrufen.

Optionale Abfrageparameter

• Name (Zeichenkette). Der Name des Benutzers (ohne Beachtung der Groß-/Kleinschreibung) oder ein Teil davon.
• department_name (Zeichenkette). Der Abteilungsname (ohne Beachtung der Groß-/Kleinschreibung) oder ein Teil davon.
• manager_name (Zeichenkette). Der Name des Vorgesetzten des Benutzers (ohne Beachtung der Groß-/Kleinschreibung) oder ein Teil davon.
• is_active (Boolescher Wert). Gibt an, ob der Benutzer aktiv (true) ist oder nicht (false).
• limit (Ganzzahl). Die maximale Anzahl der Benutzer in der Antwort.
• offset (Ganzzahl). Der Startindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Beispiel für eine Anfrage

GET /api/v2/users/?department_name=it&is_active=true&manager_name=Jamie&
name=Adele%20Vance

Parameter des Antworttexts

Der Antworttext enthält:

• count (Ganzzahl). Die Anzahl der Ergebnisse.
• next und previous (Zeichenfolgen). URLs zu den nächsten und vorherigen Seiten (wenn Sie in der ursprünglichen Anfrage pagination verwendet haben).
• results (Array). Die Liste der Benutzer. Jeder Benutzer hat diese Parameter:
  • api_id (Zeichenfolge). Die ID des Benutzers. Mit dieser ID können Sie weitere Details zum Benutzer abrufen.
  • name (Zeichenfolge). Der vollständige Name des Benutzers.
  • email (Zeichenfolge). Die E-Mail-Adresse des Benutzers.
  • departments (Array). Die Liste der Abteilungen, denen der Benutzer angehört. Jede Abteilung hat diese Parameter:
    • api_id (Zeichenfolge). Die Abteilungs-ID. Mit dieser ID können Sie weitere Details zur Abteilung abrufen.
    • name (Zeichenfolge). Der Name der Abteilung.
  • manager (Objekt). Die Details zum Vorgesetzten des Benutzers enthalten diese Parameter:
    • Name (string). Der vollständige Name des Managers.
    • E-Mail (string). Die E-Mail-Adresse des Managers.
    • api_id (string). Die ID des Managers. Sie können diese ID verwenden, um weitere Details zum Manager abzurufen.

Beispiel für den Antworttext

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "api_id": "c5b6c1bc-98a4-4e3b-ab17-54fa0c48b2a1",
      "name": "Adele Vance",
      "email": "adelevance@test.com",
      "departments": [
        {
          "api_id": "6d0b534c-3d68-400c-a792-d7b88b2dac5b",
          "name": "IT"
        }
      ],
      "manager": {
        "name": "Jamie Jones",
        "email": "test@test.com",
        "api_id": "4c8c3ea5-d584-4ba2-b184-2280d53bbda3"
      },
      "is_active": true
    }
  ]
}

Details zu einem bestimmten Benutzer anhand seiner ID abrufen

GET /api/v2/users/{api_id}

Nachdem Sie die api_id des Benutzers in der Antwort auf die vorherige Anfrage erhalten haben, können Sie diese ID verwenden, um weitere Informationen über den Benutzer abzurufen.

Erforderlicher Pfadparameter

• api_id (string). Die ID des Benutzers, die Sie durch Senden der Anfrage GET /api/v2/users/ erhalten können.

Beispiel für die Anfrage

GET /api/v2/users/c5b6c1bc-98a4-4e3b-ab17-54fa0c48b2a1

Parameter des Antworttexts

Zusätzlich zu denselben Parametern wie das results-Array in der GET /api/v2/users/-Antwort enthält die Antwort von GET api/v2/users/{api_id}/ Folgendes:

• person_properties (array). Die Eigenschaften des Benutzers als Name- und Wert-Paare von String-Parametern. Beispielsweise könnte es sich dabei um die Rolle des Benutzers im Unternehmen handeln.
• followed_by (array) und following (array). Die Liste der Benutzer, die dem aktuellen Benutzer folgen bzw. denen der aktuelle Benutzer folgt. Jeder Benutzer in diesen Arrays hat diese Parameter:
  • Name (Zeichenfolge). Der vollständige Name des Benutzers.
  • email (Zeichenfolge). Die E-Mail-Adresse des Benutzers.
  • api_id (Zeichenfolge). Die ID des Benutzers. Sie können diese ID verwenden, um weitere Details zum Benutzer abzurufen.

Beispiel für den Response-Body

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

{
  "api_id": "c5b6c1bc-98a4-4e3b-ab17-54fa0c48b2a1",
  "name": "Adele Vance",
  "email": "adelevance@test.com",
  "departments": [
    {
      "api_id": "6d0b534c-3d68-400c-a792-d7b88b2dac5b",
      "name": "IT"
    }
  ],
  "manager": {
    "name": "Jamie Jones",
    "email": "test@test.com",
    "api_id": "4c8c3ea5-d584-4ba2-b184-2280d53bbda3"
  },
  "is_active": true,
  "person_properties": [
    {
      "name": "Role",
      "value": "Operations Manager"
    }
  ],
  "followed_by": [
    {
      "name": "Joanne Stefani",
      "email": "jstefani@test.com",
      "api_id": "69da2b54-eaa9-467d-9027-7e4597cbf785"
    }
  ],
  "following": [
    {
      "name": "Michael Testman",
      "email": "mtestmann@test.com",
      "api_id": "f88ab8b9-4e41-4025-ad77-519006ba855f"
    }
  ]
}