Benutzerdetails über die Learn365-API aktualisieren

In Learn365 ist es möglich, Benutzerdetails in Systemspalten (wie Abteilung, Titel usw.) sowie in benutzerdefinierten Spalten (die über diese API erstellt werden können) über die API zu aktualisieren.

Sie können Benutzerdetails sowohl in System- als auch in benutzerdefinierten Spalten über den PUT-Endpunkt /odata/v2/Users(‘{LoginName}’) aktualisieren. Sie können benutzerdefinierte Spalten auch über den POST-Endpunkt /odata/v2/Users('{LoginName}')/UpdateUserFieldValues aktualisieren.

Bevor Sie Benutzerdetails über den PUT-Endpunkt /odata/v2/Users(‘{LoginName}’) aktualisieren, benötigen Sie:

• Den Anmeldenamen des Benutzers, dessen Details Sie ändern möchten. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.
• Wenn Sie den Vorgesetzten eines Benutzers aktualisieren möchten, benötigen Sie die ID des Vorgesetzten. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.
• Wenn Sie Informationen in benutzerdefinierten Spalten aktualisieren möchten, benötigen Sie deren IDs. Wenn Sie die GET-API-Anforderung /odata/v2/UserFields ausführen, erhalten Sie alle Informationen zu jeder Spalte, sowohl System- als auch benutzerdefiniert. Die Informationen umfassen die Spalten-ID.

So aktualisieren Sie Benutzerdetails in System- oder benutzerdefinierten Spalten über die API:

1. Gehen Sie zu https://api.365.systems/ und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt Users den PUT-Endpunkt /odata/v2/Users(‘{LoginName}’) aus und wählen Sie oben rechts Try it out aus.

3. Geben Sie im Feld LoginName den Anmeldenamen des Benutzers ein, dessen Details Sie aktualisieren.

4. Im user-Objekt, das ein Request Body ist, können Sie jeden Parameter ändern. Beachten Sie:

• Titel ist der einzige erforderliche Parameter in dieser Anfrage. In diesem Fall ist Titel der vollständige Name des Benutzers, der in unserem System angezeigt wird.

  HINWEIS   

  Die zum Aktualisieren der Benutzerdetails verwendete PUT-Methode ersetzt alle Benutzerinformationen, nicht nur die von Ihnen angegebenen Details. Das bedeutet, dass alle Parameter angegeben werden müssen, andernfalls werden nicht angegebene Parameter mit leeren Daten überschrieben.

   

• Jeder Parameter in den Systemspalten ist – mit Ausnahme der ManagerId – eine Zeichenfolge. Um die ManagerId zu aktualisieren, geben Sie die Benutzer-ID des Vorgesetzten ein.
• Um die Benutzerdetails in benutzerdefinierten Spalten zu ändern, geben Sie im Array UserFieldValues die Parameter FieldId und Value ein, wobei FieldId die ID der benutzerdefinierten Spalte ist und Value deren neuer Wert ist.

Wenn Sie die Details eines Benutzers in jeder Systemspalte und in einer benutzerdefinierten Spalte aktualisieren möchten, könnte die Anfrage so aussehen:

{
"Department": "Research",
"Title": "Joanne Stefani",
"Email": "jstefani@compafi464.onmicrosoft.com",
"City": "Paris",
"Country": "France",
"Office": "Paris",
"JobTitle": "Researcher",
"Company": "Test Ltd.",
"ManagerId": "a98cf457-b3cc-4314-b995-d756fea98de3",
"UserFieldValues": 
[
{"FieldId": "1c737e52-ee3b-45b1-aaec-cf981ade934c", "Value": "Senior"}
]
}

5. Wählen Sie Execute aus, um die Anfrage auszuführen.

6. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Ein 200-Code mit den aktualisierten Benutzerdetails im Antworttext bedeutet eine erfolgreiche Antwort.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Um die Details eines Benutzers in benutzerdefinierten Spalten über den POST-Endpunkt /odata/v2/Users('{LoginName}')/UpdateUserFieldValues zu aktualisieren, benötigen Sie:

• Den Anmeldenamen des Benutzers, dessen Details Sie ändern möchten. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.
• Die ID einer benutzerdefinierten Spalte. Wenn Sie die GET-API-Anfrage /odata/v2/UserFields ausführen, erhalten Sie alle Informationen zu jeder Spalte, einschließlich der benutzerdefinierten Spalten. Die Informationen enthalten die Spalten-ID. 

So aktualisieren Sie die Details eines Benutzers in benutzerdefinierten Spalten über die API:

1. Gehen Sie zu https://api.365.systems/ und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt Users den Endpunkt POST /odata/v2/Users('{LoginName}')/UpdateUserFieldValues und klicken Sie oben rechts auf Try it out.

3. Geben Sie im Feld LoginName den Anmeldenamen des Benutzers ein, dessen Details Sie aktualisieren.

4. Geben Sie im Array UserFieldValues im Request-Body die Parameter ein:

• FieldId. Die ID einer benutzerdefinierten Spalte.
• Wert. Der neue Wert für diese Spalte.

Sie können mehrere benutzerdefinierte Spalten auf einmal aktualisieren, indem Sie mehr als ein Objekt in das Array UserFieldValues einfügen. In diesem Fall könnte der Request-Body wie folgt aussehen.

{
"UserFieldValues": [
{ "FieldId": "1c737e52-ee3b-45b1-aaec-cf981ade934c", "Value": "Middle"},
{ "FieldId": "d6ba00b6-692a-4b32-aa55-8cf12cd35fc7", "Value": 12}
]
}

5. Klicken Sie auf Execute, um die Anfrage auszuführen.

6. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Ein 200-Code mit einem leeren Antworttext signalisiert eine erfolgreiche Antwort.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.