--- sourceDocument: Référence de l’API Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference Release : - xanadu ft:locale : - fr-FR ft:publication_title : - Référence de l’API Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Exemple d'API REST scriptée : exemples de scripts # Exemple d'API REST scriptée : exemples de scripts {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes de lecture Ces exemples montrent comment créer divers scripts de ressources pour une API REST scriptée. ## Paramètres de requête : exemple GET Cet exemple montre comment obtenir des valeurs de paramètre de requête à partir d'une requête. /** * GET - Sample Request API - Query Params */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { var uri = request.uri; var url = request.url; var queryParams = request.queryParams; var customHeader = request.getHeader('X-Custom'); return { "uri": uri, "url": url, "queryParams": queryParams, "customHeader": customHeader }; })(request, response); ## Paramètres de chemin d'accès : exemple GET Cet exemple montre comment obtenir les valeurs des paramètres de chemin à partir d'une requête. /** * GET - Sample Request API - Path Params */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { var uri = request.uri; var url = request.url; var path = request.pathParams; return { "uri": uri, "url": url, "path_params": path, "path.id": path.id }; })(request, response); ## Exemple GET de script include Cet exemple montre comment utiliser un include de script pour fournir une réponse. L'include de script vous permet de réutiliser le code courant et de maintenir la lisibilité dans les scripts de service REST. /** * GET - Sample Request API - Script Include */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { var responseObj = global.SampleDataUtil.getSampleJSON(); return responseObj; })(request, response); ## Exemple de chaîne POST Cet exemple montre comment analyser un message POST avec un corps de chaîne et envoyer une réponse basée sur la demande. /** * POST - Sample Request API - dataString * sample usage: * var requestBody = request.body; * var requestString = requestBody.dataString; */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { var requestBody = request.body; var requestString = requestBody.dataString; return {"requestString": requestString}; })(request, response); ## Exemple de POST binaire Cet exemple montre comment analyser un message POST avec un corps binaire et envoyer une réponse basée sur la requête. /** * POST - Sample Request API - Body */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { var body = request.body.data; //do any additional processing on the request body, such as inserting a new record. return { "body.id": body.id }; })(request, response); ## Exemple d'erreur inacceptable Cet exemple montre comment répondre en cas d'erreur inacceptable. Utilisez ce type d'erreur lorsque la valeur de l'en-tête Accepter la demande n'est pas prise en charge par le service Web. /** * Sample Not Acceptable Error Sample */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { response.setError(new sn_ws_err.NotAcceptableError('sample error message')); })(request, response); ## Exemple d'erreur de demande incorrecte Cet exemple montre comment répondre en cas d'erreur de requête incorrecte. Utilisez ce type d'erreur pour indiquer une erreur dans la syntaxe de la demande. /** * Bad Request Error Sample */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { response.setError(new sn_ws_err.BadRequestError('sample error message')); })(request, response); ## Exemple d'erreur de conflit Cet exemple montre comment réagir en cas d'erreur de conflit. Utilisez ce type d'erreur en cas de plusieurs demandes conflictuelles, telles que plusieurs mises à jour du même enregistrement. /** * Error Response: Conflict Error Sample */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { response.setError(new sn_ws_err.ConflictError('sample error message')); })(request, response); ## Exemple d'erreur introuvable Cet exemple montre comment répondre avec une erreur introuvable. Utilisez ce type d'erreur si la ressource demandée n'existe pas ou n'est pas disponible. /** * Error Response: Not Found Error Sample */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { response.setError(new sn_ws_err.NotFoundError('sample error message')); })(request, response); ## Exemple d'erreur de type de média non pris en charge Cet exemple montre comment réagir en cas d'erreur de type de média non pris en charge. Utilisez ce type d'erreur pour indiquer que le type de contenu de la demande n'est pas pris en charge. /** * Error Response: Unsupported Media Type Error Sample */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { response.setError(new sn_ws_err.UnsupportedMediaTypeError('sample error message')); })(request, response); ## Exemple d'erreur de service Cet exemple montre comment réagir en cas d'erreur de service générique. L'objet ServiceError vous permet de définir le code d'état, le message et le détail de l'erreur. Utilisez une erreur de service si les types d'erreur prédéfinis ne répondent pas à vos besoins. /** * Error Response: Custom Error Sample */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { var myError = new sn_ws_err.ServiceError(); myError.setStatus(418); myError.setMessage("I am a Teapot"); myError.setDetail("Here are the details about this error"); response.setError(myError); })(request, response); ## Exemple de script de ressource REST scripté Cet exemple de script de ressource de l'API REST analyse les valeurs et nameid du corps de la demande et renvoie ces valeurs dans la réponse. /** * POST - Sample Request API - Body */ (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { var body = request.body.data, id0,name0,id1,name1; name0 = body[0].name; // 'user0' id0 = body[0].id; // '1234' name1 = body[1].name; // 'user1' id1 = body[1].id; // '5678' return { "id": id0, "name": name0, "id1": id1, "name1": name1 }; })(request, response); ## Demandes L'API peut accepter les demandes XML et JSON.{#r_ScriptedRESTServiceScriptExamples__table_xkb_2vq_xs__entry__2} | Demande JSON | Demande XML | |-|-| | POST /api/sn_demo_api/v1/example/body HTTP/1.1 Content-Type: application/json Accept: application/json Host: .service-now.com Connection: close Content-Length: 91 [ { "name": "user0", "id": 1234 }, { "name": "user1", "id": 5678 } ] | POST /api/sn_demo_api/v1/example/body HTTP/1.1 Content-Type: application/xml Accept: application/json Host: .service-now.com Connection: close Content-Length: 152 user0 1234 user1 5678 | [Tableau 1. Demandes] {#r_ScriptedRESTServiceScriptExamples__table_xkb_2vq_xs} ## Réponses Les deux demandes spécifient application/json comme valeur d'en-tête Accepter. L'une ou l'autre des réponses utilise donc le formatage JSON, même si le type de contenu de la demande est XML. HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Date: Tue, 04 Aug 2015 15:20:44 GMT Server: ServiceNow Connection: close Set-Cookie: BIGipServerpool_=880838154.47166.0000; path=/ {"result":{"id":1234,"id1":5678,"name":"user0","name1":"user1"}}