Keine Bearbeitungszusammenfassung |
Keine Bearbeitungszusammenfassung Markierung: 2017-Quelltext-Bearbeitung |
||
Zeile 7: | Zeile 7: | ||
} | } | ||
==Anlegen von Objekten | ==Anlegen von Objekten== | ||
/New | /New | ||
Zeile 15: | Zeile 15: | ||
&keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften> | &keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften> | ||
===Beispiele Personal | ===Beispiele Personal=== | ||
Neues Personal mit Personalnummer "PNR123" von 01.01.2020. | Neues Personal mit Personalnummer "PNR123" von 01.01.2020. | ||
/New?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&keyDate=01.01.2020 | /New?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&keyDate=01.01.2020 | ||
===Beispiele Benutzer | ===Beispiele Benutzer=== | ||
Neuer Benutzer mit Username "USER1" | Neuer Benutzer mit Username "USER1" | ||
/New?objectType=AlexUser&indexQuery=UserX&matchString=USER1 | /New?objectType=AlexUser&indexQuery=UserX&matchString=USER1 | ||
==Import von Eigenschaften | ==Import von Eigenschaften== | ||
/Set | /Set | ||
Zeile 41: | Zeile 41: | ||
Enthält eine etwaige Fehlermeldung. | Enthält eine etwaige Fehlermeldung. | ||
===Beispiele Personal | ===Beispiele Personal=== | ||
Import von Email "test@example.com" bei Personal mit Personalnummer "PNR123". | Import von Email "test@example.com" bei Personal mit Personalnummer "PNR123". | ||
Zeile 62: | Zeile 62: | ||
Import von Username "USER1NEU" bei User mit Username "USER1". | Import von Username "USER1NEU" bei User mit Username "USER1". | ||
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=Username&valueString=USER1NEU | /Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=Username&valueString=USER1NEU | ||
==Ausgabe== | |||
Json-Objekt in der Form: | |||
{ "request" : "" | |||
, "status" : "" | |||
, "details" : "" | |||
} | |||
- "request": Angeforderter Request als "Handshake" | |||
- "status": "ok" oder "error" | |||
- "details": Optionale Detailinformationen bei "error" |
Version vom 18. Juni 2021, 11:02 Uhr
Ab Version 2021.16
Konfiguration im Config-File:
, "httpServicePlugins" : { "0" : "Bfx.Abstract.Model.WebService.dll" }
Anlegen von Objekten
/New ?objectType=<Objekttyp des neuen Objektes> &indexQuery=<Index für Verifizierung> &matchString=<Wert für Suche auf Index> &keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften>
Beispiele Personal
Neues Personal mit Personalnummer "PNR123" von 01.01.2020.
/New?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&keyDate=01.01.2020
Beispiele Benutzer
Neuer Benutzer mit Username "USER1"
/New?objectType=AlexUser&indexQuery=UserX&matchString=USER1
Import von Eigenschaften
/Set ?objectType=<Objekttyp auf dem importiert wird> &indexQuery=<Index über den das Objekt gefunden wird> &matchString=<Wert für Suche auf Index> &importType=<Eigenschaft die importiert werden soll> &valueString=<Wert der der Eigenschaft, URL-Encoded> &keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften>
Format für Datum:
DD.MM.YYYY
Ergebnis:
Enthält eine etwaige Fehlermeldung.
Beispiele Personal
Import von Email "test@example.com" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeEmailAddress&valueString=test@example.com
Import von Kartennummer "1234567" bei Personal mit Personalnummer "PNR123" von 01.01.2020.
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeCardID&valueString=1234567&keyDate=01.01.2020
Import von Zuname "Mustermann" bei Personal mit Personalnummer "PNR123" von 01.10.2020.
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Surname&valueString=Mustermann&keyDate=01.10.2020
Import von Vorname "Max" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Forname&valueString=Max
Beispiele Benutzer:
Import von Email "test@example.com" bei User mit Username "USER1".
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=UserEmail&valueString=test@example.com
Import von Username "USER1NEU" bei User mit Username "USER1".
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=Username&valueString=USER1NEU
Ausgabe
Json-Objekt in der Form:
{ "request" : "" , "status" : "" , "details" : "" }
- "request": Angeforderter Request als "Handshake" - "status": "ok" oder "error" - "details": Optionale Detailinformationen bei "error"