Die Referenzdaten-API ermöglicht den Zugriff auf Daten von Referenzdatenlösungen. Diese API unterstützt zudem den Filter für beschränkte OData. Die API verwendet die GET-Methode für den Zugriff auf Daten.
Anforderung und Antwort
Für den Zugriff auf die Referenzdatenlösungen sind Anforderungen und Antworten wie folgt strukturiert:
Datumsformat: JJJJ-MM-TT
Dezimal: Kein Tausendertrennzeichen und Punkt wäre ein Dezimaltrennzeichen, z. B. 23232.56
Datenvertrag Anforderung:
Für die Referenzdaten-API ist kein Anforderungstext erforderlich.
Für die Ausführung der Referenzdaten-API sind die drei unten aufgeführten Parameter erforderlich:
-
AppName: Der Name der App, in der die Referenzdatenlösung erstellt wird.
-
LibraryName: Der Name der Bibliothek, in der die Refrenzdatenlösung erstellt wird.
-
RefSolutionName: Der Name der Referenzdatenlösung, auf die zugegriffen werden soll.
Im folgenden Beispiel wird die Verwendung der API veranschaulicht:
Anforderungsdaten:
Beispiel 1
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=refsolution
Beispiel 2
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068
Beispiel 3
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068 and Bitfield eq true
Beispiel 4
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068 and Bitfield eq true
Datenvertrag Antwort:
Der Antworttext hängt von der Lösung ab, auf die zugegriffen wird.
Antwortdaten
"@odata.context": "https://cha-en-vst679.wsdt.local:443/svr/api/v1/ReferenceData?AppName=Reference%20Data&LibraryName=Reference%20Data%20Lists&SolutionName=ReferenceiList11Items100", "value": [ { "username": "wsdt\\devuser5", "CreatedOn": "2020-01-21", "empid": 1059, "decimalfield": 666.77, "Bitfield": true }, { "username": "wsdt\\devuser6", "CreatedOn": "2020-01-22", "empid": 1060, "decimalfield": 667.77, "Bitfield": true }, { "username": "wsdt\\devuser7", "CreatedOn": "2020-01-23", "empid": 1061, "decimalfield": 668.77, "Bitfield": true }, { "username": "wsdt\\devuser10", "CreatedOn": "2020-01-26", "empid": 1064, "decimalfield": 671.77, "Bitfield": true }, { "username": "wsdt\\devuser11", "CreatedOn": "2020-01-27", "empid": 1065, "decimalfield": 672.77, "Bitfield": true }....
Antwort „Ungültige Parameter“:
Ungültige Parameter
[ { "ErrorCode": "Invalid_data", "Message": "LibraryName, SolutionName or AppName does not exists.", "errorPrameters": null } ]