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 URL
    Identifie 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.
  • Resource Path
    Les 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 Options
    La 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