Détails de l'API
L'URL de l'API OData de CA NFA se compose de trois parties : Service Root URL, Resource Path et Query Options.
nfa1000
L'URL de l'API OData de CA NFA se compose de trois parties : Service Root URL, Resource Path et Query Options.
Syntaxe
:<Service Root URL>/<Resource Path>?<Query Options>
Où,
- Service Root URLIdentifie la racine d'un service OData de CA NFA. Une demande GET à cette URL renvoie le document de service spécifique du format. L'URL racine du service doit se terminer par une barre oblique.L'API OData de CA NFA utilise le numéro de port 8981.Pour modifier le port par défaut, mettez à jour la valeur deReporterAnalyzer.ODataServicePortdans le fichier ReporterAnalyzer.ini et redémarrez le service OData de CA NFA.Si NFA est intégré à CAPC, la nouvelle valeur de port est synchronisée dans le cycle d'interrogation suivant de CAPC ou vous pouvez effectuer une resynchronisation manuelle avec la source de données NFA.
- Resource PathLes ressources exposées par un service OData de CA NFA sont traitées par une URL de chemin de ressource correspondante, ce qui permet au client d'interagir avec un aspect de ressource.
- Query OptionsLa partie options de requête d'une URL OData spécifie trois types d'informations, à savoir les options de requête système, les options de requête personnalisées et les alias de paramètre.Les options de requête système sont des paramètres de chaîne de requête qui contrôlent la quantité et l'ordre des données renvoyées pour la ressource identifiée par l'URL. Le nom de toutes les options de requête système peut être précédé d'un caractère dollar ($). Les options de requête personnalisées fournissent un mécanisme extensible pour les informations spécifiques aux services à placer dans une chaîne de requête d'URL.
Exemple
:http://127.0.0.1:8981/path/SampleService.svc/Categories(1)/Products?$top=2&$orderby=Name