API Gestion des changements

L’API Gestion des changements fournit des points de terminaison qui permettent l’intégration d’applications tierces ServiceNow Gestion des changements au processus.

En intégrant votre application au ServiceNow Gestion des changements processus, toutes les demandes de changement, quel que soit leur lieu d’origine, disposent d’une source unique de vérité, fournissant une source d’audit unique.

Utilisez cette API REST pour intégrer votre processus de gestion des changements avec des applications externes et lors du développement d’applications ServiceNow côté client.

Cette API REST permet aux intégrateurs de :

• Lancez une demande de changement standard à partir d’un modèle de demande de changement standard publié.
• Créez une demande de changement de type urgence ou normal.
• Mettez à jour n’importe quel champ existant dans la table de demande de changement pour toute demande de changement.
• Mettez à jour tout champ existant dans la table de tâches de changement et les tâches de travail de la création à la fermeture/l’annulation.
• Récupérez une demande de changement, un modèle standard, une tâche de demande de changement ou un modèle de changement spécifique.
• Récupérez plusieurs demandes de changement, modèles standard et tâches de demande de changement à l’aide de la pagination.
• Effectuez une évaluation des risques.
• Actualiser les services impactés.
• Générez et traitez toute activité d’approbation associée à une demande de changement.
• Identifiez les potentiels conflits de planification et identifiez les périodes où les conflits n’existent pas.
• Supprimez les demandes de changement, les tâches de demande de changement et les processus de vérification des conflits.
• Créez un enregistrement de demande de changement basé sur un enregistrement de modèle de changement.
• Récupère une liste des états disponibles pour la demande de changement spécifiée, y compris l’état actuel.

L’API Gestion des changements prend en charge les types ITIL et les modèles de changement à l’aide de Studio de workflow et Workflow. Les modèles de changement permettent d’obtenir des changements adaptés. Les types et les modèles définissent les critères de transition à respecter avant que la demande de changement puisse passer à l’état suivant. Vous pouvez définir ce critère à l’aide d’états, de workflows, d’outils et de règles métier.

• Types ITIL traditionnels : Standard, Urgence et Normal.
• États du modèle de changement : Nouveau, Planifié, Implémenter, Examiner et Fermé.

Vous pouvez configurer des modèles de changement supplémentaires au sein de votre ServiceNow instance, puis créer des demandes de changement basées sur ces modèles de changement à l’aide de points de terminaison de cette API. Utilisez les Gestion des changements : GET /sn_chg_rest/change/model/{sys_id} points de terminaison AND Gestion des changements - GET /sn_chg_rest/change/model pour obtenir les modèles de changement disponibles dans une instance. Utilisez ensuite pour Gestion des changements - POST /sn_chg_rest/change créer une demande de changement basée sur un modèle de changement spécifié.

Pour plus d’informations sur la configuration des modèles de changement, consultez Configurer Gestion des changements.

Les rôles suivants sont requis pour accéder aux points de terminaison de Gestion des changements :

• SUPPRIMER : change_manager ou administrateur
• GET : change_manager, ITIL, sn_change_read ou administrateur
• CORRECTIF/PUBLIER : change_manager, ITIL ou administrateur

En outre, les administrateurs peuvent définir des propriétés de changement pour configurer le comportement de Gestion des changements. Pour obtenir la liste de ces propriétés et une description de leurs fonctionnalités disponibles, consultez Propriétés de Gestion des changements.

Gestion des changements : DELETE /sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}

Supprime la tâche de demande de changement identifiée par le sys_ids spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task/{task_sys_id}

URL par défaut : /api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
change_sys_id	Sys_id de la demande de changement à laquelle la tâche est associée. Vérifie que la tâche est bien associée à la demande de changement spécifiée. Type de données : chaîne Table : Demande de changement [change_request]
task_sys_id	Sys_id de la tâche de demande de changement à supprimer. Type de données : chaîne Table : Tâches de changement [change_task]

Tableau 2. Paramètres de requête

Nom	Description
Néant

Tableau 3. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 5. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs (clé) avec leurs valeurs associées pour la tâche de demande de changement identifiée avant la suppression. Type de données : objet
parent	Informations concernant la demande de changement à laquelle cette tâche a été associée. Type de données : objet parent: { display_value: "String", value: "String" }
parent.display_value	Sys_id de la tâche parente à afficher dans une interface utilisateur. Type de données : chaîne
parent.valeur	Sys_id de la tâche parente. Type de données : chaîne
sys_id	Sys_id informations pour la demande de changement supprimée. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5" \
--request DELETE \
--header "Accept:application/json" \ 
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire both nodes",
        display_value: "Retire both nodes"
      }
    }
  ]
}

Gestion des changements : DELETE /sn_chg_rest/change/{sys_id}

Supprime la demande de changement associée au sys_id spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{sys_id}

URL par défaut : /api/sn_chg_rest/change/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de demande de changement à supprimer. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 8. Paramètres de requête

Nom	Description
Néant

Tableau 9. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 10. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 11. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Enregistrement de demande de changement qui a été supprimé. Chaque élément de cet objet correspond à un champ dans l’enregistrement de la table Demande de changement [change_request]. Type de données : objet

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

{
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Reboot the server at 6 am",
        "value": "Reboot the server at 6 am"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "b0dbda5347c12200e0ef563dbb9a718f",
        "value": "b0dbda5347c12200e0ef563dbb9a718f"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

Gestion des changements - DELETE /sn_chg_rest/change/{sys_id}/conflict

Annule le processus de vérification des conflits en cours pour la demande de changement spécifiée (sys_id).

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict

URL par défaut : /api/sn_chg_rest/change/{sys_id}/conflict

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de demande de changement pour lequel annuler le processus de vérification des conflits en cours d’exécution. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 14. Paramètres de requête

Nom	Description
Néant

Tableau 15. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 16. En-têtes de demandes

En-tête	Description
Néant

Tableau 17. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Échec de l’annulation de la demande.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
Néant

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request DELETE \
--user "username":"password"

None

Gestion des changements : DELETE /sn_chg_rest/change/emergency/{sys_id}

Supprime la demande de changement urgent identifiée par le sys_id spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}

URL par défaut : /api/sn_chg_rest/change/emergency/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement urgent à supprimer. Type de données : chaîne Table : Demande de changement [ change_request]

Tableau 20. Paramètres de requête

Nom	Description
Néant

Tableau 21. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 22. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 23. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 24. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État de la demande de changement avant la suppression. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans l’interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id informations pour la demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Urgence ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « urgence ». Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "b0dbda5347c12200e0ef563dbb9a718f", 
        display_value: "b0dbda5347c12200e0ef563dbb9a718f"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      },
    }, 
  ]
}

Gestion des changements : DELETE /sn_chg_rest/change/normal/{sys_id}

Supprime la demande de changement normal identifiée par le sys_id spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/normal/{sys_id}

URL par défaut : /api/sn_chg_rest/change/normal/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 25. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement normal à supprimer. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 26. Paramètres de requête

Nom	Description
Néant

Tableau 27. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 28. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 29. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 30. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État de la demande de changement avant la suppression. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans l’interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Changez le type à afficher dans l’interface utilisateur. La valeur est toujours « Normal ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « normal ». Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      },
    }, 
  ]
}

Gestion des changements : DELETE /sn_chg_rest/change/standard/{sys_id}

Supprime la demande de changement standard identifiée par le sys_id spécifié.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/standard/{sys_id}

URL par défaut : /api/sn_chg_rest/change/standard/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 31. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement standard à supprimer. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 32. Paramètres de requête

Nom	Description
Néant

Tableau 33. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 34. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 35. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 36. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs (clé) avec leurs valeurs associées pour la demande de changement identifiée.
État	État de la demande de changement avant la suppression. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans l’interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Identificateur unique de la demande de changement.

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "1c87925347c12200e0ef563dbb9a7177",
      state: {
        value: "-5", 
        display_value: "New"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
  ]
}

Gestion des changements : GET /sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule

Permet de récupérer les créneaux horaires disponibles par ID d’élément de configuration et durée, avec une option permettant d’inclure l’heure de début planifiée.

Rôle requis : sn_change_writer.

Remarque :

L’exécution de ce point de terminaison ne répertorie pas les heures de début et de fin disponibles. Utilisez le lien fourni dans la propriété corps worker.link de la réponse pour obtenir les données du calendrier.

Voir aussi :

• GET /sn_chg_rest/change/{change_sys_id}/schedule
• CORRECTIF /sn_chg_rest/change/{change_sys_id}/schedule/first_available

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/ci/{cmdb_ci_sys_id}/schedule

URL par défaut : /api/sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 37. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
cmdb_ci_sys_id	Sys_id de l’enregistrement de l’élément de configuration. Ce point de terminaison ne nécessite pas de demande de changement. Type de données : chaîne Table : éléments de configuration [cmdb_ci]

Tableau 38. Paramètres de requête

Nom	Description
duration_in_seconds	Durée du changement en secondes, c’est-à-dire le temps nécessaire pour terminer la tâche de demande de changement. Type de données : nombre entier
planned_start_time	Facultatif. Date et heure planifiées de début de l’implémentation de la demande de changement au format UTC. Récupérer le créneau horaire disponible commencer à ou après cette heure. Si elle n’est pas fournie, le système utilise l’heure actuelle comme heure de début. Format : aaaa-mm-jj hh :mm :ss Type de données : chaîne

Tableau 39. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 40. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 41. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 42. Codes d'état

Code d'état	Description
202	Le système a accepté la demande.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. Problèmes possibles : Impossible de trouver le cmdb_ci avec le sys_id fourni. L’enregistrement n’existe pas ou l’utilisateur n’a pas accès en lecture à celui-ci. La valeur du paramètre de requête duration_in_seconds n’a pas été fournie. Valeur de paramètre de requête duration_in_seconds ou planned_start_time non valide fournie.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
erreur	Informations sur les erreurs rencontrées lors du traitement de la demande de point de terminaison. Type de données : objet "error": { "detail": "String", "message": "String", "status": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message qui identifie l’erreur. Type de données : chaîne
messages	Informations du message. Type de données : objet "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
messages.errorMessages	Des messages d’erreur se sont produits lors du traitement de la demande. Type de données : tableau
messages.infoMessages	Messages d’information rencontrés lors du traitement de la demande. Type de données : tableau
messages.avertissementmessages	Des messages d’avertissement se sont produits lors du traitement de la demande. Type de données : tableau
Demande	Demande de point de terminaison d’origine. Type de données : chaîne
État	Informations sur l’état actuel du collaborateur. Type de données : objet state: { display_value: "String", value: Number }
state.display_value	Affichez la valeur de l’état de l’agent. Ces valeurs sont directement corrélées state.value au paramètre. Valeurs possibles : Terminé Erreur En cours En attente Type de données : chaîne
état.valeur	Valeur numérique de l’état du collaborateur. Valeurs possibles : 1 2 3 4 Type de données : nombre
type	Type de demande. Valeur valide : calendrier Type de données : chaîne
agent	Informations sur l’agent associé. Type de données : objet "worker": { "link": "String", "sysId": "String" }
worker.link	Lien pour récupérer les données de créneaux horaires. Utilisez les sys_id dans GET /sn_chg_rest/change/worker/{sys_id} pour afficher les résultats. Type de données : chaîne
worker.sysId	Sys_id de l’agent associé à la demande de changement. Type de données : chaîne
statut	S’affiche uniquement en cas d’erreur. État du traitement du point de terminaison. Valeur possible : échec Type de données : chaîne

Obtenir les créneaux horaires disponibles

Utilisez la valeur fournie dans le pour obtenir les détails de la fenêtre de worker.link calendrier. La valeur est au format suivant :

https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

Utilisez l’worker_sys_id dans GET /sn_chg_rest/change/worker/{sys_id} pour afficher les résultats.

Le corps de la réponse contient l’état et fournit des résultats lorsque le traitement est terminé.

Les résultats des paramètres du corps de réponse de l’agent varient en fonction de la disponibilité du créneau horaire.

• Si le créneau horaire fourni est disponible pour la demande de changement dans le créneau horaire du calendrier, l’API de l’agent répertorie les créneaux horaires disponibles dans la payload.spans propriété. Sinon, la payload.spans propriété n’est pas répertoriée dans les résultats.
• S’il n’y a pas de créneaux horaires disponibles pour la durée de la demande de changement fournie dans le créneau horaire de planification défini, ce messages.infoMessages qui suit : D
  Remarque :

  La valeur par défaut du créneau horaire de planification de la demande de changement est de 90 jours. Pour modifier cette valeur, modifiez la change.conflict.next_available.schedule_window propriété. Pour plus d’informations, consultez Configurer les propriétés de l’analyse des conflits.

L’exemple GET /sn_chg_rest/change/worker/{sys_id} suivant montre la sortie fournie à l’aide de l’ID fourni dans le détail de l’worker.link. Les résultats répertorient les périodes ouvertes disponibles pour la durée de la tâche.

{
  "result": {
    "worker": {
      "sysId": "d7d1f2b4a444b010f87712198fe9caae",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/d7d1f2b4a444b010f87712198fe9caae"
    },
    "request": "{\"cmdb_ci_sys_id\":\"82967cdd0ad3370236092104ce988d76\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    },
    "payload": {
      "spans": [
        {
          "start": {
            "value": "2021-05-15 08:00:00",
            "display_value": "2021-05-15 01:00:00"
          },
          "end": {
            "value": "2021-05-15 11:00:00",
            "display_value": "2021-05-15 04:00:00"
          }
        },
        {
          "start": {
            "value": "2021-05-22 08:00:00",
            "display_value": "2021-05-22 01:00:00"
          },
          "end": {
            "value": "2021-05-22 11:00:00",
            "display_value": "2021-05-22 04:00:00"
          }
        },
        ...
      ]
    }
  }
}

Demande cURL

curl "https://instance.service-now.com/api/sn_chg_rest/change/ci/<cmdb_ci_sys_id>/schedule?duration_in_seconds=10800" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Les résultats incluent worker.link détails que vous pouvez utiliser pour exécuter la sys_id fournie dans le point de terminaison GET /sn_chg_rest/change/worker/.

{
  "result": {
    "worker": {
      "sysId": "1049419c1b4c3010f58a6572604bcb7a",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/1049419c1b4c3010f58a6572604bcb7a"
    },
    "request": "{\"cmdb_ci_sys_id\":\"<cmdb_ci_sys_id>\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Gestion des changements : GET /sn_chg_rest/change

Récupère une ou plusieurs demandes de changement en fonction des critères spécifiés.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change

URL par défaut : /api/sn_chg_rest/change

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 43. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 44. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur à utiliser pour filtrer l’ensemble de résultats. Le nom est le champ dans lequel la valeur spécifiée est filtrée. Ce paramètre s’exclut mutuellement avec sysparm_query. Par exemple, au lieu d’utiliser &sysparm_query=active=true, vous pouvez simplifier l’instruction d’appel en utilisant &active=true. Vous pouvez également utiliser la valeur Display (Affichage) lorsque le champ est un champ de type choix ou référence, tel que &state=closed au lieu de &state=7. Pour spécifier plusieurs paires clé-valeur, séparez-les chacune par une esperluette, telle que &active=true&assigned_to=john.smith. Type de données : chaîne
order	Champ pour trier les demandes de changement renvoyées. Type de données : chaîne Par défaut : name
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez sysparm_offset=sysparm_offset+sysparm_limit jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : sysparm_query=<col_name><operator><value>. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : = : <col_name> correspond exactement à <value>. != : <col_name> ne correspond pas à <value>. LIKE : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ^ : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. ^OU : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. sysparm_query=caller_id=javascript :gs.getUserID()^active=true Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : TRIER PAR<col_name> ORDERBYDESC<col_name> Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur true pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne
Recherche de texte	Chaîne à utiliser pour rechercher tous les champs d’enregistrement de demande de changement normal. Cette recherche utilise la ServiceNow fonctionnalité de plateforme de recherche en texte intégral. Pour plus d’informations sur ServiceNow les fonctionnalités de recherche, voir Administration de Search. Par défaut : IR_AND_OR_QUERY

Tableau 45. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 46. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 47. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 48. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Élément	Description
résultat	Liste contenant un ou plusieurs objets d’enregistrement de demande de changement. Chaque objet décrit une demande de changement. Chaque élément de l’objet de demande de changement correspond à un champ dans son enregistrement associé dans la table Demande de changement [change_request]. Tous les éléments contiennent une valeur et display_value paires nom-valeur. Les champs Date contiennent également display_value_internal paires nom-valeur. Type de données : tableau
action_status	Statut de l’action actuelle de la demande de changement associée. Valeurs possibles : 1 : Bloqué en interne 2 : Bloqué par le client 3 : Bloqué en interne et par le client 4 : À surveiller Type de données : nombre
actif	Marqueur indiquant si la demande de changement est active. Valeurs possibles : vrai : la demande de changement est active faux : la demande de changement n’est pas active Type de données : booléennes Par défaut : true
activity_due	Date et heure auxquelles le ticket associé devrait être terminé. Type de données : chaîne
additional_assignee_list	Liste des sys_ids de personnes supplémentaires affectées au travail sur la demande de changement. Type de données : tableau
approval	Type de processus d’approbation requis. Type de données : chaîne Par défaut : non demandé
approval_history	Entrée de journal de l’historique des approbations la plus récente. Type de données : chaîne
approval_set	Date et heure de l’approbation de l’action associée. Type de données : chaîne
assigned_to	Sys_id de l’utilisateur affecté à la demande de changement. Type de données : chaîne
assignment_group	Sys_id du groupe affecté à la demande de changement. Type de données : chaîne
backout_plan	Description du plan à exécuter si le changement doit être inversé. Type de données : chaîne
business_duration	Durée des heures de travail planifiées, des jours de travail et des semaines de travail qu’il a fallu pour effectuer le changement. Type de données : chaîne
business_service	Sys_id du service d’entreprise associé à la demande de changement. Situé dans la table Service [cmdb_ci_service]. Type de données : chaîne
cab_date	Date à laquelle le Comité consultatif sur les changements (CAB) se réunit. Type de données : chaîne
cab_delegate	Sys_id de l’utilisateur qui peut remplacer le responsable CAB lors d’une réunion CAB. Situé dans la table Utilisateur [sys_user] Type de données : chaîne
cab_recommendation	Description des recommandations CAB pour la demande de changement. Type de données : chaîne Longueur maximale : 4 000
cab_required	Marqueur indiquant si le CAB est requis. Valeurs possibles : vrai : le comité consultatif sur les changements est requis. false : le comité consultatif sur les changements n’est pas obligatoire. Type de données : booléennes Valeur par défaut : false
calendar_duration	Non utilisé actuellement par Gestion des changements. Type de données : chaîne
catégorie	Catégorie du changement, par exemple matériel, réseau ou logiciel. Type de données : chaîne Par défaut : autre
change_plan	Activités et rôles de gestion et de contrôle de la demande de changement. Type de données : chaîne
chg_model	Sys_id du modèle de changement sur lequel la demande de changement associée était basée. Le modèle de changement définit le flux d’état, les transitions et les activités de processus qui doivent être effectuées pour la demande de changement. Type de données : chaîne Table : Modèle de changement [chg_model]
closed_at	Date et heure de fermeture de la demande de changement associée. Type de données : chaîne
closed_by	Sys_id de la personne ayant fermé la demande de changement. Type de données : chaîne Table : Utilisateur [sys_user]
close_code	Code affecté à la demande de changement lorsqu’elle a été fermée. Par exemple, Réussi, Réussi avec problèmes et Échec. Type de données : chaîne
close_notes	Notes que la personne a saisies lors de la fermeture de la demande de changement. Type de données : chaîne
cmdb_ci	Sys_id de l’élément de configuration associé à la demande de changement. Type de données : chaîne Table : Élément de configuration [cmdb_ci]
commentaires	Liste des notes de travail destinées aux clients saisies dans la demande de changement associée. Type de données : tableau
comments_and_work_notes	Liste des notes de travail internes et destinées aux clients saisies pour la demande de changement associée. Type de données : tableau Longueur maximale : 4 000
company	Sys_id de la société associée à la demande de changement. Type de données : chaîne Table : Société [core_company]
conflict_last_run	Date et heure de la dernière exécution du script de détection de conflit sur la demande de changement. Type de données : chaîne
conflict_status	État actuel des conflits tel que détecté par le script de détection de conflit, tel que Conflit et Non exécuté. Type de données : chaîne Longueur maximale : 40 Par défaut : non exécuté
contact_type	Méthode dans laquelle la demande de changement a été initialement demandée. Valeurs possibles : messagerie instantanée e-mail Téléphone social Web Type de données : chaîne
contrat	Sys_id du contrat associé à la demande de changement. Type de données : chaîne Table : Contrat [ast_contract]
correlation_display	Nom convivial du correlation_idfichier . Type de données : chaîne Longueur maximale : 100
correlation_id	ID unique global (GUID) d’un enregistrement de demande de changement correspondant dans un système tiers. Type de données : chaîne Longueur maximale : 100
delivery_plan	N’est plus utilisé. Sys_id du plan d’exécution associé à la demande de changement. Type de données : chaîne Table : Plan d’exécution [sc_cat_item_delivery_plan]
delivery_task	N’est plus utilisé. Sys_id de la tâche de livraison associée à la demande de changement. Type de données : chaîne Table : tâche de plan d’exécution [sc_cat_item_delivery_task]
description	Description détaillée de la demande de changement. Type de données : chaîne Longueur maximale : 4 000
due_date	Date d’échéance de la tâche. Non utilisé par le processus de demande de changement. Type de données : chaîne
end_date	Date et heure auxquelles la demande de changement doit être terminée. Type de données : chaîne
escalade	Niveau d'escalade actuel. Valeurs possibles : 0 : normal 1 : Modéré 2 : Élevé 3 : En retard Type de données : nombre (entier) Par défaut : 0
expected_start	Date et heure de début de la tâche. Non utilisé par le processus de demande de changement. Type de données : chaîne
follow_up	Date et heure auxquelles un utilisateur a fait un suivi auprès de la personne qui demande la demande de changement. Type de données : chaîne
group_list	Liste des sys_ids et des noms des groupes associés à la demande de changement. Type de données : tableau Longueur maximale : 4 000
impact	L’impact sur la demande de changement se fera sentir sur le client. Valeurs possibles : 1 : Élevé 2 : Moyenne 3 : Faible Type de données : nombre (entier) Par défaut : 3
implementation_plan	Étapes séquentielles à exécuter pour implémenter ce changement. Il contient également toutes les dépendances entre les étapes et les détails du cessionnaire pour chaque étape. Type de données : chaîne Longueur maximale : 4 000
justification	Avantages de la mise en œuvre de ce changement et de l’impact si ce changement n’est pas implémenté. Type de données : chaîne Longueur maximale : 4 000
base de connaissances	Marqueur indiquant si des articles de la base de connaissances ()KB sont associés à la demande de changement. Valeurs possibles : vrai : articles de la base de connaissances associés faux : aucun article de base de connaissances associé Type de données : booléennes
Emplacement	Sys_id et nom de l’emplacement de l’équipement référencé dans la demande de changement. Type de données : chaîne Table : Emplacement [cmn_location]
made_sla	N’est plus utilisé. Marqueur indiquant si la demande de changement a été implémentée conformément à l’accord sur les niveaux de service associé. Type de données : booléennes
needs_attention	Marqueur indiquant si la demande de changement requiert une attention. Valeurs possibles : vrai : la demande de changement requiert une attention particulière. faux : la demande de changement ne nécessite pas d’attention supplémentaire. Type de données : booléennes Valeur par défaut : false
Numéro	Numéro de changement affecté à la demande de changement par le système, tel que CHG0040007. Type de données : chaîne
on_hold	Marqueur indiquant si la demande de changement est actuellement en suspens. Valeurs possibles : vrai : en suspens false : pas en attente Type de données : booléennes Valeur par défaut : false
on_hold_reason	Si le on_hold paramètre est défini sur « vrai », description de la raison pour laquelle la demande de changement est bloquée. Type de données : chaîne Longueur maximale : 4 000
on_hold_task	Si le on_hold paramètre est défini sur true, liste des sys_ids des tâches qui doivent être accomplies avant que la suspension ne soit levée. Type de données : chaîne Longueur maximale : 4 000
opened_at	Date et heure de création de la version du changement. Type de données : chaîne
opened_by	Sys_id et nom de l’utilisateur qui a créé la version du changement. Type de données : chaîne Table : Utilisateur [sys_user]
order	Non utilisé par Gestion des changements. Champ numérique facultatif pour trier les enregistrements, par exemple lors de leur récupération à partir d’une base de données. Type de données : nombre (entier)
outside_maintenance_schedule	Marqueur indiquant si une maintenance par une société externe a été planifiée pour la demande de changement. Valeurs possibles : vrai : hors de la maintenance planifiée faux : aucune maintenance externe planifiée Type de données : booléennes Valeur par défaut : false
parent	Sys_id et nom de la tâche parente de cette demande de changement, le cas échéant. Type de données : chaîne Table : Tâche [task]
phase	Phase actuelle de la demande de changement. Cela définit l’effet du changement plus en détail. Valeurs possibles : accept build plan Demandé Type de données : chaîne
phase_state	Change_phase enregistrements qui doivent être créés pour un changement. Ils dépendent de la catégorie, de sorte que chaque type de changement peut avoir des enregistrements de change_phase différents. Les enregistrements change_phase permettent de contrôler le processus d’approbation, car chaque change_phase peut avoir un calendrier et un ensemble d’approbateurs. Valeurs possibles : terminé En suspens ouvert rejeté Demandé travail en cours Type de données : chaîne
Priorité	Priorité de la demande de changement. Valeurs possibles : 1 : Critique 2 : Élevé 3 : Modéré 4 : Faible Type de données : nombre (entier) Par défaut : 4
production_system	Marqueur indiquant si la demande de changement concerne une ServiceNow instance qui se trouve dans un environnement de production. Valeurs possibles : vrai : environnement de production faux : environnement de non-production Type de données : booléennes
motif	Description du motif pour lequel la demande de changement a été lancée. Valeurs possibles : Besoins professionnels Mise à niveau matérielle Législation Changement d'emplacement Configuration réseau requise CI nouveau ou supprimé Autre Problème résolu Produit ou service modifié Mise à niveau logicielle Demandé par l’utilisateur Type de données : chaîne Longueur maximale : 40
reassignment_count	Nombre de fois où la demande de changement a été réaffectée à un nouveau propriétaire. Type de données : nombre (entier) Par défaut : 0
rejection_goto	Sys_id de la tâche à effectuer si la demande de changement est rejetée. Type de données : chaîne Table : Tâche [task]
requested_by	Sys_id de l’utilisateur ayant demandé le changement. Type de données : chaîne Table : Utilisateur [sys_user]
requested_by_date	Date et heure auxquelles le changement doit être implémenté. Type de données : chaîne
review_comments	Commentaires saisis lors de l’examen de la demande de changement. Type de données : chaîne Longueur maximale : 4 000
review_date	Date à laquelle la demande de changement a été examinée. Type de données : chaîne
review_status	État actuel de la demande de changement demandée, examen. Type de données : chaîne
risk	Niveau de risque associé à la demande de changement. Valeurs valides : 1 : Élevé 2 : Modéré 3 : Faible Type de données : nombre Par défaut : 3
risk_impact_analysis	Description du risque et analyse de l’implémentation de la demande de changement. Type de données : chaîne Longueur maximale : 4 000
route_reason	Non utilisé actuellement par Gestion des changements. Motif du transfert de la demande de changement. Valeurs possibles : 1 : Transférer avec résolution 9 : Transfert sans résolutions Type de données : nombre
périmètre	Taille de la demande de changement. Valeurs possibles : 1 : Massif 2 : Grand 3 : Moyen 4 : Petit 5 : Minuscule Type de données : nombre Par défaut : 3
service_offering	Sys_id de l’offre de service associée à la demande de changement. Les offres de service définissent uniquement le niveau de service en termes de disponibilité, de portée, de tarification et d’options de package. Type de données : chaîne Table : Offre [service_offering]
short_description	Description de la demande de changement. Type de données : chaîne Longueur maximale : 40
compétences	Liste des sys_ids de toutes les compétences requises pour implémenter la demande de changement. Type de données : tableau Table : Compétence [cmn_skill]
sla_due	N’est plus utilisé. Date et heure auxquelles la demande de changement doit être terminée sur la base de l’accord sur les niveaux de service associé. Type de données : chaîne
sn_esign_document	Sys_id de tout document signé électroniquement joint à la demande de changement. Type de données : chaîne Table : pièce jointe [sys_attachment]
sn_esign_esignature_configuration	Sys_id du modèle de signature électronique utilisé pour le document associé. Type de données : chaîne Tableau : Modèle de signature électronique [sn_esign_configuration]
start_date	Date et heure planifiées de début de l’implémentation de la demande de changement. Type de données : chaîne
État	État actuel de la demande de changement. Les valeurs possibles sont définies dans le modèle de changement. Type de données : nombre (entier) Par défaut : 1
std_change_producer_version	Sys_id du créateur d’enregistrement et de la proposition de changement associés à la demande de changement. Il comprend également le nombre et le pourcentage de demandes de changement approuvées et rejetées créées à partir de la proposition. Type de données : chaîne Table : version du modèle de changement standard [std_change_producer_version]
sys_class_name	Nom de la table dans laquelle se trouve la demande de changement. Type de données : chaîne
sys_created_by	Nom de l’utilisateur qui a initialement créé la demande de changement. Type de données : chaîne Longueur maximale : 40
sys_created_on	Date et heure de création initiale de l’enregistrement de demande de changement associé. Type de données : chaîne
sys_domain	Si des domaines sont utilisés dans l’instance, le nom du domaine auquel l’enregistrement du module de changement est associé. Type de données : chaîne
sys_domain_path	Si des domaines sont utilisés dans l’instance, le chemin de domaine dans lequel se trouve l’enregistrement du module de changement associé. Type de données : chaîne
sys_id	Identificateur unique de l’enregistrement de demande de changement associé. Type de données : chaîne
sys_mod_count	Nombre de mises à jour apportées au ticket depuis sa création initiale. Type de données : nombre (entier)
sys_updated_by	Personne ayant mis à jour le ticket pour la dernière fois. Type de données : chaîne Longueur maximale : 40
sys_updated_on	Date et heure de la dernière mise à jour du ticket. Type de données : chaîne
task_effective_number	Numéro de demande universelle. Type de données : chaîne Longueur maximale : 40
task_for	Non utilisé par Gestion des changements. Sys_id de l’utilisateur pour lequel la tâche a été créée. Type de données : chaîne Table : Utilisateur [sys_user]
test_plan	Description du plan de tests associé pour le changement. Type de données : chaîne Longueur maximale : 4 000
time_worked	Temps total de travail sur la demande de changement. Type de données : chaîne
type	Type de demande de changement. Valeurs possibles : Urgence normal de série Type de données : chaîne Longueur maximale : 40
Non autorisé	Marqueur indiquant si la demande de changement n’est pas autorisée Valeurs possibles : vrai : non autorisé faux : autorisé Type de données : booléennes
universal_request	Sys_id de la demande universelle parente à laquelle cette demande de changement appartient. Type de données : chaîne Table : Tâche [task]
upon_approval	Action à exécuter si la demande de changement est approuvée. Valeurs possibles : do_nothing Poursuivre Type de données : chaîne Longueur maximale : 40 Par défaut : continuer
upon_reject	Action à exécuter si la demande de changement est rejetée. Valeurs possibles : annuler goto Type de données : chaîne Longueur maximale : 40 Par défaut : annuler
urgence	Urgence de la demande de changement. Valeurs possibles : 1 : Élevé 2 : Moyenne 3 : Faible Type de données : nombre (entier) Par défaut : 3
user_input	Entrée utilisateur supplémentaire. Type de données : chaîne Longueur maximale : 4 000
variables	Paires nom-valeur des variables associées à la demande de changement. Type de données : chaîne Longueur maximale : 40
watch_list	Liste des sys_ids des utilisateurs qui reçoivent des notifications sur cette demande de changement lorsque des commentaires supplémentaires sont ajoutés ou si l’état d’une demande de changement est défini sur Résolu ou Fermé. Type de données : tableau Table : Utilisateur [sys_user]
wf_activity	Sys_id de l’enregistrement d’activité du workflow associé à la demande de changement. Type de données : chaîne Table : activité du workflow [wf_activity]
work_end	Date et heure de fin du travail sur la demande de changement. Type de données : chaîne
work_notes	Informations sur la façon de résoudre la demande de changement ou les mesures prises pour la résoudre. Type de données : chaîne Longueur maximale : 4 000
work_notes_list	Liste des sys_ids des utilisateurs internes qui reçoivent des notifications sur cette demande de changement lorsque des notes de travail sont ajoutées. Type de données : tableau Table : Utilisateur [sys_user]
work_start	Date et heure auxquelles le travail a commencé sur la demande de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Par souci de concision, les résultats ne contiennent qu’un seul enregistrement de demande de changement.

{
  "result": [
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Clear BGP sessions on a Cisco router",
        "value": "Clear BGP sessions on a Cisco router"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "1766f1de47410200e90d87e8dee490f6",
        "value": "1766f1de47410200e90d87e8dee490f6"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
  ]
}

Gestion des changements : GET /sn_chg_rest/change/{change_sys_id}/nextstates

Récupère une liste des états disponibles pour la demande de changement spécifiée, y compris l’état actuel.

S’il est disponible, il indique également comment passer à l’état suivant en fonction de la version de Gestion des changements implémentée. Si les changements sont pilotés par le modèle de changement, le point de terminaison renvoie les conditions qui ont réussi ou non. Il fournit également des informations indiquant si toutes les conditions ont été remplies pour une transition donnée. Ces informations ne sont pas disponibles pour les demandes de changement héritées et pilotées par type.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/{change_sys_id}/nextstates

URL par défaut : /api/sn_chg_rest/change/{change_sys_id}/nextstates

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 49. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
change_sys_id	Sys_id de la demande de changement. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 50. Paramètres de requête

Nom	Description
Néant

Tableau 51. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 52. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 53. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 54. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
404	Introuvable. L’élément demandé est introuvable.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
available_states	Les valeurs des états disponibles pour la demande de changement spécifiée, y compris l’état actuel. Type de données : tableau
state_label	Paires clé-valeur qui associent des étiquettes aux états disponibles. Type de données : objet
state_transitions	Informations sur ce qui est requis pour passer à chaque état disponible. Chaque « à déclarer » disponible distinct est dans son propre tableau, chaque ensemble différent de conditions pour cet état étant dans son propre objet. Type de données : tableau "state_transitions": [ { "automatic_transition": Boolean, "conditions": [Array], "display_value": "String", "from_state": "String", "sys_id": "String", "to_state": "String", "transition_available": Boolean } ]
state_transitions.transition_automatique	Marqueur indiquant s’il faut effectuer automatiquement une transition vers cet état. Valeurs valides : vrai : la demande de changement passe automatiquement à cet état. faux : la demande de changement ne passe pas automatiquement à cet état. Type de données : booléennes
state_transitions.conditions	Liste des conditions associées à l’état. Type de données : tableau d’objets "conditions": [ { "condition": {Object}, "passed": Boolean } ]
state_transitions.conditions.condition	Valeurs d’une condition spécifique. Type de données : objet "condition": { "description": "String", "name": "String", "sys_id": "String" }
state_transitions.conditions.condition.description	Description de la condition. Type de données : chaîne
state_transitions.conditions.condition.name	Nom de la condition. Type de données : chaîne
state_transitions.conditions.condition.sys_id	Sys_id de la condition. Type de données : chaîne
state_transitions.conditions.passées	Marqueur indiquant si la demande de changement répond à la condition associée. Valeurs valides : vrai : remplit la condition. faux : n’a pas satisfait à la condition.
state_transitions.valeur_affichage	Description de l’état affichée. Type de données : chaîne
state_transitions.from_state	Valeur de l’état à partir duquel la demande de changement effectue la transition. Type de données : chaîne
state_transitions.sys_id	Sys_id de l’état de transition. Type de données : chaîne
state_transitions.à_l’état	Valeur de l’état vers lequel la demande de changement transite. Type de données : chaîne
state_transitions.transition_available	Marqueur indiquant si la demande de changement peut passer de l’état actuel à cet état. Valeurs valides : vrai : transition possible vers cet état. faux : impossible d’effectuer la transition vers cet état.

Demande cURL

L’exemple de code suivant montre comment appeler ce point de terminaison.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f"/nextstates \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Renvoyer les résultats :

{
  "result": {
    "available_states": [ "0", "4", "-1" ], // State values
    "state_transitions": [
      [
        {
          "sys_id": "7a0d2ccdc343101035ae3f52c1d3ae2e", // sttrm_state_transition sys id
          "display_value": "Implement to Review",
          "from_state": "-1",
          "to_state": "0",
          "transition_available": false, // If true, can move to this state
          "automatic_transition": true, // If true, automatically moves to this state
          "conditions": [
            {
              "passed": false, // If true, change request met this condition
              "condition": {
                "name": "No active Change Tasks",
                "description": null,
                "sys_id": "3c1d2ccdc343101035ae3f52c1d3aea4"
              }
            }
          ]
        },
        {
          "sys_id": "db401481c343101035ae3f52c1d3aedd",
          "display_value": "Implement to Review",
          "from_state": "-1",
          "to_state": "0",
          "transition_available": true,
          "automatic_transition": false,
          "conditions": [
            {
              "passed": true,
              "condition": {
                "name": "Not On hold",
                "description": null,
                "sys_id": "2132deb6c303101035ae3f52c1d3ae8c"
              }
            }
          ]
        }
      ],
      [
        {
          "sys_id": "5327c551c343101035ae3f52c1d3aeec",
          "display_value": "Implement to Canceled",
          "from_state": "-1",
          "to_state": "4",
          "transition_available": true,
          "automatic_transition": false,
          "conditions": []
        }
      ]
    ],
    "state_label": { // state value to label pairs
      "0": "Review",
      "4": "Canceled",
      "-1": "Implement"
    }
  }
}

Gestion des changements - GET /sn_chg_rest/change/{change_sys_id}/schedule

Permet de récupérer les créneaux horaires disponibles pour une demande de changement.

Rôle requis : sn_change_writer.

Remarque :

L’exécution de ce point de terminaison ne répertorie pas les heures de début et de fin disponibles. Utilisez le lien fourni dans la propriété corps worker.link de la réponse pour obtenir les données du calendrier.

Voir aussi :

• GET /sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule
• CORRECTIF /sn_chg_rest/change/{change_sys_id}/schedule/first_available

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{change_sys_id}/schedule

URL par défaut : /api/sn_chg_rest/change/{change_sys_id}/schedule

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 55. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
change_sys_id	Sys_id de la demande de changement sur laquelle trouver le prochain créneau horaire disponible. La demande de changement sélectionnée doit avoir un élément de configuration (cmdb_ci) avec des heures de début et de fin planifiées. Table : Demande de changement [change_request]

Tableau 56. Paramètres de requête

Nom	Description
Néant

Tableau 57. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 58. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 59. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 60. Codes d'état

Code d'état	Description
202	Le système a accepté la demande.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. Problèmes possibles : Les heures de début et de fin planifiées sont manquantes dans la demande de changement spécifiée. La demande de changement spécifiée n’a pas d’élément de configuration associé (cmdb_ci). L’utilisateur n’a pas accès en lecture aux champs de la demande de changement.
404	Introuvable. L’enregistrement spécifié est introuvable. Problèmes possibles : Le système ne peut pas trouver la demande de changement d’après les informations fournies. L’utilisateur n’a pas accès en lecture à l’enregistrement.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
erreur	Informations sur les erreurs rencontrées lors du traitement de la demande de point de terminaison. Type de données : objet "error": { "detail": "String", "message": "String", "status": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message qui identifie l’erreur. Type de données : chaîne
messages	Informations du message. Type de données : objet "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
messages.errorMessages	Des messages d’erreur se sont produits lors du traitement de la demande. Type de données : tableau
messages.infoMessages	Messages d’information rencontrés lors du traitement de la demande. Type de données : tableau
messages.avertissementmessages	Des messages d’avertissement se sont produits lors du traitement de la demande. Type de données : tableau
Demande	Demande de point de terminaison d’origine. Type de données : chaîne
État	Informations sur l’état actuel du collaborateur. Type de données : objet state: { display_value: "String", value: Number }
state.display_value	Affichez la valeur de l’état de l’agent. Ces valeurs sont directement corrélées state.value au paramètre. Valeurs possibles : Terminé Erreur En cours En attente Type de données : chaîne
état.valeur	Valeur numérique de l’état du collaborateur. Valeurs possibles : 1 2 3 4 Type de données : nombre
type	Type de demande. Valeur valide : calendrier Type de données : chaîne
agent	Informations sur l’agent associé. Type de données : objet "worker": { "link": "String", "sysId": "String" }
worker.link	Lien pour récupérer les données de créneaux horaires. Utilisez les sys_id dans GET /sn_chg_rest/change/worker/{sys_id} pour afficher les résultats. Type de données : chaîne
worker.sysId	Sys_id de l’agent associé à la demande de changement. Type de données : chaîne
statut	S’affiche uniquement en cas d’erreur. État du traitement du point de terminaison. Valeur possible : échec Type de données : chaîne

Obtenir les créneaux horaires disponibles

Utilisez la valeur fournie dans le pour obtenir les détails de la fenêtre de worker.link calendrier. La valeur est au format suivant :

https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

Utilisez l’worker_sys_id dans GET /sn_chg_rest/change/worker/{worker_sys_id} pour afficher les résultats.

Le corps de la réponse contient l’état et fournit des résultats lorsque le traitement est terminé.

Les résultats des paramètres du corps de réponse de l’agent varient en fonction de la disponibilité du créneau horaire.

• Si le créneau horaire fourni est disponible pour la demande de changement dans le créneau horaire du calendrier, l’API de l’agent répertorie les créneaux horaires disponibles dans la payload.spans propriété. Sinon, la payload.spans propriété n’est pas répertoriée dans les résultats.
• S’il n’y a pas de créneaux horaires disponibles pour la durée de la demande de changement fournie dans le créneau horaire de planification défini, ce messages.infoMessages qui suit : D
  Remarque :

  La valeur par défaut du créneau horaire de planification de la demande de changement est de 90 jours. Pour modifier cette valeur, modifiez la change.conflict.next_available.schedule_window propriété. Pour plus d’informations, consultez Configurer les propriétés de l’analyse des conflits.

L’exemple GET /sn_chg_rest/change/worker/{sys_id} suivant montre la sortie fournie à l’aide de l’ID fourni dans le détail de l’worker.link. Les résultats répertorient les périodes ouvertes disponibles pour la durée de la tâche.

{
  "result": {
    "worker": {
      "sysId": "9b3f62e0a4c87010f87712198fe9cad1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    },
    "payload": {
      "spans": [
        {
          "start": {
            "value": "2021-05-08 08:00:00",
            "display_value": "2021-05-08 01:00:00"
          },
          "end": {
            "value": "2021-05-08 11:00:00",
            "display_value": "2021-05-08 04:00:00"
          }
        },
        {
          "start": {
            "value": "2021-05-15 08:00:00",
            "display_value": "2021-05-15 01:00:00"
          },
          "end": {
            "value": "2021-05-15 11:00:00",
            "display_value": "2021-05-15 04:00:00"
          }
        },
        ...
      ]
    }
  }
}

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/change/{change_sys_id}/schedule" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Les résultats incluent worker.link détails que vous pouvez utiliser pour exécuter la sys_id fournie dans le point de terminaison GET /sn_chg_rest/change/worker/.

{
  "result": {
    "worker": {
      "sysId": "9b3f62e0a4c87010f87712198fe9cad1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Gestion des changements : GET /sn_chg_rest/change/{change_sys_id}/task

Récupère une ou plusieurs tâches associées à une demande de changement spécifiée en fonction des critères spécifiés.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task

URL par défaut : /api/sn_chg_rest/change/{change_sys_id}/task

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 61. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
change_sys_id	Sys_id de la demande de changement dont les tâches doivent être récupérées. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 62. Paramètres de requête

Nom	Description
Paires clé-valeur	Champs à modifier lors de la création de la demande. La clé est le nom de champ dans le modèle et la valeur est les informations à renseigner dans le champ. Champs qui ne peuvent pas être modifiés et qui sont ignorés s’ils sont transmis : Règles métier Champs en lecture seule tels que définis dans les ACL Champs qui n’existent pas Type de données : chaîne
order	Champ pour trier les demandes de changement renvoyées. Type de données : chaîne
sysparm_limit	Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset . Type de données : nombre Par défaut : 500
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez sysparm_offset=sysparm_offset+sysparm_limit jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : sysparm_query=<col_name><operator><value>. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : = : <col_name> correspond exactement à <value>. != : <col_name> ne correspond pas à <value>. LIKE : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ^ : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. ^OU : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. sysparm_query=caller_id=javascript :gs.getUserID()^active=true Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : TRIER PAR<col_name> ORDERBYDESC<col_name> Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur true pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne
Recherche de texte	Chaîne à utiliser pour rechercher tous les champs d’enregistrement de tâche de changement. Cette recherche utilise la ServiceNow fonctionnalité de plateforme de recherche en texte intégral et est définie par défaut sur IR_AND_OR_QUERY. Type de données : chaîne

Tableau 63. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 64. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 65. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 66. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs (clé) avec leurs valeurs associées pour la tâche de demande de changement identifiée avant la suppression. Type de données : objet
parent	Informations relatives à la demande de changement associée à la tâche. Type de données : objet parent: { display_value: "String", value: "String" }
parent.display_value	Informations de demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
parent.valeur	Sys_id de la demande de changement associée à la tâche. Type de données : chaîne
sys_id	Sys_id d’informations pour la tâche de demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la tâche de demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la tâche de demande de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
    result: [
        {
            sys_id: {
                value: "12629ec4b750230096c3e4f6ee11a9d5",
                display_value: "12629ec4b750230096c3e4f6ee11a9d5"
            },
            parent: {
                value: "0f4ac6c4b750230096c3e4f6ee11a9fe ", 
                display_value: "CHG0033046 "
            },
            ..., // all valid fields in record, example below
            short_description: {
                value: "Retire node",
                display_value: "Retire node"
            }
        }, 
        { // next record found }, ... // and so on
    ]
}

Gestion des changements - GET /sn_chg_rest/change/{sys_id}

Récupère la demande de changement identifiée par le sys_id spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{sys_id}

URL par défaut : /api/sn_chg_rest/change/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 67. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de la demande de changement. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 68. Paramètres de requête

Nom	Description
Néant

Tableau 69. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 70. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 71. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 72. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Élément	Description
résultat	Liste contenant un ou plusieurs objets d’enregistrement de demande de changement. Chaque objet décrit une demande de changement. Chaque élément de l’objet de demande de changement correspond à un champ dans son enregistrement associé dans la table Demande de changement [change_request]. Tous les éléments contiennent une valeur et display_value paires nom-valeur. Les champs Date contiennent également display_value_internal paires nom-valeur. Type de données : tableau
action_status	Statut de l’action actuelle de la demande de changement associée. Valeurs possibles : 1 : Bloqué en interne 2 : Bloqué par le client 3 : Bloqué en interne et par le client 4 : À surveiller Type de données : nombre
actif	Marqueur indiquant si la demande de changement est active. Valeurs possibles : vrai : la demande de changement est active faux : la demande de changement n’est pas active Type de données : booléennes Par défaut : true
activity_due	Date et heure auxquelles le ticket associé devrait être terminé. Type de données : chaîne
additional_assignee_list	Liste des sys_ids de personnes supplémentaires affectées au travail sur la demande de changement. Type de données : tableau
approval	Type de processus d’approbation requis. Type de données : chaîne Par défaut : non demandé
approval_history	Entrée de journal de l’historique des approbations la plus récente. Type de données : chaîne
approval_set	Date et heure de l’approbation de l’action associée. Type de données : chaîne
assigned_to	Sys_id de l’utilisateur affecté à la demande de changement. Type de données : chaîne
assignment_group	Sys_id du groupe affecté à la demande de changement. Type de données : chaîne
backout_plan	Description du plan à exécuter si le changement doit être inversé. Type de données : chaîne
business_duration	Durée des heures de travail planifiées, des jours de travail et des semaines de travail qu’il a fallu pour effectuer le changement. Type de données : chaîne
business_service	Sys_id du service d’entreprise associé à la demande de changement. Situé dans la table Service [cmdb_ci_service]. Type de données : chaîne
cab_date	Date à laquelle le Comité consultatif sur les changements (CAB) se réunit. Type de données : chaîne
cab_delegate	Sys_id de l’utilisateur qui peut remplacer le responsable CAB lors d’une réunion CAB. Situé dans la table Utilisateur [sys_user] Type de données : chaîne
cab_recommendation	Description des recommandations CAB pour la demande de changement. Type de données : chaîne Longueur maximale : 4 000
cab_required	Marqueur indiquant si le CAB est requis. Valeurs possibles : vrai : le comité consultatif sur les changements est requis. false : le comité consultatif sur les changements n’est pas obligatoire. Type de données : booléennes Valeur par défaut : false
calendar_duration	Non utilisé actuellement par Gestion des changements. Type de données : chaîne
catégorie	Catégorie du changement, par exemple matériel, réseau ou logiciel. Type de données : chaîne Par défaut : autre
change_plan	Activités et rôles de gestion et de contrôle de la demande de changement. Type de données : chaîne
chg_model	Sys_id du modèle de changement sur lequel la demande de changement associée était basée. Le modèle de changement définit le flux d’état, les transitions et les activités de processus qui doivent être effectuées pour la demande de changement. Type de données : chaîne Table : Modèle de changement [chg_model]
closed_at	Date et heure de fermeture de la demande de changement associée. Type de données : chaîne
closed_by	Sys_id de la personne ayant fermé la demande de changement. Type de données : chaîne Table : Utilisateur [sys_user]
close_code	Code affecté à la demande de changement lorsqu’elle a été fermée. Par exemple, Réussi, Réussi avec problèmes et Échec. Type de données : chaîne
close_notes	Notes que la personne a saisies lors de la fermeture de la demande de changement. Type de données : chaîne
cmdb_ci	Sys_id de l’élément de configuration associé à la demande de changement. Type de données : chaîne Table : Élément de configuration [cmdb_ci]
commentaires	Liste des notes de travail destinées aux clients saisies dans la demande de changement associée. Type de données : tableau
comments_and_work_notes	Liste des notes de travail internes et destinées aux clients saisies pour la demande de changement associée. Type de données : tableau Longueur maximale : 4 000
company	Sys_id de la société associée à la demande de changement. Type de données : chaîne Table : Société [core_company]
conflict_last_run	Date et heure de la dernière exécution du script de détection de conflit sur la demande de changement. Type de données : chaîne
conflict_status	État actuel des conflits tel que détecté par le script de détection de conflit, tel que Conflit et Non exécuté. Type de données : chaîne Longueur maximale : 40 Par défaut : non exécuté
contact_type	Méthode dans laquelle la demande de changement a été initialement demandée. Valeurs possibles : messagerie instantanée e-mail Téléphone social Web Type de données : chaîne
contrat	Sys_id du contrat associé à la demande de changement. Type de données : chaîne Table : Contrat [ast_contract]
correlation_display	Nom convivial du correlation_idfichier . Type de données : chaîne Longueur maximale : 100
correlation_id	ID unique global (GUID) d’un enregistrement de demande de changement correspondant dans un système tiers. Type de données : chaîne Longueur maximale : 100
delivery_plan	N’est plus utilisé. Sys_id du plan d’exécution associé à la demande de changement. Type de données : chaîne Table : Plan d’exécution [sc_cat_item_delivery_plan]
delivery_task	N’est plus utilisé. Sys_id de la tâche de livraison associée à la demande de changement. Type de données : chaîne Table : tâche de plan d’exécution [sc_cat_item_delivery_task]
description	Description détaillée de la demande de changement. Type de données : chaîne Longueur maximale : 4 000
due_date	Date d’échéance de la tâche. Non utilisé par le processus de demande de changement. Type de données : chaîne
end_date	Date et heure auxquelles la demande de changement doit être terminée. Type de données : chaîne
escalade	Niveau d'escalade actuel. Valeurs possibles : 0 : normal 1 : Modéré 2 : Élevé 3 : En retard Type de données : nombre (entier) Par défaut : 0
expected_start	Date et heure de début de la tâche. Non utilisé par le processus de demande de changement. Type de données : chaîne
follow_up	Date et heure auxquelles un utilisateur a fait un suivi auprès de la personne qui demande la demande de changement. Type de données : chaîne
group_list	Liste des sys_ids et des noms des groupes associés à la demande de changement. Type de données : tableau Longueur maximale : 4 000
impact	L’impact sur la demande de changement se fera sentir sur le client. Valeurs possibles : 1 : Élevé 2 : Moyenne 3 : Faible Type de données : nombre (entier) Par défaut : 3
implementation_plan	Étapes séquentielles à exécuter pour implémenter ce changement. Il contient également toutes les dépendances entre les étapes et les détails du cessionnaire pour chaque étape. Type de données : chaîne Longueur maximale : 4 000
justification	Avantages de la mise en œuvre de ce changement et de l’impact si ce changement n’est pas implémenté. Type de données : chaîne Longueur maximale : 4 000
base de connaissances	Marqueur indiquant si des articles de la base de connaissances ()KB sont associés à la demande de changement. Valeurs possibles : vrai : articles de la base de connaissances associés faux : aucun article de base de connaissances associé Type de données : booléennes
Emplacement	Sys_id et nom de l’emplacement de l’équipement référencé dans la demande de changement. Type de données : chaîne Table : Emplacement [cmn_location]
made_sla	N’est plus utilisé. Marqueur indiquant si la demande de changement a été implémentée conformément à l’accord sur les niveaux de service associé. Type de données : booléennes
needs_attention	Marqueur indiquant si la demande de changement requiert une attention. Valeurs possibles : vrai : la demande de changement requiert une attention particulière. faux : la demande de changement ne nécessite pas d’attention supplémentaire. Type de données : booléennes Valeur par défaut : false
Numéro	Numéro de changement affecté à la demande de changement par le système, tel que CHG0040007. Type de données : chaîne
on_hold	Marqueur indiquant si la demande de changement est actuellement en suspens. Valeurs possibles : vrai : en suspens false : pas en attente Type de données : booléennes Valeur par défaut : false
on_hold_reason	Si le on_hold paramètre est défini sur « vrai », description de la raison pour laquelle la demande de changement est bloquée. Type de données : chaîne Longueur maximale : 4 000
on_hold_task	Si le on_hold paramètre est défini sur true, liste des sys_ids des tâches qui doivent être accomplies avant que la suspension ne soit levée. Type de données : chaîne Longueur maximale : 4 000
opened_at	Date et heure de création de la version du changement. Type de données : chaîne
opened_by	Sys_id et nom de l’utilisateur qui a créé la version du changement. Type de données : chaîne Table : Utilisateur [sys_user]
order	Non utilisé par Gestion des changements. Champ numérique facultatif pour trier les enregistrements, par exemple lors de leur récupération à partir d’une base de données. Type de données : nombre (entier)
outside_maintenance_schedule	Marqueur indiquant si une maintenance par une société externe a été planifiée pour la demande de changement. Valeurs possibles : vrai : hors de la maintenance planifiée faux : aucune maintenance externe planifiée Type de données : booléennes Valeur par défaut : false
parent	Sys_id et nom de la tâche parente de cette demande de changement, le cas échéant. Type de données : chaîne Table : Tâche [task]
phase	Phase actuelle de la demande de changement. Cela définit l’effet du changement plus en détail. Valeurs possibles : accept build plan Demandé Type de données : chaîne
phase_state	Change_phase enregistrements qui doivent être créés pour un changement. Ils dépendent de la catégorie, de sorte que chaque type de changement peut avoir des enregistrements de change_phase différents. Les enregistrements change_phase permettent de contrôler le processus d’approbation, car chaque change_phase peut avoir un calendrier et un ensemble d’approbateurs. Valeurs possibles : terminé En suspens ouvert rejeté Demandé travail en cours Type de données : chaîne
Priorité	Priorité de la demande de changement. Valeurs possibles : 1 : Critique 2 : Élevé 3 : Modéré 4 : Faible Type de données : nombre (entier) Par défaut : 4
production_system	Marqueur indiquant si la demande de changement concerne une ServiceNow instance qui se trouve dans un environnement de production. Valeurs possibles : vrai : environnement de production faux : environnement de non-production Type de données : booléennes
motif	Description du motif pour lequel la demande de changement a été lancée. Valeurs possibles : Besoins professionnels Mise à niveau matérielle Législation Changement d'emplacement Configuration réseau requise CI nouveau ou supprimé Autre Problème résolu Produit ou service modifié Mise à niveau logicielle Demandé par l’utilisateur Type de données : chaîne Longueur maximale : 40
reassignment_count	Nombre de fois où la demande de changement a été réaffectée à un nouveau propriétaire. Type de données : nombre (entier) Par défaut : 0
rejection_goto	Sys_id de la tâche à effectuer si la demande de changement est rejetée. Type de données : chaîne Table : Tâche [task]
requested_by	Sys_id de l’utilisateur ayant demandé le changement. Type de données : chaîne Table : Utilisateur [sys_user]
requested_by_date	Date et heure auxquelles le changement doit être implémenté. Type de données : chaîne
review_comments	Commentaires saisis lors de l’examen de la demande de changement. Type de données : chaîne Longueur maximale : 4 000
review_date	Date à laquelle la demande de changement a été examinée. Type de données : chaîne
review_status	État actuel de la demande de changement demandée, examen. Type de données : chaîne
risk	Niveau de risque associé à la demande de changement. Valeurs valides : 1 : Élevé 2 : Modéré 3 : Faible Type de données : nombre Par défaut : 3
risk_impact_analysis	Description du risque et analyse de l’implémentation de la demande de changement. Type de données : chaîne Longueur maximale : 4 000
route_reason	Non utilisé actuellement par Gestion des changements. Motif du transfert de la demande de changement. Valeurs possibles : 1 : Transférer avec résolution 9 : Transfert sans résolutions Type de données : nombre
périmètre	Taille de la demande de changement. Valeurs possibles : 1 : Massif 2 : Grand 3 : Moyen 4 : Petit 5 : Minuscule Type de données : nombre Par défaut : 3
service_offering	Sys_id de l’offre de service associée à la demande de changement. Les offres de service définissent uniquement le niveau de service en termes de disponibilité, de portée, de tarification et d’options de package. Type de données : chaîne Table : Offre [service_offering]
short_description	Description de la demande de changement. Type de données : chaîne Longueur maximale : 40
compétences	Liste des sys_ids de toutes les compétences requises pour implémenter la demande de changement. Type de données : tableau Table : Compétence [cmn_skill]
sla_due	N’est plus utilisé. Date et heure auxquelles la demande de changement doit être terminée sur la base de l’accord sur les niveaux de service associé. Type de données : chaîne
sn_esign_document	Sys_id de tout document signé électroniquement joint à la demande de changement. Type de données : chaîne Table : pièce jointe [sys_attachment]
sn_esign_esignature_configuration	Sys_id du modèle de signature électronique utilisé pour le document associé. Type de données : chaîne Tableau : Modèle de signature électronique [sn_esign_configuration]
start_date	Date et heure planifiées de début de l’implémentation de la demande de changement. Type de données : chaîne
État	État actuel de la demande de changement. Les valeurs possibles sont définies dans le modèle de changement. Type de données : nombre (entier) Par défaut : 1
std_change_producer_version	Sys_id du créateur d’enregistrement et de la proposition de changement associés à la demande de changement. Il comprend également le nombre et le pourcentage de demandes de changement approuvées et rejetées créées à partir de la proposition. Type de données : chaîne Table : version du modèle de changement standard [std_change_producer_version]
sys_class_name	Nom de la table dans laquelle se trouve la demande de changement. Type de données : chaîne
sys_created_by	Nom de l’utilisateur qui a initialement créé la demande de changement. Type de données : chaîne Longueur maximale : 40
sys_created_on	Date et heure de création initiale de l’enregistrement de demande de changement associé. Type de données : chaîne
sys_domain	Si des domaines sont utilisés dans l’instance, le nom du domaine auquel l’enregistrement du module de changement est associé. Type de données : chaîne
sys_domain_path	Si des domaines sont utilisés dans l’instance, le chemin de domaine dans lequel se trouve l’enregistrement du module de changement associé. Type de données : chaîne
sys_id	Identificateur unique de l’enregistrement de demande de changement associé. Type de données : chaîne
sys_mod_count	Nombre de mises à jour apportées au ticket depuis sa création initiale. Type de données : nombre (entier)
sys_updated_by	Personne ayant mis à jour le ticket pour la dernière fois. Type de données : chaîne Longueur maximale : 40
sys_updated_on	Date et heure de la dernière mise à jour du ticket. Type de données : chaîne
task_effective_number	Numéro de demande universelle. Type de données : chaîne Longueur maximale : 40
task_for	Non utilisé par Gestion des changements. Sys_id de l’utilisateur pour lequel la tâche a été créée. Type de données : chaîne Table : Utilisateur [sys_user]
test_plan	Description du plan de tests associé pour le changement. Type de données : chaîne Longueur maximale : 4 000
time_worked	Temps total de travail sur la demande de changement. Type de données : chaîne
type	Type de demande de changement. Valeurs possibles : Urgence normal de série Type de données : chaîne Longueur maximale : 40
Non autorisé	Marqueur indiquant si la demande de changement n’est pas autorisée Valeurs possibles : vrai : non autorisé faux : autorisé Type de données : booléennes
universal_request	Sys_id de la demande universelle parente à laquelle cette demande de changement appartient. Type de données : chaîne Table : Tâche [task]
upon_approval	Action à exécuter si la demande de changement est approuvée. Valeurs possibles : do_nothing Poursuivre Type de données : chaîne Longueur maximale : 40 Par défaut : continuer
upon_reject	Action à exécuter si la demande de changement est rejetée. Valeurs possibles : annuler goto Type de données : chaîne Longueur maximale : 40 Par défaut : annuler
urgence	Urgence de la demande de changement. Valeurs possibles : 1 : Élevé 2 : Moyenne 3 : Faible Type de données : nombre (entier) Par défaut : 3
user_input	Entrée utilisateur supplémentaire. Type de données : chaîne Longueur maximale : 4 000
variables	Paires nom-valeur des variables associées à la demande de changement. Type de données : chaîne Longueur maximale : 40
watch_list	Liste des sys_ids des utilisateurs qui reçoivent des notifications sur cette demande de changement lorsque des commentaires supplémentaires sont ajoutés ou si l’état d’une demande de changement est défini sur Résolu ou Fermé. Type de données : tableau Table : Utilisateur [sys_user]
wf_activity	Sys_id de l’enregistrement d’activité du workflow associé à la demande de changement. Type de données : chaîne Table : activité du workflow [wf_activity]
work_end	Date et heure de fin du travail sur la demande de changement. Type de données : chaîne
work_notes	Informations sur la façon de résoudre la demande de changement ou les mesures prises pour la résoudre. Type de données : chaîne Longueur maximale : 4 000
work_notes_list	Liste des sys_ids des utilisateurs internes qui reçoivent des notifications sur cette demande de changement lorsque des notes de travail sont ajoutées. Type de données : tableau Table : Utilisateur [sys_user]
work_start	Date et heure auxquelles le travail a commencé sur la demande de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Clear BGP sessions on a Cisco router",
        "value": "Clear BGP sessions on a Cisco router"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "1766f1de47410200e90d87e8dee490f6",
        "value": "1766f1de47410200e90d87e8dee490f6"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

Gestion des changements - GET /sn_chg_rest/change/{sys_id}/ci

Récupère plusieurs éléments de configuration (CI) associés à une demande de changement spécifiée en fonction du type d’association spécifié.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/{sys_id}/ci

URL par défaut : /api/sn_chg_rest/change/{sys_id}/ci

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 73. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement pour laquelle renvoyer les CI CMDB associés. Type de données : chaîne

Tableau 74. Paramètres de requête

Nom	Description
association_type	Requis. Type d’association entre le CI CMDB et la demande de changement. Valeurs valides : affectés : CI affectés par la demande de changement impactés : services impactés par la demande de changement offre : offres de services impactées Type de données : chaîne
paires nom-valeur	Paires nom-valeur à utiliser pour filtrer l’ensemble de résultats. Le nom est le champ dans lequel la valeur spécifiée est filtrée. Ce paramètre s’exclut mutuellement avec sysparm_query. Par exemple, au lieu d’utiliser &sysparm_query=active=true, vous pouvez simplifier l’instruction d’appel en utilisant &active=true. Vous pouvez également utiliser la valeur Display (Affichage) lorsque le champ est un champ de type choix ou référence, tel que &state=closed au lieu de &state=7. Pour spécifier plusieurs paires clé-valeur, séparez-les chacune par une esperluette, telle que &active=true&assigned_to=john.smith. Type de données : chaîne
sysparm_limit	Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset . Type de données : nombre Par défaut : 500
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez sysparm_offset=sysparm_offset+sysparm_limit jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : sysparm_query=<col_name><operator><value>. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : = : <col_name> correspond exactement à <value>. != : <col_name> ne correspond pas à <value>. LIKE : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ^ : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. ^OU : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. sysparm_query=caller_id=javascript :gs.getUserID()^active=true Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : TRIER PAR<col_name> ORDERBYDESC<col_name> Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur true pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne

Tableau 75. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 76. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 77. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 78. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. La réponse à l’erreur contient des messages pertinents pour aider à résoudre le problème.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
ci_item|cmdb_ci_service	Variables ci_item ou cmdb_ci_service, selon le type d’association. Type de données : tableau ci_item|cmdb_ci_service : { display_value: "String", value: "String" }
ci_item|cmdb_ci_service.valeur	Sys_id du ci_item ou du cmdb_ci_service. Type de données : chaîne
ci_item|cmdb_ci_service.valeur_affichage	Valeur d’affichage du ci_item ou du cmdb_ci_service. Type de données : chaîne
sys_id	Informations sur la demande de changement sys_id. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
<record_fields>	Tous les champs valides dans l’enregistrement du ci_item ou du cmdb_ci_service ; Table basée sur le type d’association. Type de données : objet

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci?association_type=affected" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
  result: [
    {
      sys_id: {
        value: "92b8544047810200e90d87e8dee490b0",
        display_value: "92b8544047810200e90d87e8dee490b0"
      },
      ci_item|cmdb_ci_service : {
        value: "3a27d4370a0a0bb4006316812bf45439", 
        display_value: "PS Apache01"
      },
      ..., // all valid fields in record, table based on association type
    }, 
    { // next record found }, ... // and so on
  ]
}

Gestion des changements - GET /sn_chg_rest/change/{sys_id}/conflict

Récupère l’état du processus de vérification des conflits de demandes de changement en cours d’exécution ou les résultats du dernier processus de vérification des conflits terminé pour la demande de changement spécifiée.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict

URL par défaut : /api/sn_chg_rest/change/{sys_id}/conflict

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 79. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement pour laquelle renvoyer l’état du processus de vérification des conflits en cours/terminé. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 80. Paramètres de requête

Nom	Description
Néant

Tableau 81. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 82. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 83. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 84. Codes d'état

Code d'état	Description
200	État actuel du processus de vérification des conflits ; y compris les conflits s’il y a lieu.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
conflits	Liste des conflits trouvés pour la demande de changement. Un objet vide indique qu’aucun conflit n’a été détecté. Type de données : tableau
job_status	État de la tâche de vérification des conflits réelle. Type de données : chaîne
last_run	Date et heure auxquelles le dernier processus de vérification des conflits a commencé. Type de données : chaîne
record_count	Nombre d’enregistrements vérifiés. Type de données : chaîne
statut	Résultat du processus de vérification des conflits, tel que « Conflit » ou « Non exécuté ». Remarque : Même si la demande de changement ne comporte aucun conflit, ce champ est défini sur « Conflit ». Toutefois, l’objet conflicts est vide. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Réponse réussie - aucun conflit

{
  result: {
    status: "Conflict",
    last_run": "2018-08-30 12:58:05",
    record_count: "1",
    job_status: "2",
    conflicts: []
  }
}

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Réponse réussie : avec conflits

{
  result: {
    status: "Conflict",
    last_run": "2018-08-30 12:58:05",
    record_count: "1",
    job_status: "2",
    conflicts: [
      {
        change: {
          display_value: "CHG0030001",
          value: "afbffb24b758230096c3e4f6ee11a972"
        },
        type: {
          display_value: "Not In Maintenance Window",
          value: "not_in_maintenance_window"
        }
        ..., // all valid fields in record, example below
      }
    ]
  }
}

Gestion des changements : GET /sn_chg_rest/change/emergency

Récupère une ou plusieurs demandes de changement urgent en fonction des critères spécifiés.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/emergency

URL par défaut : /api/sn_chg_rest/change/emergency

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 85. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 86. Paramètres de requête

Nom	Description
order	Champ pour trier les demandes de changement renvoyées. Type de données : chaîne Par défaut : nombre
sysparm_limit	Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset . Type de données : nombre Par défaut : 500
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez sysparm_offset=sysparm_offset+sysparm_limit jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : sysparm_query=<col_name><operator><value>. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : = : <col_name> correspond exactement à <value>. != : <col_name> ne correspond pas à <value>. LIKE : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ^ : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. ^OU : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. sysparm_query=caller_id=javascript :gs.getUserID()^active=true Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : TRIER PAR<col_name> ORDERBYDESC<col_name> Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur true pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne
Paires clé-valeur	Paires nom-valeur à utiliser pour filtrer l’ensemble de résultats. Le nom est le champ dans lequel la valeur spécifiée est filtrée. Ce paramètre s’exclut mutuellement avec sysparm_query. Par exemple, au lieu d’utiliser &sysparm_query=active=true, vous pouvez simplifier l’instruction d’appel en utilisant &active=true. Vous pouvez également utiliser la valeur Display (Affichage) lorsque le champ est un champ de type choix ou référence, tel que &state=closed au lieu de &state=7. Pour spécifier plusieurs paires clé-valeur, séparez-les chacune par une esperluette, telle que &active=true&assigned_to=john.smith. Type de données : chaîne
Recherche de texte	Chaîne à utiliser pour rechercher tous les champs d’enregistrement de demande de changement urgent. Cette recherche utilise la ServiceNow fonctionnalité de plateforme de recherche en texte intégral et est définie par défaut sur IR_AND_OR_QUERY. Type de données : chaîne

Tableau 87. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 88. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 89. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 90. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État de la demande de changement. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id informations pour la demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Urgence ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « urgence ». Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

Gestion des changements : GET /sn_chg_rest/change/emergency/{sys_id}

Récupère la demande de changement urgent identifiée par le sys_id spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}

URL par défaut : /api/sn_chg_rest/change/emergency/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 91. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement urgent à récupérer. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 92. Paramètres de requête

Nom	Description
Néant

Tableau 93. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 94. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 95. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 96. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État de la demande de changement. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id informations pour la demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Urgence ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « urgence ». Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "b0dbda5347c12200e0ef563dbb9a718f", 
        display_value: "b0dbda5347c12200e0ef563dbb9a718f"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      },
    },
  ]
}

Gestion des changements - GET /sn_chg_rest/change/model

Récupère un ou plusieurs modèles de changement en fonction des critères spécifiés.

Utilisez ce point de terminaison pour trouver le modèle de changement qui correspond le mieux à la demande de changement que vous essayez de créer. Pour plus d’informations, consultez Modèles de changement.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/model

URL par défaut : /api/sn_chg_rest/change/model

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 97. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 98. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur à utiliser pour filtrer l’ensemble de résultats. Le nom est le champ dans lequel la valeur spécifiée est filtrée. Ce paramètre s’exclut mutuellement avec sysparm_query. Par exemple, au lieu d’utiliser &sysparm_query=active=true, vous pouvez simplifier l’instruction d’appel en utilisant &active=true. Vous pouvez également utiliser la valeur Display (Affichage) lorsque le champ est un champ de type choix ou référence, tel que &state=closed au lieu de &state=7. Pour spécifier plusieurs paires clé-valeur, séparez-les chacune par une esperluette, telle que &active=true&assigned_to=john.smith. Type de données : chaîne
order	Champ permettant de trier les modèles de changement renvoyés. Type de données : chaîne Par défaut : name
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez sysparm_offset=sysparm_offset+sysparm_limit jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : sysparm_query=<col_name><operator><value>. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : = : <col_name> correspond exactement à <value>. != : <col_name> ne correspond pas à <value>. LIKE : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ^ : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. ^OU : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. sysparm_query=caller_id=javascript :gs.getUserID()^active=true Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : TRIER PAR<col_name> ORDERBYDESC<col_name> Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur true pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne
Recherche de texte	Chaîne à utiliser pour rechercher tous les champs d’enregistrement du modèle de changement. Cette recherche utilise la ServiceNow fonctionnalité de plateforme de recherche en texte intégral. Pour plus d’informations sur ServiceNow les fonctionnalités de recherche, voir Administration de Search. Type de données : chaîne Par défaut : IR_AND_OR_QUERY

Tableau 99. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 100. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 101. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 102. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Liste contenant un ou plusieurs objets d’enregistrement de modèle de changement. Chaque objet décrit un modèle de changement. Chaque élément de l’objet de modèle de changement correspond à un champ dans son enregistrement associé dans la table Modèle de changement [chg_model]. Tous les éléments contiennent une valeur et display_value paires nom-valeur. Certains contiennent display_value_internal paires nom-valeur. Type de données : tableau
résultat.actif	Marqueur indiquant si l’enregistrement de modèle de changement associé est actif et disponible au sein de l’instance. Valeurs valides : vrai : le modèle de changement est actif. faux : le modèle de changement n’est pas actif. Type de données : booléennes Par défaut : true
result.available_in_ui	Marqueur indiquant si l’enregistrement du modèle de changement associé est disponible dans l’interface utilisateur. Valeurs valides : vrai : le modèle de changement est disponible dans l’interface utilisateur. faux : le modèle de changement n’est pas disponible dans l’interface utilisateur. Type de données : booléennes Par défaut : true
résultat.couleur	Couleur du modèle de changement associé sur la page de destination de la demande de changement. Type de données : chaîne Par défaut : #cbcbcb
result.default_change_model	Marqueur indiquant si l’enregistrement de modèle de changement associé est le modèle de changement par défaut. Valeurs valides : true : valeur par défaut false : pas la valeur par défaut Type de données : booléennes Valeur par défaut : false
résultat.description	Brève description de l’objectif du modèle de changement. Type de données : chaîne Longueur maximale : 4 000
result.name	Nom du modèle de changement. Type de données : chaîne Longueur maximale : 200
result.record_preset	Paires nom-valeur des champs qui doivent être automatiquement renseignées, avec leurs valeurs associées, lorsqu’un nouvel enregistrement de demande de changement est créé. Les valeurs sont séparées par des symboles de caret. Par exemple : « type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automatisé : Change^EQ » Type de données : chaîne
result.state_field	Champ de liste de choix à partir duquel collecter les choix, en fonction de la valeur fournie dans table_name. Pour les modèles de changement, l’état est toujours défini. Type de données : chaîne
nom_classe_result.sys	Changez le nom de la table du module. Changez toujours de modèle/chg_model. Type de données : chaîne
result.sys_created_by	Nom de l’utilisateur qui a initialement créé l’enregistrement du module de changement associé. Type de données : chaîne
result.sys_created_on	Date et heure de création initiale de l’enregistrement du module de changement. Type de données : chaîne
result.sys_domaine	Si des domaines sont utilisés dans l’instance, le nom du domaine auquel l’enregistrement du module de changement est associé. Type de données : chaîne
result.sys_chemin_domaine	Si des domaines sont utilisés dans l’instance, le chemin de domaine dans lequel se trouve l’enregistrement du module de changement associé. Type de données : chaîne
result.sys_id	Identificateur unique de l’enregistrement de modèle de changement associé. Type de données : chaîne
result.sys_mod_count	Nombre de modifications de l’enregistrement de modèle de changement associé. Type de données : nombre
result.sys_nom	Nom du modèle de changement. Toujours identique au name paramètre. Type de données : chaîne
result.sys_balises	Balises système associées à l’enregistrement du modèle de changement. Type de données : chaîne
result.sys_updated_by	Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement de modèle de changement associé. Type de données : chaîne Longueur maximale : 40
result.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement du modèle de changement associé. Type de données : chaîne
result.table_name	Table qui définit le champ de la liste de choix à partir duquel recueillir les choix. Pour les modèles de changement, cette option est toujours définie sur « change_request ». Type de données : chaîne Longueur maximale : 80

Demande cURL

Cet exemple montre une demande d’obtention de tous les enregistrements de modèle de changement.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Par souci de brièveté, cette réponse ne montre qu’un seul objet de modèle de changement.

{
  "result": [
    {
      "record_preset": {
        "display_value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ",
        "value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ"
      },
      "color": {
        "display_value": "#488df4",
        "value": "#488df4"
      },
      "default_change_model": {
        "display_value": "false",
        "value": false
      },
      "sys_mod_count": {
        "display_value": "6",
        "value": 6.0
      },
      "description": {
        "display_value": "This model is intended to capture  a record of an automated change.  There are no approvals associated with this change model.\r\n",
        "value": "This model is intended to capture  a record of an automated change.  There are no approvals associated with this change model.\r\n"
      },
      "active": {
        "display_value": "true",
        "value": true
      },
      "sys_updated_on": {
        "display_value": "2020-10-02 06:24:24",
        "value": "2020-10-02 13:24:24",
        "display_value_internal": "2020-10-02 06:24:24"
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
        "table_name": {
        "display_value": "change_request",
        "value": "change_request"
      },
      "sys_class_name": {
        "display_value": "Change Model",
        "value": "chg_model"
      },
      "sys_id": {
        "display_value": "7840d2515323101034d1ddeeff7b12a6",
        "value": "7840d2515323101034d1ddeeff7b12a6"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "available_in_ui": {
        "display_value": "false",
        "value": false
      },
      "state_field": {
        "display_value": "state",
        "value": "state"
      },
      "sys_created_on": {
        "display_value": "2020-09-28 07:33:25",
        "value": "2020-09-28 14:33:25",
        "display_value_internal": "2020-09-28 07:33:25"
      },
      "name": {
        "display_value": "Change Registration",
        "value": "Change Registration"
      },
      "sys_name": {
        "display_value": "Change Registration",
        "value": "Change Registration"
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      }
    }
  ]
}

Gestion des changements : GET /sn_chg_rest/change/model/{sys_id}

Récupère le modèle de changement identifié par le sys_id spécifié.

Vous pouvez ensuite utiliser ce modèle de changement pour créer la demande de changement souhaitée. Pour plus d’informations sur les modèles de changement, voir Modèles de changement.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/model/{sys_id}

URL par défaut : /api/sn_chg_rest/change/model/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 103. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de l’enregistrement du modèle de changement à récupérer dans la table Modèle de changement [chg_model]. Type de données : chaîne

Tableau 104. Paramètres de requête

Nom	Description
Néant

Tableau 105. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 106. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 107. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 108. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Objet d’enregistrement du modèle de changement demandé. Chaque élément de cet objet correspond à un champ dans l’enregistrement de la table Modèle de changement [chg_model]. Tous les éléments contiennent value des display_value paires nom-valeur. Certains contiennent display_value_internal des paires nom-valeur. Type de données : objet
résultat.actif	Marqueur indiquant si l’enregistrement de modèle de changement associé est actif et disponible au sein de l’instance. Valeurs valides : vrai : le modèle de changement est actif. faux : le modèle de changement n’est pas actif. Type de données : booléennes Par défaut : true
result.available_in_ui	Marqueur indiquant si l’enregistrement du modèle de changement associé est disponible dans l’interface utilisateur. Valeurs valides : vrai : le modèle de changement est disponible dans l’interface utilisateur. faux : le modèle de changement n’est pas disponible dans l’interface utilisateur. Type de données : booléennes Par défaut : true
résultat.couleur	Couleur du modèle de changement associé sur la page de destination de la demande de changement. Type de données : chaîne Par défaut : #cbcbcb
result.default_change_model	Marqueur indiquant si l’enregistrement de modèle de changement associé est le modèle de changement par défaut. Valeurs valides : true : valeur par défaut false : pas la valeur par défaut Type de données : booléennes Valeur par défaut : false
résultat.description	Brève description de l’objectif du modèle de changement. Type de données : chaîne Longueur maximale : 4 000
result.name	Nom du modèle de changement. Type de données : chaîne Longueur maximale : 200
result.record_preset	Paires nom-valeur des champs qui doivent être automatiquement renseignées, avec leurs valeurs associées, lorsqu’un nouvel enregistrement de demande de changement est créé. Les valeurs sont séparées par des symboles de caret. Par exemple : « type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automatisé : Change^EQ » Type de données : chaîne
result.state_field	Champ de liste de choix à partir duquel collecter les choix, en fonction de la valeur fournie dans table_name. Pour les modèles de changement, l’état est toujours défini. Type de données : chaîne
nom_classe_result.sys	Changez le nom de la table du module. Changez toujours de modèle/chg_model. Type de données : chaîne
result.sys_created_by	Nom de l’utilisateur qui a initialement créé l’enregistrement du module de changement associé. Type de données : chaîne
result.sys_created_on	Date et heure de création initiale de l’enregistrement du module de changement. Type de données : chaîne
result.sys_domaine	Si des domaines sont utilisés dans l’instance, le nom du domaine auquel l’enregistrement du module de changement est associé. Type de données : chaîne
result.sys_chemin_domaine	Si des domaines sont utilisés dans l’instance, le chemin de domaine dans lequel se trouve l’enregistrement du module de changement associé. Type de données : chaîne
result.sys_id	Identificateur unique de l’enregistrement de modèle de changement associé. Type de données : chaîne
result.sys_mod_count	Nombre de modifications de l’enregistrement de modèle de changement associé. Type de données : nombre
result.sys_nom	Nom du modèle de changement. Toujours identique au name paramètre. Type de données : chaîne
result.sys_balises	Balises système associées à l’enregistrement du modèle de changement. Type de données : chaîne
result.sys_updated_by	Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement de modèle de changement associé. Type de données : chaîne Longueur maximale : 40
result.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement du modèle de changement associé. Type de données : chaîne
result.table_name	Table qui définit le champ de la liste de choix à partir duquel recueillir les choix. Pour les modèles de changement, cette option est toujours définie sur « change_request ». Type de données : chaîne Longueur maximale : 80

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model/c0efda5347c12200e0ef563dbb9a81e3" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "record_preset": {
      "display_value": "type=emergency^EQ",
      "value": "type=emergency^EQ"
    },
    "color": {
      "display_value": "#ea3423",
      "value": "#ea3423"
    },
    "default_change_model": {
      "display_value": "false",
      "value": false
    },
    "sys_mod_count": {
      "display_value": "2",
      "value": 2.0
    },
    "description": {
      "display_value": "ITIL Mode 1 Emergency Change",
      "value": "ITIL Mode 1 Emergency Change"
    },
    "active": {
      "display_value": "true",
      "value": true
    },
    "sys_updated_on": {
      "display_value": "2020-09-28 08:53:12",
      "value": "2020-09-28 15:53:12",
      "display_value_internal": "2020-09-28 08:53:12"
    },
    "sys_tags": {
      "display_value": "",
      "value": ""
    },
    "table_name": {
      "display_value": "change_request",
      "value": "change_request"
    },
    "sys_class_name": {
      "display_value": "Change Model",
      "value": "chg_model"
    },
    "sys_id": {
      "display_value": "c0efda5347c12200e0ef563dbb9a81e3",
      "value": "c0efda5347c12200e0ef563dbb9a81e3"
    },
    "sys_updated_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "available_in_ui": {
      "display_value": "true",
      "value": true
    },
    "state_field": {
      "display_value": "state",
      "value": "state"
    },
    "sys_created_on": {
      "display_value": "2020-09-04 09:16:03",
      "value": "2020-09-04 16:16:03",
      "display_value_internal": "2020-09-04 09:16:03"
    },
    "name": {
      "display_value": "Emergency",
      "value": "Emergency"
    },
    "sys_name": {
      "display_value": "Emergency",
      "value": "Emergency"
    },
    "sys_created_by": {
      "display_value": "admin",
      "value": "admin"
    }
  }
}

Gestion des changements : GET /sn_chg_rest/change/normal

Récupère une ou plusieurs demandes de changement normal en fonction des critères spécifiés.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/normal

URL par défaut : /api/sn_chg_rest/change/normal

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 109. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 110. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur à utiliser pour filtrer l’ensemble de résultats. Le nom est le champ dans lequel la valeur spécifiée est filtrée. Ce paramètre s’exclut mutuellement avec sysparm_query. Par exemple, au lieu d’utiliser &sysparm_query=active=true, vous pouvez simplifier l’instruction d’appel en utilisant &active=true. Vous pouvez également utiliser la valeur Display (Affichage) lorsque le champ est un champ de type choix ou référence, tel que &state=closed au lieu de &state=7. Pour spécifier plusieurs paires clé-valeur, séparez-les chacune par une esperluette, telle que &active=true&assigned_to=john.smith. Type de données : chaîne
order	Champ pour trier les demandes de changement renvoyées. Type de données : chaîne
sysparm_limit	Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset . Type de données : nombre Par défaut : 500
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez sysparm_offset=sysparm_offset+sysparm_limit jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : sysparm_query=<col_name><operator><value>. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : = : <col_name> correspond exactement à <value>. != : <col_name> ne correspond pas à <value>. LIKE : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ^ : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. ^OU : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. sysparm_query=caller_id=javascript :gs.getUserID()^active=true Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : TRIER PAR<col_name> ORDERBYDESC<col_name> Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur true pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne
Recherche de texte	Chaîne à utiliser pour rechercher tous les champs d’enregistrement de demande de changement normal. Cette recherche utilise la fonctionnalité de la plateforme de recherche en texte intégral ServiceNow et est définie par défaut sur IR_AND_OR_QUERY. Type de données : chaîne

Tableau 111. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 112. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 113. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 114. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État de la demande de changement avant la suppression. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id informations pour la demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Normal ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « normal ». Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    },
    { // next record found }, ... // and so on
  ]
}

Gestion des changements : GET /sn_chg_rest/change/normal/{sys_id}

Récupère la demande de changement normal identifiée par le sys_id spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/normal/{sys_id}

URL par défaut : /api/sn_chg_rest/change/normal/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 115. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement normal à récupérer. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 116. Paramètres de requête

Nom	Description
Néant

Tableau 117. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 118. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 119. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 120. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État de la demande de changement avant la suppression. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Normal ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « normal ». Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    },
  ]
}

Gestion des changements - GET /sn_chg_rest/change/standard

Récupère une ou plusieurs demandes de changement standard en fonction des critères spécifiés.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/standard

URL par défaut : /api/sn_chg_rest/change/standard

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 121. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 122. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur à utiliser pour filtrer l’ensemble de résultats. Le nom est le champ dans lequel la valeur spécifiée est filtrée. Ce paramètre s’exclut mutuellement avec sysparm_query. Par exemple, au lieu d’utiliser &sysparm_query=active=true, vous pouvez simplifier l’instruction d’appel en utilisant &active=true. Vous pouvez également utiliser la valeur Display (Affichage) lorsque le champ est un champ de type choix ou référence, tel que &state=closed au lieu de &state=7. Pour spécifier plusieurs paires clé-valeur, séparez-les chacune par une esperluette, telle que &active=true&assigned_to=john.smith. Type de données : chaîne
order	Champ pour trier les demandes de changement renvoyées. Type de données : chaîne
sysparm_limit	Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset . Type de données : chaîne Par défaut : 500
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez sysparm_offset=sysparm_offset+sysparm_limit jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : sysparm_query=<col_name><operator><value>. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : = : <col_name> correspond exactement à <value>. != : <col_name> ne correspond pas à <value>. LIKE : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ^ : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. ^OU : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. sysparm_query=caller_id=javascript :gs.getUserID()^active=true Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : TRIER PAR<col_name> ORDERBYDESC<col_name> Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur true pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne
Recherche de texte	Chaîne à utiliser pour rechercher tous les champs d’enregistrement de demande de changement standard. Cette recherche utilise la ServiceNow fonctionnalité de plateforme de recherche en texte intégral et est définie par défaut sur IR_AND_OR_QUERY. Type de données : chaîne

Tableau 123. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 124. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 125. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 126. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs (clé) avec leurs valeurs associées pour la demande de changement identifiée. Type de données : objet
État	État de la demande de changement avant la suppression. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id informations pour la demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Standard ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « standard ». Type de données : chaîne

Exemple de demande cURL

curl "https://instance.service-now.com/api/sn_chg_rest/v1/change/standard?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "standard",
        display_value: "Standard"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

Gestion des changements : GET /sn_chg_rest/change/standard/{sys_id}

Récupère la demande de changement standard identifiée par le sys_id spécifié.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/standard/{sys_id}

URL par défaut : /api/sn_chg_rest/change/standard/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 127. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement standard à récupérer. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 128. Paramètres de requête

Nom	Description
Néant

Tableau 129. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 130. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 131. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 132. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs (clé) avec leurs valeurs associées pour la demande de changement identifiée. Type de données : objet
État	État de la demande de changement avant la suppression. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id informations pour la demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne

Demande cURL

curl "https://https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
  ]
}

Gestion des changements : GET /sn_chg_rest/change/standard/template

Récupère un ou plusieurs modèles de changement standard en fonction des critères spécifiés.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/standard/template

URL par défaut : /api/sn_chg_rest/change/standard/template

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 133. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 134. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur à utiliser pour filtrer l’ensemble de résultats. Le nom est le champ dans lequel la valeur spécifiée est filtrée. Ce paramètre s’exclut mutuellement avec sysparm_query. Par exemple, au lieu d’utiliser &sysparm_query=active=true, vous pouvez simplifier l’instruction d’appel en utilisant &active=true. Vous pouvez également utiliser la valeur Display (Affichage) lorsque le champ est un champ de type choix ou référence, tel que &state=closed au lieu de &state=7. Pour spécifier plusieurs paires clé-valeur, séparez-les chacune par une esperluette, telle que &active=true&assigned_to=john.smith. Type de données : chaîne
order	Champ permettant de trier les modèles de changement standard renvoyés. Type de données : chaîne Par défaut : nombre
sysparm_limit	Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset . Type de données : nombre Par défaut : 500
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez sysparm_offset=sysparm_offset+sysparm_limit jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : sysparm_query=<col_name><operator><value>. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : = : <col_name> correspond exactement à <value>. != : <col_name> ne correspond pas à <value>. LIKE : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. ^ : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. ^OU : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. sysparm_query=caller_id=javascript :gs.getUserID()^active=true Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : TRIER PAR<col_name> ORDERBYDESC<col_name> Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur true pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne
Recherche de texte	Chaîne à utiliser pour rechercher tous les champs d’enregistrement de demande de changement standard. Cette recherche utilise la fonctionnalité de la plateforme de recherche en texte intégral ServiceNow et est définie par défaut sur IR_AND_OR_QUERY. Type de données : chaîne

Tableau 135. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 136. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 137. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 138. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs avec leurs valeurs associées pour le modèle de changement standard identifié. Type de données : objet
sys_id	Sys_id informations pour la demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne
modèle	Informations sur le modèle de changement standard. Type de données : objet template: { display_value: "String", value: "String" }
template.display_value	Informations sur le modèle à afficher dans l’interface utilisateur. Type de données : chaîne
template.value	Modèle sys_id. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "92b8544047810200e90d87e8dee490b0",
        display_value: "92b8544047810200e90d87e8dee490b0"
      },
      template : {
        value: "1c8e02ec47410200e90d87e8dee49057", 
        display_value: "Add network switch to datacenter cabinet"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Standard change template to add network switch to cabinet",
        display_value: "Standard change template to add network switch to cabinet"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

Gestion des changements : GET /sn_chg_rest/change/standard/template/{sys_id}

Récupère le modèle de changement standard identifié par le sys_id spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/standard/template/{sys_id}

URL par défaut : /api/sn_chg_rest/change/standard/template/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 139. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id du modèle de changement standard à récupérer. Type de données : chaîne Table : Modèle de changement standard [std_change_record_producer]

Tableau 140. Paramètres de requête

Nom	Description
Néant

Tableau 141. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 142. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 143. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 144. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs avec leurs valeurs associées pour le modèle de changement standard identifié. Type de données : objet
sys_id	Sys_id de la demande de changement. Type de données : chaîne
modèle	Informations sur le modèle de changement standard. Type de données : objet template: { display_value: "String", value: "String" }
template.display_value	Informations sur le modèle à afficher dans une interface utilisateur. Type de données : chaîne
template.value	Modèle sys_id. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template/92b8544047810200e90d87e8dee490b0" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "92b8544047810200e90d87e8dee490b0",
      template : {
        value: "1c8e02ec47410200e90d87e8dee49057", 
        display_value: "Add network switch to datacenter cabinet"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Standard change template to add network switch to cabinet",
        display_value: "Standard change template to add network switch to cabinet"
      },
    }, 
  ]
}

Gestion des changements : GET /sn_chg_rest/change/worker/{sys_id}

Récupère l’état, les informations et les erreurs actuels pour l’agent asynchrone spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/worker/{sys_id}

URL par défaut : /api/sn_chg_rest/{change/worker/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 145. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de l’agent asynchrone de Gestion des changements. Type de données : chaîne Table : Agent de Gestion des changements [chg_mgt_worker]

Tableau 146. Paramètres de requête

Nom	Description
Néant

Tableau 147. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 148. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 149. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 150. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
messages	Informations du message. Type de données : objet "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
messages.errorMessages	Des messages d’erreur se sont produits lors du traitement de la demande. Par exemple : Fourni CMDB_CI sys_id non valide Type de données : tableau
messages.infoMessages	Messages d’information rencontrés lors du traitement de la demande. Par exemple : CMDB_CI sys_id déjà associé à fourni. Type de données : tableau
messages.avertissementmessages	Des messages d’avertissement se sont produits lors du traitement de la demande. Par exemple : Un CMDB_CI sys_id non valide fourni. Type de données : tableau
charge utile	Charge utile unique fournie lors de l’utilisation d’un sys_id de travail à partir du corps de réponse réussi d’un point de terminaison de planification. GET /ci/{cmdb_ci_sys_id}/schedule GET /sn_chg_rest/change/{change_sys_id}/schedule "payload": { "spans": [Array] } Type de données : objet
charge.spans	Si un intervalle de temps est disponible pendant la durée indiquée dans le point de terminaison du calendrier, l’API de l’agent répertorie les intervalles de temps disponibles. "payload": { "spans": [ { "end": {Object}, "start": {Object} } ] } Type de données : tableau
charge.spans.début	"start": { "display_value": "String", "value": "String" } Type de données : objet
charge.spans.start.value	Date et heure planifiées de début de l’implémentation de la demande de changement. Type de données : chaîne
payload.spans.start.display_value	Affiche la valeur de l’heure de début de la demande de changement. Format d’heure : aaaa-mm-jj hh :mm :ss Type de données : chaîne
charge.spans.end	"end": { "display_value": "String", "value": "String" } Type de données : objet
charge.spans.end.value	Date et heure prévues pour l’achèvement de la demande de changement. Format d’heure : aaaa-mm-jj hh :mm :ss Type de données : chaîne
payload.spans.end.display_value	Affiche la valeur du délai d’exécution de la demande de changement. Type de données : chaîne
Demande	Demande de point de terminaison d’origine. Type de données : chaîne
État	Informations sur l’état actuel du collaborateur. Type de données : objet state: { display_value: "String", value: Number }
state.display_value	Affichez la valeur de l’état de l’agent. Ces valeurs sont directement corrélées state.value au paramètre. Valeurs possibles : Terminé Erreur En cours En attente Type de données : chaîne
état.valeur	Valeur numérique de l’état du collaborateur. Valeurs possibles : 1 2 3 4 Type de données : nombre
type	Type d’association entre le CI CMDB et la demande de changement. Type de données : chaîne
agent	Informations sur l’agent associé. Type de données : objet "worker": { "link": "String", "sysId": "String" }
worker.link	URL permettant de récupérer l’état de l’agent associé et d’autres informations pertinentes sur l’agent. Type de données : chaîne
worker.sysId	Sys_id de l’agent associé à la demande de changement. Type de données : chaîne
<other_params>	D’autres paramètres spécifiques au processus, tels que ignored_cmdb_ci_sys_ids.

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/worker/0644cd02dbec330084f07ffdbf9619c1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "worker": {
      "sysId": "0644cd02dbec330084f07ffdbf9619c1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/0644cd02dbec330084f07ffdbf9619c1"
    },
    "request": "{\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "impacted",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Gestion des changements : PATCH /sn_chg_rest/change/{sys_id}

Met à jour la demande de changement identifiée par le sys_id spécifié avec les paires clé-valeur dans le corps ou l’URL de la demande.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{sys_id}

URL par défaut : /api/sn_chg_rest/change/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 151. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement à modifier. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 152. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur représentant les champs à mettre à jour. Les paramètres du corps de la demande remplacent les paramètres de l’URL. Toutefois, les paramètres requis doivent être spécifiés dans l’URL. Type de données : chaîne
encrypted_fields	Liste des champs séparés par des virgules à chiffrer. Ces champs sont chiffrés avant d’être stockés dans l’enregistrement associé. Lorsqu’il est spécifié, le point de terminaison appelle la méthode GlideRecord setDisplayValue(), au lieu d’appeler la méthode setValue( ). Pour cette raison, vous pouvez également utiliser ce paramètre pour transmettre des valeurs d’affichage pour des champs non chiffrés, tels que des champs de référence ou de choix, au lieu de transmettre des sys_ids ou des valeurs. Type de données : chaîne

Tableau 153. Paramètres de corps de demande (XML ou JSON)

Nom	Description
données	Paires nom-valeur représentant le ou les champs à mettre à jour dans la demande de changement associée. Par exemple, pour mettre à jour le fichier de description courte, entrez une paire nom-valeur similaire à la suivante : --data « {\"short_description\ » : \"my short desc\ » } » \. Type de données : chaîne
encrypted_fields	Liste des champs séparés par des virgules à chiffrer. Ces champs sont chiffrés avant d’être stockés dans l’enregistrement associé. Lorsqu’il est spécifié, le point de terminaison appelle la méthode GlideRecord setDisplayValue(), au lieu d’appeler la méthode setValue( ). Pour cette raison, vous pouvez également utiliser ce paramètre pour transmettre des valeurs d’affichage pour des champs non chiffrés, tels que des champs de référence ou de choix, au lieu de transmettre des sys_ids ou des valeurs. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 154. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 155. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 156. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Enregistrement de demande de changement mis à jour. Chaque élément de cet objet correspond à un champ dans l’enregistrement de la table Demande de changement [change_request]. Tous les éléments contiennent value des display_value paires nom-valeur. Certains contiennent display_value_internal des paires nom-valeur. Type de données : objet

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"short_desription\": \"Reboot the server at 6 am\" }" \
--user "username":"password"

{
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Reboot the server at 6 am",
        "value": "Reboot the server at 6 am"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "b0dbda5347c12200e0ef563dbb9a718f",
        "value": "b0dbda5347c12200e0ef563dbb9a718f"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

Demande cURL

L’exemple suivant montre comment transmettre des champs chiffrés dans le corps de la demande.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"encrypted_fields\":\"short_description,description\",
    \"short_description\":\"my short desc\",
    \"description\":\"my desc\"
}" \
--user "username":"password"

Demande cURL

L’exemple suivant montre comment transmettre des champs chiffrés en tant que paramètres de requête.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"

Gestion des changements : PATCH /sn_chg_rest/change/{sys_id}/approvals

Permet à l’utilisateur actuel d’approuver ou de rejeter un enregistrement d’approbation de demande de changement pour la demande de changement spécifié.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{sys_id}/approvals

URL par défaut : /api/sn_chg_rest/change/{sys_id}/approvals

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 157. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement à laquelle l’approbation/le rejet s’applique. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 158. Paramètres de requête

Nom	Description
Néant

Tableau 159. Paramètres de corps de demande (XML ou JSON)

Nom	Description
commentaires	Requis si state est rejeté. Motif du rejet du changement. Type de données : chaîne
État	Requis. État d’approbation. Par exemple : --data « {\"state\ » : \"approved\"} » Valeurs valides : approuvé rejeté Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 160. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 161. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 162. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
400	Demande incorrecte. Indique un type de demande incorrecte, par exemple si l’utilisateur n’a pas le pouvoir d’approuver ou de rejeter la demande de changement.
500	Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État actuel de la demande de changement. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id de l’approbation/du rejet de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. Valeurs possibles : Urgence Normal Standard Type de données : chaîne
type.valeur	Valeur de type interne. Valeurs possibles : Urgence normal de série Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/approvals" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"approved\"}" \
--user "username":"password"

{
  result: [
    {
      sys_id: "0f4ac6c4b750230096c3e4f6ee11a9fe",
      state: {
        value: "-2", 
        display_value: "Scheduled"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, single parameter example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
    }
  ]
}

Gestion des changements : PATCH /sn_chg_rest/change/{change_sys_id}/schedule/first_available

Met à jour les heures de début et de fin planifiées d’une demande de changement à l’aide du premier créneau horaire disponible trouvé.

Rôle requis : sn_change_writer.

Remarque :

Utilisez le lien fourni dans la propriété Response Body (Corps worker.link de la réponse) pour afficher l’état du calendrier.

Voir aussi :

• GET /sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule
• GET /sn_chg_rest/change/{change_sys_id}/schedule

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/{change_sys_id}/schedule/first_available

URL par défaut : /api/sn_chg_rest/change/{change_sys_id}/schedule/first_available

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 163. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
change_sys_id	Sys_id de la demande de changement à mettre à jour avec le prochain créneau horaire disponible. La demande de changement sélectionnée doit avoir un élément de configuration (cmdb_ci). Type de données : chaîne Table : demandes de changement [change_request]

Tableau 164. Paramètres de requête

Nom	Description
Néant

Tableau 165. Paramètres de corps de demande (XML ou JSON)

Nom	Description
duration_in_seconds	Durée du changement en secondes, c’est-à-dire le temps nécessaire pour terminer la tâche de demande de changement. Type de données : nombre entier
planned_start_time	Facultatif. Date et heure planifiées de début de l’implémentation de la demande de changement au format UTC. Récupérer le créneau horaire disponible commencer à ou après cette heure. Si elle n’est pas fournie, le système utilise l’heure actuelle comme heure de début. Format : aaaa-mm-jj hh :mm :ss Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 166. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 167. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 168. Codes d'état

Code d'état	Description
202	Le système a accepté la demande.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. Problèmes possibles : La valeur du paramètre du corps du duration_in_seconds n’est pas valide ou n’a pas été fournie. Valeur de paramètre de corps de planned_start_time fournie non valide. La demande de changement spécifiée n’a pas d’élément de configuration associé (cmdb_ci). L’utilisateur n’a pas accès en lecture aux champs de la demande de changement.
403	Interdit. L’utilisateur n’a pas d’accès en écriture aux valeurs de dates de début et de fin planifiées de la demande de changement.
404	Introuvable. L’enregistrement spécifié est introuvable. Problèmes possibles : Le système ne peut pas trouver la demande de changement d’après les informations fournies. L’utilisateur n’a pas accès en lecture à l’enregistrement.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
erreur	Informations sur les erreurs rencontrées lors du traitement de la demande de point de terminaison. Type de données : objet "error": { "detail": "String", "message": "String", "status": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message qui identifie l’erreur. Type de données : chaîne
messages	Informations du message. Type de données : objet "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
messages.errorMessages	Des messages d’erreur se sont produits lors du traitement de la demande. Type de données : tableau
messages.infoMessages	Messages d’information rencontrés lors du traitement de la demande. Type de données : tableau
messages.avertissementmessages	Des messages d’avertissement se sont produits lors du traitement de la demande. Type de données : tableau
Demande	Demande de point de terminaison d’origine. Type de données : chaîne
État	Informations sur l’état actuel du collaborateur. Type de données : objet state: { display_value: "String", value: Number }
state.display_value	Affichez la valeur de l’état de l’agent. Ces valeurs sont directement corrélées state.value au paramètre. Valeurs possibles : Terminé Erreur En cours En attente Type de données : chaîne
état.valeur	Valeur numérique de l’état du collaborateur. Valeurs possibles : 1 2 3 4 Type de données : nombre
type	Type de demande. Valeur valide : calendrier Type de données : chaîne
agent	Informations sur l’agent associé. Type de données : objet "worker": { "link": "String", "sysId": "String" }
worker.link	Lien pour récupérer l’état du calendrier des demandes de changement. Utilisez les sys_id dans GET /sn_chg_rest/change/worker/{sys_id} pour afficher les résultats. Type de données : chaîne
worker.sysId	Sys_id de l’agent associé à la demande de changement. Type de données : chaîne
statut	S’affiche uniquement en cas d’erreur. État du traitement du point de terminaison. Valeur possible : échec Type de données : chaîne

Obtenir l’état du calendrier des demandes de changement

Utilisez la valeur fournie dans worker.link le pour déterminer si l’enregistrement d’un changement a été planifié avec succès pour le premier créneau horaire disponible. La valeur est au format suivant :

https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

Utilisez les détails worker.link pour exécuter les sys_id fournis dans GET /sn_chg_rest/change/worker/{sys_id} afin d’afficher les résultats.

Le corps de la réponse contient l’état et fournit des résultats lorsque le traitement est terminé.

Si un créneau horaire disponible est trouvé, le système met à jour la demande de changement avec le premier créneau disponible. Lorsque l’état est terminé, le messages.infoMessages révèle que le premier créneau horaire disponible a été défini.

L’une des valeurs messages.infoMessages de réponse de planification suivantes est fournie dans le corps de la réponse :

• Le changement a été mis à jour : le changement demandé a été mis à jour pour le créneau horaire.
• Aucun créneau trouvé pour <nombre> jours à partir de maintenant : aucun créneau horaire disponible pour la durée de la demande de changement fourni dans le nombre de jours défini dans la fenêtre de calendrier.
  Remarque :

  La valeur par défaut du créneau horaire de planification de la demande de changement est de 90 jours. Pour modifier cette valeur, modifiez la change.conflict.next_available.schedule_window propriété. Pour plus d’informations, consultez Configurer les propriétés de l’analyse des conflits.

L’exemple GET /sn_chg_rest/change/worker/{sys_id} suivant montre la sortie fournie à l’aide de l’ID fourni dans le détail de l’worker.link. Les résultats indiquent que le traitement est terminé et que la demande de changement a été mise à jour avec le premier créneau horaire disponible.

{
  "result": {
    "worker": {
      "sysId": "355c62e0a4c87010f87712198fe9cacf",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": [
        "Change has been updated"
      ]
    }
  }
}

Demande cURL

curl "https://instance.service-now.com/api/sn_chg_rest/change/87ae5e900a0a2c3e263e8304e727c646/schedule/first_available" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"duration_in_seconds\":\"10800\"}" \
--user "username":"password"

Les résultats incluent worker.link détails que vous pouvez utiliser pour exécuter la sys_id fournie dans le point de terminaison GET /sn_chg_rest/change/worker/.

{
  "result": {
    "worker": {
      "sysId": "355c62e0a4c87010f87712198fe9cacf",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Gestion des changements : PATCH /sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}

Met à jour la tâche de demande de changement identifiée par le sys_ids spécifié avec les paires clé-valeur dans le corps de la demande ou l’URL.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task/{task_sys_id}

URL par défaut : /api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 169. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
change_sys_id	Sys_id de la demande de changement à laquelle la tâche est associée. Vérifie si la tâche spécifiée est associée à la demande de changement spécifiée. Type de données : chaîne Table : Demande de changement [change_request]
task_sys_id	Sys_id de la tâche à modifier. Type de données : chaîne Table : tâche de changement [change_task]

Tableau 170. Paramètres de requête

Nom	Description
Paires clé-valeur	Paires nom-valeur représentant les champs à mettre à jour. Les paramètres du corps de la demande remplacent les paramètres de l’URL. Toutefois, les paramètres requis doivent être spécifiés dans l’URL. Type de données : chaîne

Tableau 171. Paramètres de corps de demande (XML ou JSON)

Nom	Description
données	Paires nom-valeur représentant le ou les champs à mettre à jour dans la demande de changement associée. Par exemple, pour mettre à jour le fichier de description courte, entrez une paire nom-valeur similaire à la suivante : --data « {\"short_description\ » : \"my short desc\ » } » \. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 172. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 173. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 174. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs (clé) avec leurs valeurs associées pour la tâche de demande de changement identifiée avant la suppression. Type de données : objet
sys_id	Sys_id d’informations pour la tâche de demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la tâche de demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la tâche de demande de changement. Type de données : chaîne
parent	Informations sur l’identificateur unique de la demande de changement associée à cette tâche. Type de données : objet parent: { display_value: "String", value: "String" }
parent.display_value	Informations sur la tâche à afficher dans une interface utilisateur. Type de données : chaîne
parent.valeur	Sys_id de la tâche parente. Type de données : chaîne
__meta.ignoredFields	Paires clé-valeur transmises lors de l’appel, mais qui n’ont pas été appliquées à la demande de changement, car elles n’existent pas dans l’enregistrement de base ou les champs sont en lecture seule. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5?short_description=Retire both nodes" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire both nodes",
        display_value: "Retire both nodes"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Gestion des changements : PATCH /sn_chg_rest/change/emergency/{sys_id}

Met à jour la demande de changement urgent identifiée par le sys_id spécifié avec les paires clé-valeur dans le corps de la demande ou l’URL.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}

URL par défaut : /api/sn_chg_rest/change/emergency/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 175. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement à modifier. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 176. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur représentant les champs à mettre à jour. Les paramètres du corps de la demande remplacent les paramètres de l’URL. Toutefois, les paramètres requis doivent être spécifiés dans l’URL. Type de données : chaîne

Tableau 177. Paramètres de corps de demande (XML ou JSON)

Nom	Description
données	Paires nom-valeur représentant le ou les champs à mettre à jour dans la demande de changement associée. Par exemple, pour mettre à jour le fichier de description courte, entrez une paire nom-valeur similaire à la suivante : --data « {\"short_description\ » : \"my short desc\ » } » \. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 178. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 179. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 180. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : chaîne
État	État actuel de la demande de changement. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Urgence ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « urgence ». Type de données : chaîne
__meta.ignoredFields	Paires nom-valeur transmises lors de l’appel, mais qui n’ont pas été appliquées à la demande de changement, car elles n’existent pas dans l’enregistrement de base ou les champs sont en lecture seule. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"no_such_field\": \"this will be ignored\", }" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",    },
      state: {
        value: "-4", 
        display_value: "Assess"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Gestion des changements : PATCH /sn_chg_rest/change/normal/{sys_id}

Met à jour la demande de changement normal identifiée par le sys_id spécifié avec les paramètres du corps de la demande ou de l’URL.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/normal/{sys_id}

URL par défaut : /api/sn_chg_rest/change/normal/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 181. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement à modifier. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 182. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur représentant les champs à mettre à jour. Les paramètres du corps de la demande remplacent les paramètres de l’URL. Toutefois, les paramètres requis doivent être spécifiés dans l’URL. Type de données : chaîne

Tableau 183. Paramètres de corps de demande (XML ou JSON)

Nom	Description
données	Paires nom-valeur représentant le ou les champs à mettre à jour dans la demande de changement associée. Par exemple, pour mettre à jour le fichier de description courte, entrez une paire nom-valeur similaire à la suivante : --data « {\"short_description\ » : \"my short desc\ » } » \. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 184. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 185. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 186. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État actuel de la demande de changement. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id de la demande de changement. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Normal ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « normal ». Type de données : chaîne
__meta.ignoredFields	Paires nom-valeur transmises lors de l’appel, mais qui n’ont pas été appliquées à la demande de changement, car elles n’existent pas dans l’enregistrement de base ou les champs sont en lecture seule. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f?state=assess" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-4", 
        display_value: "Assess"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Gestion des changements : PATCH /sn_chg_rest/change/standard/{sys_id}

Met à jour la demande de changement standard identifiée par le sys_id spécifié avec les paramètres du corps de la demande ou de l’URL.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/standard/{sys_id}

URL par défaut : /api/sn_chg_rest/change/standard/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 187. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement à modifier. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 188. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur représentant les champs à mettre à jour. Les paramètres du corps de la demande remplacent les paramètres de l’URL. Toutefois, les paramètres requis doivent être spécifiés dans l’URL. Type de données : chaîne

Tableau 189. Paramètres de corps de demande (XML ou JSON)

Nom	Description
données	Paires nom-valeur représentant le ou les champs à mettre à jour dans la demande de changement associée. Par exemple, pour mettre à jour le fichier de description courte, entrez une paire nom-valeur similaire à la suivante : --data « {\"short_description\ » : \"my short desc\ » } » \. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 190. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 191. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 192. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Tous les champs (clé) avec leurs valeurs associées pour la demande de changement identifiée. Type de données : objet
État	État de la demande de changement. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. Type de données : chaîne
état.valeur	Valeur de l’état interne. Type de données : chaîne
sys_id	Sys_id informations pour la demande de changement. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177?description=Reboot my email server" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"short_description\": \"my short desc\" }" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },

      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot my email server",
        display_value: "Reboot my email server"
      },
    } 
  ]
}

Gestion des changements - PATCH /sn_chg_rest/change/standard/{sys_id}/risk

Calcule le risque et l’impact du changement standard spécifié en fonction d’une évaluation des conditions de risque.

Si le module d’extension Évaluation des risques de changement est installé, il calcule également le risque cumulé le plus élevé une fois l’évaluation des risques terminée.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{sys_id}/risk

URL par défaut : /api/sn_chg_rest/change/{sys_id}/risk

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 193. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id du changement standard à évaluer. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 194. Paramètres de requête

Nom	Description
Néant

Tableau 195. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 196. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 197. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 198. Codes d'état

Code d'état	Description
200	L’évaluation des risques s’est terminée avec succès.
400	Échec de l’évaluation des risques. Les détails du type de défaillance sont inclus dans les données d’erreur.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
impact	Impact associé au changement standard spécifié. Type de données : objet impact: { display_value: "String", value: "String" }
impact.display_value	Informations sur l’impact à afficher dans une interface utilisateur. Type de données : chaîne
impact.valeur	Valeur d’impact interne. Type de données : chaîne
paires nom-valeur	Tous les champs sont valides dans l’enregistrement d’un changement standard. Type de données : objet
risk	Risque calculé pour le changement standard spécifié. Type de données : objet risk: { display_value: "String", value: "String" }
risk.display_value	Informations sur le risque à afficher dans une interface utilisateur. Type de données : chaîne
risque.valeur	Valeur de risque interne. Type de données : chaîne
sys_id	Sys_id des informations pour la demande de changement standard. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/1c87925347c12200e0ef563dbb9a7177/risk" \
--request PATCH \
--header "Accept:application/json" \
--user "username":"password"

{
  sys_id: {
    value: "1c87925347c12200e0ef563dbb9a7177",
    display_value: "1c87925347c12200e0ef563dbb9a7177"
  },
  risk: {
    value: "4", 
    display_value: "Low"
  },
  impact: {
    value: "3",
    display_value: "3 - Low"
  }
  ..., // all valid fields in record
}

Gestion des changements - POST /sn_chg_rest/change

Crée un enregistrement de demande de changement basé sur la demande de changement. La création de plusieurs demandes de changement au sein d’un seul appel n’est pas prise en charge.

Vous pouvez obtenir la liste des modèles de changement disponibles à l’aide des points de Gestion des changements - GET /sn_chg_rest/change/model terminaison or Gestion des changements : GET /sn_chg_rest/change/model/{sys_id} .

Lors de la création d’une demande de changement, définissez le modèle de changement (chg_model) ou type. Si les deux chg_modelet type sont définis, le type est simplement une catégorisation du changement. Si au moins une de ces valeurs n’est pas fournie, le paramètre par défaut peut être modifié d’ici la mise en production. Il est fortement conseillé de définir au moins une de ces valeurs.

Les valeurs peuvent être définies en tant que paramètre de requête ou paramètre de corps de demande.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change

URL par défaut : /api/sn_chg_rest/change

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 199. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 200. Paramètres de requête

Nom	Description
paires nom-valeur	Paires nom-valeur représentant les champs à mettre à jour. Les paramètres du corps de la demande remplacent les paramètres de l’URL. Toutefois, les paramètres requis doivent être spécifiés dans l’URL. Les mêmes valeurs peuvent être définies comme paramètres de corps de demande. Remarque : Lors de la création d’une demande de changement, définissez le modèle de changement (chg_model) ou type. Si les deux chg_modelet type sont définis, le type est simplement une catégorisation du changement. Si au moins une de ces valeurs n’est pas fournie, le paramètre par défaut peut être modifié d’ici la mise en production. Il est fortement conseillé de définir au moins une de ces valeurs. Type de données : chaîne
chg_model	: nom d’un modèle de changement répertorié dans la table Modèle de changement [chg_model]. Fourni dans le format suivant : chg_model=Normal. Pour plus d’informations, consultez Modèles de changement. Remarque : Le fait de ne pas fournir le modèle de changement (chg_model) ou type la valeur entraîne un paramètre par défaut susceptible d’être modifié d’ici la mise en production. Il est fortement conseillé de définir au moins une de ces valeurs. Type de données : chaîne
encrypted_fields	Liste des champs séparés par des virgules à chiffrer. Ces champs sont chiffrés avant d’être stockés dans l’enregistrement associé. Lorsqu’il est spécifié, le point de terminaison appelle la méthode GlideRecord setDisplayValue(), au lieu d’appeler la méthode setValue( ). Pour cette raison, vous pouvez également utiliser ce paramètre pour transmettre des valeurs d’affichage pour des champs non chiffrés, tels que des champs de référence ou de choix, au lieu de transmettre des sys_ids ou des valeurs. Type de données : chaîne
type	nom du type de demande de changement répertorié dans la table Choices (Choix) [sys_choice]. Si le chg_model est également renseigné, ce champ n’est utilisé que comme catégorisation des changements. Fourni dans le format suivant : type=Normal. Pour plus d’informations, voir Ajouter un nouveau type de demande de changement. Remarque : Le fait de ne pas fournir le modèle de changement (chg_model) ou type la valeur entraîne un paramètre par défaut susceptible d’être modifié d’ici la mise en production. Il est fortement conseillé de définir au moins une de ces valeurs. Type de données : chaîne

Tableau 201. Paramètres du corps de la demande (JSON)

Nom	Description
Objet	Paires nom-valeur représentant le ou les champs à mettre à jour dans la demande de changement associée. Par exemple, pour mettre à jour le fichier de description courte, entrez une paire nom-valeur similaire à la suivante : --data « {\"short_description\ » : \"my short desc\ » } » \. Les mêmes propriétés peuvent être définies comme paramètres de requête. Type de données : chaîne
Object.chg_model	: nom d’un modèle de changement répertorié dans la table Modèle de changement [chg_model]. Fourni sous la forme d’une paire nom-valeur au format suivant : {"chg_model » : « Cloud Infrastructure"} Pour plus d’informations, consultez Modèles de changement. Remarque : Le fait de ne pas fournir le modèle de changement (chg_model) ou type la valeur entraîne un paramètre par défaut susceptible d’être modifié d’ici la mise en production. Il est fortement conseillé de définir au moins une de ces valeurs. Type de données : chaîne
Object.encrypted_fields	Liste des champs séparés par des virgules à chiffrer. Ces champs sont chiffrés avant d’être stockés dans l’enregistrement associé. Lorsqu’il est spécifié, le point de terminaison appelle la méthode GlideRecord setDisplayValue(), au lieu d’appeler la méthode setValue( ). Pour cette raison, vous pouvez également utiliser ce paramètre pour transmettre des valeurs d’affichage pour des champs non chiffrés, tels que des champs de référence ou de choix, au lieu de transmettre des sys_ids ou des valeurs. Type de données : chaîne
Type d’objet	nom du type de demande de changement répertorié dans la table Choices (Choix) [sys_choice]. Si le chg_model est également renseigné, ce champ n’est utilisé que comme catégorisation des changements. Fourni sous la forme d’une paire nom-valeur au format suivant : {"type » : « emergency"} Pour plus d’informations, voir Ajouter un nouveau type de demande de changement. Remarque : Le fait de ne pas fournir le modèle de changement (chg_model) ou type la valeur entraîne un paramètre par défaut susceptible d’être modifié d’ici la mise en production. Il est fortement conseillé de définir au moins une de ces valeurs. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 202. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 203. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 204. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Nouvel enregistrement de demande de changement. Les éléments de cet objet correspondent au format d’enregistrement de la table Demande de changement [change_request]. Toutes les valeurs qui ne sont pas spécifiées dans la demande sont définies sur leurs valeurs par défaut ou sont vides/nulles. Type de données : objet

Demande cURL

L’exemple suivant montre comment créer un enregistrement de demande de changement basé sur le modèle de changement standard et le type de norme. Dans cet exemple, la demande de changement est basée sur le modèle et le champ Type n’est utilisé que comme catégorisation.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"chg_model\" : \"Standard\",
    \"description\" : \"Describes the change request.\",
    \"short_description\" : \"My change request\",
    \"type\" : \"Standard\"
}" \
--user "username":"password"

Les résultats montrent que l’enregistrement a été ajouté avec succès à la table Demande de changement [change_request] avec la valeur CHG0030022.

{
  "result": 
    "upon_reject": {
      "display_value": "Cancel all future Tasks",
      "value": "cancel"
    },
    "sys_updated_on": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "type": {
      "display_value": "Standard",
      "value": "standard"
    }
    "number": {
      "display_value": "CHG0030022",
      "value": "CHG0030022"
    },
    "is_bulk": {
      "display_value": "false",
      "value": false
    }
    "ci_class": {
      "display_value": "cmdb_ci",
      "value": "cmdb_ci"
    },
    "state": {
      "display_value": "New",
      "value": -5
    },
    "sys_created_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "knowledge": {
      "display_value": "false",
      "value": false
    },
    "phase": {
      "display_value": "Requested",
      "value": "requested"
    }
    "impact": {
      "display_value": "3 - Low",
      "value": 3
    },
    "active": {
      "display_value": "true",
      "value": true
    },
    "priority": {
      "display_value": "4 - Low",
      "value": 4
    },
    "sys_domain_path": {
      "display_value": "/",
      "value": "/"
    },
    "production_system": {
      "display_value": "false",
      "value": false
    },
    "requested_by": {
      "display_value": "System Administrator",
      "value": "6816f79cc0a8016401c5a33be04be441"
    }
    "short_description": {
      "display_value": "My change request",
      "value": "My change request"
    },
    "sys_class_name": {
      "display_value": "Change Request",
      "value": "change_request"
    },
    "reassignment_count": {
      "display_value": "0",
      "value": 0
    },
    "variables": {
      "display_value": "variable_pool",
      "value": "variable_pool"
    },
    "sla_due": {
      "display_value": "UNKNOWN",
      "value": "",
      "display_value_internal": ""
    },
    "escalation": {
      "display_value": "Normal",
      "value": 0
    },
    "upon_approval": {
      "display_value": "Proceed to Next Task",
      "value": "proceed"
    },
    "conflict_status": {
      "display_value": "Not Run",
      "value": "Not Run"
    },
    "task_effective_number": {
      "display_value": "CHG0030022",
      "value": "CHG0030022"
    },
    "sys_updated_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "opened_by": {
      "display_value": "System Administrator",
      "value": "6816f79cc0a8016401c5a33be04be441"
    },
    "sys_created_on": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "sys_domain": {
      "display_value": "global",
      "value": "global"
    },
    "chg_model": {
      "display_value": "Standard",
      "value": "e55d0bfec343101035ae3f52c1d3ae49"
    },
    "opened_at": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "description": {
      "display_value": "Describes the change request.",
      "value": "Describes the change request."
    },
    "sys_id": {
      "display_value": "2ac52dd77c6b1510f877be3b096e64fe",
      "value": "2ac52dd77c6b1510f877be3b096e64fe"
    },
    "cab_required": {
      "display_value": "false",
      "value": false
    },
    "urgency": {
      "display_value": "3 - Low",
      "value": 3
    },
    "scope": {
      "display_value": "Medium",
      "value": 3
    },
    "activity_due": {
      "display_value": "UNKNOWN",
      "value": "",
      "display_value_internal": ""
    },
    "approval": {
      "display_value": "Not Yet Requested",
      "value": "not requested"
    },
  }
}

Demande cURL

L’exemple suivant montre comment transmettre des champs chiffrés dans le corps de la demande.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"encrypted_fields\":\"short_description,description\",
    \"short_description\":\"my short desc\",
    \"description\":\"my desc\"
}" \
--user "username":"password"

Demande cURL

L’exemple suivant montre comment transmettre des champs chiffrés en tant que paramètres de requête.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"

Gestion des changements - POST /sn_chg_rest/change/{sys_id}/ci

Crée l’association entre une demande de changement et Base de données de gestion des configurations (CMDB) des éléments de configuration (CI).

La création de l’association se fait de manière asynchrone, ce qui signifie qu’une réponse est fournie immédiatement et contient des détails pour le travailleur. Le travailleur effectue le travail réel après la réponse.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/{sys_id}/ci

URL par défaut : /api/sn_chg_rest/change/{sys_id}/ci

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 205. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement à associer au CI CMDB. Type de données : chaîne

Tableau 206. Paramètres de requête

Nom	Description
Néant

Tableau 207. Paramètres de corps de demande (XML ou JSON)

Nom	Description
association_type	Requis. Type d’association entre le CI CMDB et la demande de changement. Valeurs valides : affectés : CI affectés par la demande de changement impactés : services impactés par la demande de changement offre : offres de services impactées Type de données : chaîne
cmdb_ci_sys_ids	Requis. Liste des sys_ids CI CMDB à associer à la demande de changement. Type de données : tableau ou chaîne séparée par des virgules
refresh_impacted_services	Marqueur utilisé lorsque association_type=affecté pour renseigner les services impactés en fonction de la liste des CI affectés. Valeurs valides : vrai : renseigner les services impactés en fonction de la liste des CI affectés faux : ne pas remplir automatiquement les services concernés Type de données : booléennes Valeur par défaut : false

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 208. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 209. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 210. Codes d'état

Code d'état	Description
202	Accepté. Le traitement de la demande a été accepté.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. La réponse à l’erreur contient des messages pertinents pour aider à résoudre le problème.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
messages	Informations du message. Type de données : objet "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
messages.errorMessages	Des messages d’erreur se sont produits lors du traitement de la demande. Par exemple : Fourni CMDB_CI sys_id non valide Type de données : tableau
messages.infoMessages	Messages d’information rencontrés lors du traitement de la demande. Par exemple : CMDB_CI sys_id déjà associé à fourni. Type de données : tableau
messages.avertissementmessages	Des messages d’avertissement se sont produits lors du traitement de la demande. Par exemple : Un CMDB_CI sys_id non valide fourni. Type de données : tableau
Demande	Demande de point de terminaison d’origine. Type de données : chaîne
État	Informations sur l’état actuel du collaborateur. state: { display_value: "String", value: "String" }
state.display_value	Affichez la valeur de l’état de l’agent. Ces valeurs sont directement corrélées à l’élément state.value . Valeurs possibles : Terminé Erreur En cours En attente Type de données : chaîne
état.valeur	Valeur numérique de l’état du collaborateur. Valeurs possibles : 1 2 3 4 Type de données : nombre
type	Type d’association entre le CI CMDB et la demande de changement. Type de données : chaîne
agent	Informations sur l’agent associé. Type de données : objet "worker": { "link": "String", "sysId": "String" }
worker.link	URL permettant de récupérer l’état de l’agent associé et d’autres informations pertinentes sur l’agent. Type de données : chaîne
worker.sysId	Sys_id de l’agent associé à la demande de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{cmdb_ci_sys_ids:'caf043a3b7fb23000999e4f6ee11a9c0,06f043a3b7fb23000999e4f6ee11a9c1', association_type:'affected'}" \
--user "username":"password"

{
  "result": {
    "worker": {
      "sysId": "f490f4c6dbac330084f07ffdbf961952",
      "link": "instance.service-now.com/api/sn_chg_rest/change/worker/f490f4c6dbac330084f07ffdbf961952"
    },
    "request": "{\"cmdb_ci_sys_ids\":[\"caf043a3b7fb23000999e4f6ee11a9c0\",\"06f043a3b7fb23000999e4f6ee11a9c1\"],\"association_type\":\"affected\",\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "affected",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Gestion des changements - POST /sn_chg_rest/change/{sys_id}/conflict

Démarre un processus de vérification des conflits de demandes de changement pour la demande de changement spécifiée (sys_id).

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict

URL par défaut : /api/sn_chg_rest/change/{sys_id}/conflict

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 211. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande Gestion des changements pour laquelle démarrer le processus de vérification des conflits. Pour plus d’informations sur le processus de vérification des conflits, voir Détection de conflit. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 212. Paramètres de requête

Nom	Description
Néant

Tableau 213. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 214. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 215. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 216. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. La demande n’a pas pu démarrer en raison d’erreurs non résolues. Le message renvoyé peut fournir des détails supplémentaires.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Sys_id du processus de vérification des conflits de demandes de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
    result: "c0b5afe4b710230096c3e4f6ee11a93f"
}

Gestion des changements - POST /sn_chg_rest/change/emergency

Crée une demande de changement urgent basée sur l’enregistrement de demande de changement urgent par défaut. La création de plusieurs demandes de changement urgent au sein d’un seul appel n’est pas prise en charge.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/emergency

URL par défaut : /api/sn_chg_rest/change/emergency

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 217. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 218. Paramètres de requête

Nom	Description
Paires clé-valeur	Paires de champs clé-valeur à modifier lors de la création de la demande. La clé est le nom de champ dans le modèle et la valeur est les informations à renseigner dans le champ. Champs qui ne peuvent pas être modifiés et qui sont ignorés s’ils sont transmis : Règles métier Champs en lecture seule tels que définis dans les ACL Champs qui n’existent pas Type de données : chaîne

Tableau 219. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 220. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 221. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 222. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Paires nom-valeur des champs qui ont été créées dans la demande de changement urgent. Type de données : objet
État	État de la demande de changement avant la suppression. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. La valeur est toujours « Nouveau ». Type de données : chaîne
état.valeur	Valeur de l’état interne. La valeur est toujours « -5 ». Type de données : chaîne
sys_id	Sys_id de la demande de changement urgent nouvellement créée. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Urgence ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « urgence ». Type de données : chaîne
__meta.ignoredFields	Paires clé-valeur transmises lors de l’appel, mais qui n’ont pas été appliquées à la demande de changement, car elles n’existent pas dans l’enregistrement de base ou les champs sont en lecture seule. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?no_such_field=something&description=test&short_description=Reboot server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Gestion des changements - POST /sn_chg_rest/change/normal

Crée une demande de changement normal basée sur l’enregistrement de demande de changement normal par défaut. Plusieurs créations de demandes de changement normal au sein d’un seul appel ne sont pas prises en charge.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/normal

URL par défaut : /api/sn_chg_rest/change/normal

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 223. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 224. Paramètres de requête

Nom	Description
Paires clé-valeur	Champs à modifier lors de la création de la demande. La clé est le nom de champ dans le modèle et la valeur est les informations à renseigner dans le champ. Champs qui ne peuvent pas être modifiés et qui sont ignorés s’ils sont transmis : Règles métier Champs en lecture seule tels que définis dans les ACL Champs qui n’existent pas Type de données : chaîne

Tableau 225. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 226. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 227. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 228. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Valeurs de tous les champs dans la demande de changement associée. Type de données : objet
État	État de la demande de changement nouvellement créée. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	État à afficher dans une interface utilisateur. La valeur est toujours « Nouveau ». Type de données : chaîne
état.valeur	Valeur de l’état interne. La valeur est toujours « -5 ». Type de données : chaîne
sys_id	Sys_id de la demande de changement normal nouvellement créée. Type de données : chaîne
type	Type de la demande de changement. Type de données : objet type: { display_value: "String", value: "String" }
type.display_value	Type de changement à afficher dans une interface utilisateur. La valeur est toujours « Normal ». Type de données : chaîne
type.valeur	Valeur de type interne. La valeur est toujours « normal ». Type de données : chaîne
__meta.ignoredFields	Paires clé-valeur transmises lors de l’appel, mais qui n’ont pas été appliquées à la demande de changement, car elles n’existent pas dans l’enregistrement de base ou les champs sont en lecture seule. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?no_such_field=something&description=test&short_description=Remove server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Gestion des changements - POST /sn_chg_rest/change/{sys_id}/refresh_impacted_services

Remplit la liste connexe des services/éléments de configuration (CI) impactés en fonction du CI principal.

Le CI primaire apparaît sur le formulaire de demande de changement et dans la liste connexe des CI affectés.

Remarque :

Tous les éléments de travail pour ce point de terminaison sont exécutés de manière asynchrone.

Format d'URL

URL avec version : /api/sn_chg_rest/{api_version}/change/{sys_id}/refresh_impacted_services

URL par défaut : /api/sn_chg_rest/change/{sys_id}/refresh_impacted_services

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 229. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
sys_id	Sys_id de la demande de changement à utiliser pour actualiser les services impactés. Type de données : chaîne

Tableau 230. Paramètres de requête

Nom	Description
Néant

Tableau 231. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 232. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 233. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 234. Codes d'état

Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
messages	Informations du message. Type de données : objet "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
messages.errorMessages	Des messages d’erreur se sont produits lors du traitement de la demande. Par exemple : Fourni CMDB_CI sys_id non valide Type de données : tableau
messages.infoMessages	Messages d’information rencontrés lors du traitement de la demande. Par exemple : CMDB_CI sys_id déjà associé à fourni. Type de données : tableau
messages.avertissementmessages	Des messages d’avertissement se sont produits lors du traitement de la demande. Par exemple : Un CMDB_CI sys_id non valide fourni. Type de données : tableau
Demande	Demande de point de terminaison d’origine. Type de données : chaîne
État	Informations sur l’état actuel du collaborateur. Type de données : objet state: { display_value: "String", value: "String" }
state.display_value	Affichez la valeur de l’état de l’agent. Ces valeurs sont directement corrélées à l’élément state.value . Valeurs possibles : Terminé Erreur En cours En attente Type de données : chaîne
état.valeur	Valeur numérique de l’état du collaborateur. Valeurs possibles : 1 2 3 4 Type de données : nombre
type	Type d’association entre le CI CMDB et la demande de changement. Type de données : chaîne
agent	Informations sur l’agent associé. Type de données : objet "worker": { "link": "String", "sysId": "String" }
worker.link	URL permettant de récupérer l’état de l’agent associé et d’autres informations pertinentes sur l’agent. Type de données : chaîne
worker.sysId	Sys_id de l’agent associé à la demande de changement. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/refresh_impacted_services" \ 
--request POST \ 
--header "Accept:application/json" \
--header "Content-Type:application/json" \ 
--user "username":"password"

{ 
  result: { 
    worker: { 
      sysId: "aa31c308b75033000999e4f6ee11a9c2", 
      link: "http://instance.service-now.com/api/sn_chg_rest/change/worker/aa31c308b75033000999e4f6ee11a9c2" 
    }, 
    request: "", 
    state: { 
      value: 1, 
      display_value: "Waiting" 
    }, 
    type: "impacted", 
    messages: { 
      errorMessages: [], 
      warningMessages: [], 
      infoMessages: [] 
    } 
  } 
} 

Gestion des changements - POST /sn_chg_rest/change/standard/{standard_change_template_id}

Crée une demande de changement standard basée sur un modèle de changement standard existant, tel que spécifié par le modèle transmis sys_id. La création de plusieurs demandes de changement standard au sein d’un seul appel n’est pas prise en charge.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/standard/{standard_change_template_id}

URL par défaut : /api/sn_chg_rest/change/standard/{standard_change_template_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 235. Paramètres de chemin d'accès

Paramètre	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
standard_change_template_id	Sys_id du modèle de changement standard sur lequel base la nouvelle demande de changement standard. Type de données : chaîne Table : Modèle de changement standard [std_change_record_producer]

Tableau 236. Paramètres de requête

Paramètre

Description

paires nom-valeur

Champs du modèle de changement standard spécifié à modifier lors de la création de la demande. La clé est le nom de champ dans le modèle et la valeur est les informations à renseigner dans le champ. Champs qui ne peuvent pas être modifiés et qui sont ignorés s’ils sont transmis : Description Plan de retour en arrière Plan de tests Plan d'implémentation Champs en lecture seule tels que définis dans les ACL Champs qui n’existent pas dans le modèle de changement standard spécifié Type de données : chaîne

Tableau 237. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 238. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 239. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 240. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Corps de réponse

L’API renvoie ces éléments JSON ou XML dans le corps de la réponse.

Tableau 241. Éléments renvoyés dans le corps de la réponse

Élément	Description
paires nom-valeur	Paires nom-valeur des champs qui ont été créées dans la demande de changement standard. Type de données : objet
sys_id	Sys_id informations sur la demande de changement standard nouvellement créée. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la demande de changement standard à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la demande de changement standard. Type de données : chaîne
__meta.ignoredFields	Paires clé-valeur transmises lors de l’appel, mais qui n’ont pas été appliquées à la demande de changement, car elles n’existent pas dans l’enregistrement de base ou les champs sont en lecture seule. Type de données : tableau

Exemple de demande cURL

curl "https://instance.servicenow.com" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Gestion des changements - POST /sn_chg_rest/change/{change_sys_id}/task

Crée une tâche de demande de changement basée sur l’enregistrement de tâche de demande de changement par défaut et l’associe à la demande de changement spécifiée. La création de plusieurs tâches de demande de changement au sein d’un seul appel n’est pas prise en charge.

Format d'URL

URL versionnée : /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task

URL par défaut : /api/sn_chg_rest/change/{change_sys_id}/task

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 242. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
change_sys_id	Sys_id de la demande de changement à laquelle associer cette tâche. Type de données : chaîne Table : Demande de changement [change_request]

Tableau 243. Paramètres de requête

Nom	Description
Paires clé-valeur	Champs à modifier lors de la création de la demande. La clé est le nom de champ dans le modèle et la valeur est les informations à renseigner dans le champ. Champs qui ne peuvent pas être modifiés et qui sont ignorés s’ils sont transmis : Règles métier Champs en lecture seule tels que définis dans les ACL Champs qui n’existent pas Type de données : chaîne

Tableau 244. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 245. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 246. En-têtes de réponses

En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 247. Codes d'état

Code d'état	Description
200	Demande terminée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’enregistrement spécifié est introuvable.
500	Erreur interne du serveur. Une erreur logique s’est produite sur le code côté serveur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
paires nom-valeur	Paires nom-valeur des champs qui ont été créées dans la tâche de demande de changement. Type de données : objet
parent	Informations relatives à la demande de changement associée à la tâche. Type de données : objet parent: { display_value: "String", value: "String" }
parent.display_value	Informations à afficher dans l’interface utilisateur pour la demande de changement associée à la tâche. Type de données : chaîne
parent.valeur	Sys_id de la demande de changement associée à la tâche. Type de données : chaîne
sys_id	Sys_id d’informations sur la tâche de demande de changement nouvellement créée. Type de données : objet sys_id: { display_value: "String", value: "String" }
sys_id.valeur_affichage	Sys_id de la tâche de demande de changement à afficher dans une interface utilisateur. Type de données : chaîne
sys_id.valeur	Sys_id de la tâche de demande de changement. Type de données : chaîne
__meta.ignoredFields	Paires clé-valeur transmises lors de l’appel, mais qui n’ont pas été appliquées à la demande de changement, car elles n’existent pas dans l’enregistrement de base ou les champs sont en lecture seule. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/now/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?short_description=Retire node&no_such_field=test" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe ", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire node",
        display_value: "Retire node"
      }
      __meta.ignoredFields": ["no_such_field"]
    }
  ]
}