Réponses

Les réponses se présentent sous la forme d'un document XML ou JSON, selon le type de valeur/MIME de l'en-tête Accept (Accepter) du client. Cette sortie flexible permet d’intégrer facilement les données de sortie dans le développement du client. Les réponses sont définies par le schéma Response.xsd.
casp1032
Les réponses se présentent sous la forme d'un document XML ou JSON, selon le type de valeur/MIME de l'en-tête Accept (Accepter) du client. Cette sortie flexible permet d’intégrer facilement les données de sortie dans le développement du client. Les réponses sont définies par le schéma Response.xsd.
L'API de services Web de
DX NetOps Spectrum
prend en charge les types de MIME application/XML et application/json dans l’en-tête Accept. Si vous choisissez la sortie JSON, vous devrez peut-être l’analyser et générer du code XML pour la demande suivante.
Les éléments suivants décrivent la sortie d’une réponse :
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <resource-response-list xmlns="http://www.ca.com/spectrum/restful/schema/response" error="<msg>" throttle="<num>" total-resource="<num>"> <resource-responses> ... </resource-responses> <link rel="next" href="http://<hostname><:portnumber>/spectrum/restful/alarms?id=<result_set_ID>&start=3&throttlesize=<num>" type="application/xml" /> </resource-response-list>
  • error="<
    msg
    >"
    Indique la réussite ou l’échec global de l’opération. En cas d’échec, des informations supplémentaires sont fournies. « EndOfResults » indique que tous les éléments de l'ensemble de résultats ont été renvoyés.
  • throttle="<
    num
    >"
    Indique le nombre d’éléments renvoyés dans cette réponse, comme spécifié par le paramètre throttlesize sur la demande. Si le nombre de limitation est inférieur au nombre total de résultats trouvés par le serveur, un lien suivant est fourni. Si l’ensemble complet de données est renvoyé, il n’y a pas de lien « next » (suivant).
  • total-
    resource
    ="<
    num
    >"
    Indique le nombre total d’éléments dans l’ensemble de résultats.
    La ressource
    varie en fonction du type de demande (par exemple, les alarmes, le paysage, le modèle et les modèles).
  • link rel="next" href="<
    URL
    >"
    Le lien « next » suivant s’affiche uniquement si des éléments supplémentaires sont conservés dans l'ensemble de résultats.
    Indique que des éléments supplémentaires restent dans l’ensemble de résultats et fournissent l’URL pour les obtenir en fonction de la valeur de limitation. Ce lien est conforme aux contraintes HATEOAS (hypermédia comme moteur de l’état de l’application) et peut être utilisé dans un client ou un navigateur pour envoyer la demande suivante. Grâce à ce lien, le coût total de l’appel d’origine est évité. L’emplacement est mis en cache sur le serveur OneClick et expire après dix minutes d’inactivité. Après expiration, l’URL renvoie la chaîne « The cursor is no longer valid » (le curseur n’est plus valide).
    Chaque appel RESTful a son propre cache.
    Les paramètres suivants s’affichent dans l’URL générée :
    • id=<
      result_set_ID
      >
      Spécifie l’emplacement de l’ensemble de résultats sur le serveur OneClick. Les données expirent après dix minutes d’inactivité.
    • start=<
      element_num
      >
      Indique la position de départ dans l’ensemble de résultats.
    • throttlesize
      Indique le nombre d’éléments à renvoyer dans la réponse suivante.
    Le format des paramètres dans le lien généré peut varier en fonction de votre environnement. Par exemple, « & » peut être généré comme « &amp; » en raison de différences entre les normes de formatage XML, HTTP et JSON.