L'API Reference Data permet d'accéder aux données de référence des solutions de données. Cette API prend également en charge le filtre OData limité. L'API utilise la méthode GET pour accéder aux données.
Requête et réponse
Pour accéder aux solutions de données de référence, la structure de la requête et de la réponse sera comme suit :
Format de date : AAAA-MM-jj.
Décimal : aucun séparateur de milliers, le point étant le séparateur décimal, comme dans 23232.56
Demander les contrats de données :
L'API Reference Data n'a pas besoin de corps de requête.
Pour l'exécution de l'API Reference Data nécessite les trois paramètres décrits ci-dessous :
-
AppName : nom de l'application où la solution de données de référence est créée.
-
LibraryName : nom de la bibliothèque ou la solution de données de référence est créée.
-
RefSolutionName : nom de la solution de données de référence à laquelle accéder.
Les exemples ci-dessous illustrent l'utilisation de l'API :
Demander les données :
Exemple 1
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=refsolution
Exemple 2
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068
Exemple 3
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068 and Bitfield eq true
Exemple 4
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068 and Bitfield eq true
Contrat de données de la réponse :
Le corps de la réponse dépend de la solution à laquelle on accède.
Données de réponse
"@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 }....
Réponse de paramètres non valides :
Paramètres incorrects
[ { "ErrorCode": "Invalid_data", "Message": "LibraryName, SolutionName or AppName does not exists.", "errorPrameters": null } ]