Table API
L’API de table fournit des points de terminaison qui vous permettent d’effectuer les opérations créer, lire, mettre à jour et supprimer (CRUD) sur des tables existantes.
L’utilisateur appelant doit disposer de rôles suffisants pour accéder aux données de la table spécifiée dans la demande.
Afficher une liste de toutes les tables en accédant à ou dans le paramètre de chemin d’accès déroulant de n’importe quel point de tableName terminaison d’API de table dans l’explorateur d’API REST.
Table : DELETE /now/table/{tableName}/{sys_id}
Supprime l’enregistrement spécifié de la table spécifiée.
Format d'URL
URL versionnée : /api/now/{api_version}/table/{tableName}/{sys_id}
URL par défaut : /api/now/table/{tableName}/{sys_id}
Paramètres de demande pris en charge
| 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 à supprimer. Type de données : chaîne |
| tableName | Nom de la table à partir de laquelle supprimer l’enregistrement spécifié, tel que « incident » ou « actif ». Type de données : chaîne |
| Nom | Description |
|---|---|
| sysparm_query_no_domain | Marqueur indiquant s’il faut restreindre la recherche d’enregistrement aux seuls domaines pour lesquels l’utilisateur connecté est configuré. Valeurs valides :
Type de données : booléennes Valeur par défaut : false Remarque : Le sysparm_query_no_domain paramètre n’est disponible que pour les administrateurs système ou les utilisateurs disposant du rôle query_no_domain_table_api. |
| 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.
| 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 |
| 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.
| Code d'état | Description |
|---|---|
| 204 | Indique que la demande s’est terminée avec succès. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| Néant |
Demande cURL
Supprimez un enregistrement de la table Incident.
curl "https://instance.servicenow.com/api/now/table/incident/d977b66a4f411200adf9f8e18110c7b2" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
Il n’y a pas de corps de réponse.
None
Table : GET /now/table/{tableName}
Récupère plusieurs enregistrements pour la table spécifiée.
Pour obtenir des instructions de base, consultez Récupérer les incidents existants.
Format d'URL
URL versionnée : /api/now/{api_version}/table/{tableName}
URL par défaut : /api/now/table/{tableName}
Paramètres de demande pris en charge
| 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. Selon la version, ce point de terminaison renvoie des résultats différents sur une requête valide.
Type de données : chaîne |
| tableName | Nom de la table à partir de laquelle récupérer les enregistrements. Type de données : chaîne |
| Nom | Description |
|---|---|
| paires nom-valeur | Paires nom-valeur à utiliser pour filtrer l’ensemble de résultats. 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_display_value | Détermine le type de données renvoyées, soit les valeurs réelles de la base de données, soit les valeurs d’affichage des champs. Les valeurs d’affichage sont manipulées en fonction de la valeur réelle dans la base de données et des paramètres et préférences de l’utilisateur ou du système. Si vous renvoyez des valeurs d’affichage, la valeur renvoyée dépend du type de champ.
Type de données : chaîne Valeurs valides :
Valeur par défaut : false Remarque : Il n’existe aucune méthode privilégiée pour définir ce paramètre. Cependant, la spécification de la valeur d’affichage peut entraîner des problèmes de performances car elle ne lit pas directement à partir de la base de données et peut inclure la référence d’autres champs et enregistrements. Pour plus d’informations sur les valeurs d’affichage et les valeurs réelles, consultez la FAQ sur l’API de table (KB0534905). |
| sysparm_exclude_reference_link | Marqueur indiquant s’il faut exclure les liens d’API de table pour les champs de référence. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| sysparm_fields | Liste de champs séparés par des virgules à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : renvoyer tous les champs. |
| 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 . Cette limite est appliquée avant l’évaluation de l’ACL. Si aucun enregistrement ne revient, y compris les enregistrements auxquels vous avez accès, réorganisez l’ordre des enregistrements afin que les enregistrements auxquels vous avez accès reviennent en premier. Remarque :
Des valeurs anormalement élevées sysparm_limit peuvent avoir un impact sur les performances du système. Type de données : nombre Par défaut : 10 000 |
| sysparm_no_count | Marqueur indiquant s’il faut exécuter une requête de sélection count(*) sur la table pour renvoyer le nombre de lignes dans la table associée.Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| 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 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.
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.
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 Syntaxe :
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.
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 |
| sysparm_query_category | Nom de la catégorie à utiliser pour les requêtes. Type de données : chaîne |
| sysparm_query_no_domain | Marqueur indiquant s’il faut restreindre la recherche d’enregistrement aux seuls domaines pour lesquels l’utilisateur connecté est configuré. Valeurs valides :
Type de données : booléennes Valeur par défaut : false Remarque : Le sysparm_query_no_domain paramètre n’est disponible que pour les administrateurs système ou les utilisateurs disposant du rôle query_no_domain_table_api. |
| sysparm_suppress_pagination_header | Marqueur indiquant s’il faut supprimer l’en-tête du lien de la réponse. L’en-tête de lien fournit diverses URL vers des pages relatives du jeu d’enregistrements que vous pouvez utiliser pour paginer le jeu d’enregistrements renvoyé. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| sysparm_view | Vue de l’interface utilisateur permettant de restituer les données. Détermine les champs renvoyés dans la réponse. Valeurs valides :
Si vous spécifiez également le sysparm_fields paramètre, il prévaut. Type de données : chaîne |
| 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.
| 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 |
| En-tête | Description |
|---|---|
| un lien | URL relatives, basées sur la demande précédente, que vous pouvez utiliser pour parcourir l’ensemble d’enregistrements disponible. Par exemple :
|
| Nombre X-Total | Nombre total d’enregistrements renvoyés par la requête. |
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.
| Code d'état | Description |
|---|---|
| 200 | Demande terminée avec succès. Si une requête valide n’a renvoyé aucun résultat, le corps de la réponse contient uniquement un tableau de résultats vide. |
Paramètres du corps de la réponse (JSON ou XML)
| Paramètre | Description |
|---|---|
| paires nom-valeur | Noms de champs et valeurs de tous les paramètres dans l’enregistrement spécifié ou ceux spécifiés dans les paramètres de requête. |
Demande cURL
Récupérez le premier enregistrement de la table Problème.
curl "https://instance.servicenow.com/api/now/table/problem?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
La réponse contient les paires nom-valeur de l’enregistrement demandé.
{
"result": [
{
"parent": "",
"made_sla": "true",
"watch_list": "",
"upon_reject": "cancel",
"sys_updated_on": "2016-01-19 04:52:04",
"approval_history": "",
"number": "PRB0000050",
"sys_updated_by": "glide.maint",
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
"value": "glide.maint"
},
"user_input": "",
"sys_created_on": "2016-01-19 04:51:19",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"state": "4",
"sys_created_by": "glide.maint",
"knowledge": "false",
"order": "",
"closed_at": "2016-01-19 04:52:04",
"cmdb_ci": {
"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/55b35562c0a8010e01cff22378e0aea9",
"value": "55b35562c0a8010e01cff22378e0aea9"
},
"delivery_plan": "",
"impact": "3",
"active": "false",
"work_notes_list": "",
"business_service": "",
"priority": "4",
"sys_domain_path": "/",
"time_worked": "",
"expected_start": "",
"rejection_goto": "",
"opened_at": "2016-01-19 04:49:47",
"business_duration": "1970-01-01 00:00:00",
"group_list": "",
"work_end": "",
"approval_set": "",
"wf_activity": "",
"work_notes": "",
"short_description": "Switch occasionally drops connections",
"correlation_display": "",
"delivery_task": "",
"work_start": "",
"assignment_group": "",
"additional_assignee_list": "",
"description": "Switch occasionally drops connections",
"calendar_duration": "1970-01-01 00:02:17",
"close_notes": "updated firmware",
"sys_class_name": "problem",
"closed_by": "",
"follow_up": "",
"sys_id": "04ce72c9c0a8016600b5b7f75ac67b5b",
"contact_type": "phone",
"urgency": "3",
"company": "",
"reassignment_count": "",
"activity_due": "",
"assigned_to": "",
"comments": "",
"approval": "not requested",
"sla_due": "",
"comments_and_work_notes": "",
"due_date": "",
"sys_mod_count": "1",
"sys_tags": "",
"escalation": "0",
"upon_approval": "proceed",
"correlation_id": "",
"location": ""
}
]
}
Table : GET /now/table/{tableName}/{sys_id}
Récupère l’enregistrement identifié par le sys_id spécifié à partir de la table spécifiée.
Format d'URL
URL versionnée : /api/now/{api_version}/table/{tableName}/{sys_id}
URL par défaut : /api/now/table/{tableName}/{sys_id}
Paramètres de demande pris en charge
| 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 à récupérer. Type de données : chaîne |
| tableName | Nom de la table à partir de laquelle récupérer l’enregistrement. Type de données : chaîne |
| Nom | Description |
|---|---|
| sysparm_display_value | Détermine le type de données renvoyées, soit les valeurs réelles de la base de données, soit les valeurs d’affichage des champs. Les valeurs d’affichage sont manipulées en fonction de la valeur réelle dans la base de données et des paramètres et préférences de l’utilisateur ou du système. Si vous renvoyez des valeurs d’affichage, la valeur renvoyée dépend du type de champ.
Type de données : chaîne Valeurs valides :
Valeur par défaut : false Remarque : Il n’existe aucune méthode privilégiée pour définir ce paramètre. Cependant, la spécification de la valeur d’affichage peut entraîner des problèmes de performances car elle ne lit pas directement à partir de la base de données et peut inclure la référence d’autres champs et enregistrements. Pour plus d’informations sur les valeurs d’affichage et les valeurs réelles, consultez la FAQ sur l’API de table (KB0534905). |
| sysparm_exclude_reference_link | Marqueur indiquant s’il faut exclure les liens d’API de table pour les champs de référence. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| sysparm_fields | Liste de champs séparés par des virgules à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : renvoyer tous les champs. |
| sysparm_query_no_domain | Marqueur indiquant s’il faut restreindre la recherche d’enregistrement aux seuls domaines pour lesquels l’utilisateur connecté est configuré. Valeurs valides :
Type de données : booléennes Valeur par défaut : false Remarque : Le sysparm_query_no_domain paramètre n’est disponible que pour les administrateurs système ou les utilisateurs disposant du rôle query_no_domain_table_api. |
| sysparm_view | Vue de l’interface utilisateur permettant de restituer les données. Détermine les champs renvoyés dans la réponse. Valeurs valides :
Si vous spécifiez également le sysparm_fields paramètre, il prévaut. Type de données : chaîne |
| 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.
| 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 |
| 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.
| 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)
| Paramètre | Description |
|---|---|
| paires nom-valeur | Noms de champs et valeurs de tous les paramètres dans l’enregistrement spécifié ou ceux spécifiés dans les paramètres de requête. |
Demande cURL
Récupérez un enregistrement à partir de la table Incident.
curl "https://instance.servicenow.com/api/now/table/incident/a9e30c7dc61122760116894de7bcc7bd" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
La réponse contient les paires nom-valeur de l’enregistrement demandé.
{
"result": {
"upon_approval": "",
"location": {
"link": "https://instance.servicenow.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba",
"value": "105cf7f3c611227501e75e08b14a38ba"
},
"expected_start": "",
"reopen_count": "",
"close_notes": "",
"additional_assignee_list": "",
"impact": "1",
"urgency": "3",
"correlation_id": "",
"sys_tags": "",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"description": "",
"group_list": "",
"priority": "3",
"delivery_plan": "",
"sys_mod_count": "4",
"work_notes_list": "",
"business_service": "",
"follow_up": "",
"closed_at": "",
"sla_due": "2015-11-11 22:04:15",
"delivery_task": "",
"sys_updated_on": "2015-11-01 22:37:27",
"parent": "",
"work_end": "",
"number": "INC0000046",
"closed_by": "",
"work_start": "",
"calendar_stc": "",
"category": "software",
"business_duration": "",
"incident_state": "1",
"activity_due": "",
"correlation_display": "",
"company": "",
"active": "true",
"due_date": "",
"assignment_group": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7",
"value": "8a4dde73c6112278017a6a4baf547aa7"
},
"caller_id": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
"value": "46c6f9efa9fe198101ddf5eed9adf6e7"
},
"knowledge": "false",
"made_sla": "false",
"comments_and_work_notes": "",
"parent_incident": "",
"state": "1",
"user_input": "",
"sys_created_on": "2015-11-01 22:05:30",
"approval_set": "",
"reassignment_count": "1",
"rfc": "",
"child_incidents": "",
"opened_at": "2015-11-02 22:04:15",
"short_description": "Can't access SFA software",
"order": "",
"sys_updated_by": "glide.maint",
"resolved_by": "",
"notify": "1",
"upon_reject": "",
"approval_history": "",
"problem_id": {
"link": "https://instance.servicenow.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74",
"value": "a9e4890bc6112276003d7a5a5c774a74"
},
"work_notes": "",
"calendar_duration": "",
"close_code": "",
"sys_id": "a9e30c7dc61122760116894de7bcc7bd",
"approval": "not requested",
"caused_by": "",
"severity": "3",
"sys_created_by": "admin",
"resolved_at": "",
"assigned_to": "",
"business_stc": "",
"wf_activity": "",
"sys_domain_path": "/",
"cmdb_ci": {
"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0",
"value": "a9c0c8d2c6112276018f7705562f9cb0"
},
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
"value": "46c6f9efa9fe198101ddf5eed9adf6e7"
},
"subcategory": "",
"rejection_goto": "",
"sys_class_name": "incident",
"watch_list": "",
"time_worked": "",
"contact_type": "phone",
"escalation": "0",
"comments": ""
}
}
Table : PATCH /now/table/{tableName}/{sys_id}
Met à jour l’enregistrement spécifié avec les paires nom-valeur incluses dans le corps de la demande.
Format d'URL
URL versionnée : /api/now/{api_version}/table/{tableName}/{sys_id}
URL par défaut : /api/now/table/{tableName}/{sys_id}
Paramètres de demande pris en charge
| 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 à mettre à jour. Type de données : chaîne |
| tableName | Nom de la table dans laquelle se trouve l’enregistrement spécifié. Type de données : chaîne |
| Nom | Description |
|---|---|
| sysparm_display_value | Détermine le type de données renvoyées, soit les valeurs réelles de la base de données, soit les valeurs d’affichage des champs. Les valeurs d’affichage sont manipulées en fonction de la valeur réelle dans la base de données et des paramètres et préférences de l’utilisateur ou du système. Si vous renvoyez des valeurs d’affichage, la valeur renvoyée dépend du type de champ.
Type de données : chaîne Valeurs valides :
Valeur par défaut : false Remarque : Il n’existe aucune méthode privilégiée pour définir ce paramètre. Cependant, la spécification de la valeur d’affichage peut entraîner des problèmes de performances car elle ne lit pas directement à partir de la base de données et peut inclure la référence d’autres champs et enregistrements. Pour plus d’informations sur les valeurs d’affichage et les valeurs réelles, consultez la FAQ sur l’API de table (KB0534905). |
| sysparm_fields | Liste de champs séparés par des virgules à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : renvoyer tous les champs. |
| sysparm_input_display_value | Marqueur indiquant s’il faut définir les valeurs des champs à l’aide de la valeur d’affichage ou de la valeur réelle. Selon les différents types de champs, le point de terminaison peut manipuler les valeurs d’affichage transmises pour stocker les valeurs appropriées dans la base de données. Par exemple, si vous envoyez le nom d’affichage d’un champ de référence, le point de terminaison stocke le sys_id de cette valeur dans la base de données. Pour les champs de date et d’heure, lorsque ce paramètre est défini sur vrai, la valeur de date et d’heure est ajustée en fonction du fuseau horaire de l’utilisateur actuel. Si la valeur est définie sur false, la valeur de la date et de l’heure est insérée à l’aide du fuseau horaire GMT. Valeurs valides :
Type de données : booléennes Par défaut : faux : correspond au type de données renvoyé lors de la récupération de données (méthodes GET), c’est-à-dire les valeurs réelles. Remarque : Pour définir la valeur d’un champ chiffré, vous devez définir ce paramètre sur vrai. Si ce paramètre n’est pas défini sur vrai, les valeurs soumises aux champs chiffrés ne sont pas enregistrées. En outre, l’utilisateur demandeur doit disposer du contexte de chiffrement approprié avant de soumettre la demande. Les champs chiffrés sont masqués pour les utilisateurs ne disposant pas du contexte de chiffrement approprié. Pour plus d’informations sur le chiffrement de champ, reportez-vous à Encryption. |
| sysparm_query_no_domain | Marqueur indiquant s’il faut restreindre la recherche d’enregistrement aux seuls domaines pour lesquels l’utilisateur connecté est configuré. Valeurs valides :
Type de données : booléennes Valeur par défaut : false Remarque : Le sysparm_query_no_domain paramètre n’est disponible que pour les administrateurs système ou les utilisateurs disposant du rôle query_no_domain_table_api. |
| sysparm_view | Vue de l’interface utilisateur permettant de restituer les données. Détermine les champs renvoyés dans la réponse. Valeurs valides :
Si vous spécifiez également le sysparm_fields paramètre, il prévaut. Type de données : chaîne |
| Nom | Description |
|---|---|
| paires nom-valeur | Nom de champ et nouvelle valeur de chaque paramètre à mettre à jour dans l’enregistrement spécifié. Remarque : Tous les champs d’un enregistrement peuvent ne pas être disponibles pour la mise à jour. Par exemple, les champs dont le préfixe est « sys_ » sont généralement des paramètres système qui sont générés automatiquement et ne peuvent pas être mis à jour. |
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.
| 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 |
| X-no-response-body | Par défaut, les réponses incluent le contenu du corps détaillant l’enregistrement modifié. Définissez cet en-tête de demande sur vrai pour supprimer le corps de la réponse. |
| 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.
| 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é. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| paires nom-valeur | Noms de champs et valeurs de tous les paramètres dans l’enregistrement spécifié ou ceux spécifiés dans les paramètres de requête. |
Demande cURL
Mettez à jour un enregistrement dans la table Incident.
curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
--user 'username':'password'
La réponse contient les paires nom-valeur de l’enregistrement mis à jour.
{
"result": {
"upon_approval": "proceed",
"location": {
"link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
"value": "108752c8c611227501d4ab0e392ba97f"
},
"expected_start": "",
"reopen_count": "",
"close_notes": "",
"additional_assignee_list": "",
"impact": "1",
"urgency": "1",
"correlation_id": "",
"sys_tags": "",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"description": "",
"group_list": "",
"priority": "1",
"delivery_plan": "",
"sys_mod_count": "7",
"work_notes_list": "",
"business_service": "",
"follow_up": "",
"closed_at": "",
"sla_due": "2017-07-05 05:58:24",
"delivery_task": "",
"sys_updated_on": "2016-01-22 14:12:37",
"parent": "",
"work_end": "",
"number": "INC0000050",
"closed_by": "",
"work_start": "",
"calendar_stc": "",
"category": "hardware",
"business_duration": "",
"incident_state": "2",
"activity_due": "2016-01-22 16:12:37",
"correlation_display": "",
"company": {
"link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
"value": "31bea3d53790200044e0bfc8bcbe5dec"
},
"active": "true",
"due_date": "",
"assignment_group": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
"value": "8a5055c9c61122780043563ef53438e3"
},
"caller_id": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
"value": "5b7c200d0a640069006b3845b5d0fa7c"
},
"knowledge": "false",
"made_sla": "true",
"comments_and_work_notes": "",
"parent_incident": "",
"state": "2",
"user_input": "",
"sys_created_on": "2015-11-02 18:05:40",
"approval_set": "",
"reassignment_count": "0",
"rfc": "",
"child_incidents": "",
"opened_at": "2015-11-02 21:58:24",
"short_description": "Can't access Exchange server - is it down?",
"order": "",
"sys_updated_by": "admin",
"resolved_by": "",
"notify": "1",
"upon_reject": "cancel",
"approval_history": "",
"problem_id": "",
"work_notes": "",
"calendar_duration": "",
"close_code": "",
"sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
"approval": "not requested",
"caused_by": "",
"severity": "3",
"sys_created_by": "glide.maint",
"resolved_at": "",
"assigned_to": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
"value": "681b365ec0a80164000fb0b05854a0cd"
},
"business_stc": "",
"wf_activity": "",
"sys_domain_path": "/",
"cmdb_ci": {
"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
"value": "281190e3c0a8000b003f593aa3f20ca6"
},
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
"value": "glide.maint"
},
"subcategory": "",
"rejection_goto": "",
"sys_class_name": "incident",
"watch_list": "",
"time_worked": "",
"contact_type": "phone",
"escalation": "3",
"comments": ""
}
}
Table : POST /now/table/{tableName}
Insère un enregistrement dans la table spécifiée. L’insertion de plusieurs enregistrements n’est pas prise en charge par cette méthode.
Format d'URL
URL versionnée : /api/now/{api_version}/table/{tableName}
URL par défaut : /api/now/table/{tableName}
Paramètres de demande pris en charge
| 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 |
| tableName | Nom de la table dans laquelle enregistrer l’enregistrement. Type de données : chaîne |
| Nom | Description |
|---|---|
| sysparm_display_value | Détermine le type de données renvoyées, soit les valeurs réelles de la base de données, soit les valeurs d’affichage des champs. Les valeurs d’affichage sont manipulées en fonction de la valeur réelle dans la base de données et des paramètres et préférences de l’utilisateur ou du système. Si vous renvoyez des valeurs d’affichage, la valeur renvoyée dépend du type de champ.
Type de données : chaîne Valeurs valides :
Valeur par défaut : false Remarque : Il n’existe aucune méthode privilégiée pour définir ce paramètre. Cependant, la spécification de la valeur d’affichage peut entraîner des problèmes de performances car elle ne lit pas directement à partir de la base de données et peut inclure la référence d’autres champs et enregistrements. Pour plus d’informations sur les valeurs d’affichage et les valeurs réelles, consultez la FAQ sur l’API de table (KB0534905). |
| sysparm_exclude_reference_link | Marqueur indiquant s’il faut exclure les liens d’API de table pour les champs de référence. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| sysparm_fields | Liste de champs séparés par des virgules à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : renvoyer tous les champs. |
| sysparm_input_display_value | Marqueur indiquant s’il faut définir les valeurs des champs à l’aide de la valeur d’affichage ou de la valeur réelle. Selon les différents types de champs, le point de terminaison peut manipuler les valeurs d’affichage transmises pour stocker les valeurs appropriées dans la base de données. Par exemple, si vous envoyez le nom d’affichage d’un champ de référence, le point de terminaison stocke le sys_id de cette valeur dans la base de données. Pour les champs de date et d’heure, lorsque ce paramètre est défini sur vrai, la valeur de date et d’heure est ajustée en fonction du fuseau horaire de l’utilisateur actuel. Si la valeur est définie sur false, la valeur de la date et de l’heure est insérée à l’aide du fuseau horaire GMT. Valeurs valides :
Type de données : booléennes Par défaut : faux : correspond au type de données renvoyé lors de la récupération de données (méthodes GET), c’est-à-dire les valeurs réelles. Remarque : Pour définir la valeur d’un champ chiffré, vous devez définir ce paramètre sur vrai. Si ce paramètre n’est pas défini sur vrai, les valeurs soumises aux champs chiffrés ne sont pas enregistrées. En outre, l’utilisateur demandeur doit disposer du contexte de chiffrement approprié avant de soumettre la demande. Les champs chiffrés sont masqués pour les utilisateurs ne disposant pas du contexte de chiffrement approprié. Pour plus d’informations sur le chiffrement de champ, reportez-vous à Encryption. |
| sysparm_view | Vue de l’interface utilisateur permettant de restituer les données. Détermine les champs renvoyés dans la réponse. Valeurs valides :
Si vous spécifiez également le sysparm_fields paramètre, il prévaut. Type de données : chaîne |
| Nom | Description |
|---|---|
| paires nom-valeur | Nom de champ et valeur associée pour chaque paramètre à définir dans l’enregistrement spécifié. Remarque : Les champs qui ne sont pas spécifiés et qui ne sont pas générés automatiquement par le système sont définis sur la valeur Null du type de données associé.Tous les champs d’un enregistrement peuvent ne pas être disponibles pour la mise à jour. Par exemple, les champs dont le préfixe est « sys_ » sont généralement des paramètres système qui sont générés automatiquement et ne peuvent pas être mis à jour. |
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.
| 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 |
| X-no-response-body | Par défaut, les réponses incluent le contenu du corps détaillant le nouvel enregistrement. Définissez cet en-tête sur vrai dans la demande de suppression du corps de la réponse. |
| En-tête | Description |
|---|---|
| Emplacement | Emplacement de la ressource créée. |
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.
| Code d'état | Description |
|---|---|
| 201 | Indique que la demande s’est terminée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| paires nom-valeur | Noms de champs et valeurs de tous les paramètres dans l’enregistrement nouvellement créé ou ceux spécifiés dans les paramètres de requête. |
Demande cURL
Insérez un nouvel enregistrement dans la table Incident.
curl "https://instance.servicenow.com/api/now/table/incident" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'short_description':'Unable to connect to office wifi','assignment_group':'287ebd7da9fe198100f92cc8d1d2154e','urgency':'2','impact':'2'}" \
--user 'username':'password'
La réponse contient les paires nom-valeur du nouvel enregistrement.
{
"result": {
"upon_approval": "proceed",
"location": "",
"expected_start": "",
"reopen_count": "0",
"close_notes": "",
"additional_assignee_list": "",
"impact": "2",
"urgency": "2",
"correlation_id": "",
"sys_tags": "",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"description": "",
"group_list": "",
"priority": "3",
"delivery_plan": "",
"sys_mod_count": "0",
"work_notes_list": "",
"business_service": "",
"follow_up": "",
"closed_at": "",
"sla_due": "",
"delivery_task": "",
"sys_updated_on": "2016-01-22 14:28:24",
"parent": "",
"work_end": "",
"number": "INC0010002",
"closed_by": "",
"work_start": "",
"calendar_stc": "",
"category": "inquiry",
"business_duration": "",
"incident_state": "1",
"activity_due": "",
"correlation_display": "",
"company": "",
"active": "true",
"due_date": "",
"assignment_group": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"caller_id": "",
"knowledge": "false",
"made_sla": "true",
"comments_and_work_notes": "",
"parent_incident": "",
"state": "1",
"user_input": "",
"sys_created_on": "2016-01-22 14:28:24",
"approval_set": "",
"reassignment_count": "0",
"rfc": "",
"child_incidents": "0",
"opened_at": "2016-01-22 14:28:24",
"short_description": "Unable to connect to office wifi",
"order": "",
"sys_updated_by": "admin",
"resolved_by": "",
"notify": "1",
"upon_reject": "cancel",
"approval_history": "",
"problem_id": "",
"work_notes": "",
"calendar_duration": "",
"close_code": "",
"sys_id": "c537bae64f411200adf9f8e18110c76e",
"approval": "not requested",
"caused_by": "",
"severity": "3",
"sys_created_by": "admin",
"resolved_at": "",
"assigned_to": "",
"business_stc": "",
"wf_activity": "",
"sys_domain_path": "/",
"cmdb_ci": "",
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"subcategory": "",
"rejection_goto": "",
"sys_class_name": "incident",
"watch_list": "",
"time_worked": "",
"contact_type": "phone",
"escalation": "0",
"comments": ""
}
}
Table : PUT /now/table/{tableName}/{sys_id}
Met à jour l’enregistrement spécifié avec le corps de la demande.
Format d'URL
URL versionnée : /api/now/{api_version}/table/{tableName}/{sys_id}
URL par défaut : /api/now/table/{tableName}/{sys_id}
Paramètres de demande pris en charge
| 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 | Identificateur unique de l’enregistrement à mettre à jour. Type de données : chaîne |
| tableName | Nom de la table dans laquelle se trouve l’enregistrement. Type de données : chaîne |
| Nom | Description |
|---|---|
| sysparm_display_value | Détermine le type de données renvoyées, soit les valeurs réelles de la base de données, soit les valeurs d’affichage des champs. Les valeurs d’affichage sont manipulées en fonction de la valeur réelle dans la base de données et des paramètres et préférences de l’utilisateur ou du système. Si vous renvoyez des valeurs d’affichage, la valeur renvoyée dépend du type de champ.
Type de données : chaîne Valeurs valides :
Valeur par défaut : false Remarque : Il n’existe aucune méthode privilégiée pour définir ce paramètre. Cependant, la spécification de la valeur d’affichage peut entraîner des problèmes de performances car elle ne lit pas directement à partir de la base de données et peut inclure la référence d’autres champs et enregistrements. Pour plus d’informations sur les valeurs d’affichage et les valeurs réelles, consultez la FAQ sur l’API de table (KB0534905). |
| sysparm_exclude_reference_link | Marqueur indiquant s’il faut exclure les liens d’API de table pour les champs de référence. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| sysparm_fields | Liste de champs séparés par des virgules à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : renvoyer tous les champs. |
| sysparm_input_display_value | Marqueur indiquant s’il faut définir les valeurs des champs à l’aide de la valeur d’affichage ou de la valeur réelle. Valeurs valides :
Type de données : booléennes Valeur par défaut : false Remarque :
|
| sysparm_query_no_domain | Marqueur indiquant s’il faut restreindre la recherche d’enregistrement aux seuls domaines pour lesquels l’utilisateur connecté est configuré. Valeurs valides :
Type de données : booléennes Valeur par défaut : false Remarque : Le sysparm_query_no_domain paramètre n’est disponible que pour les administrateurs système ou les utilisateurs disposant du rôle query_no_domain_table_api. |
| sysparm_view | Vue de l’interface utilisateur permettant de restituer les données. Détermine les champs renvoyés dans la réponse. Valeurs valides :
Si vous spécifiez également le sysparm_fields paramètre, il prévaut. Type de données : chaîne |
| Nom | Description |
|---|---|
| paires nom-valeur | Paires nom-valeur du ou des champs à mettre à jour dans la table 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\ » } » \. |
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.
| 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. |
| X-no-response-body | Par défaut, les réponses incluent le contenu du corps détaillant l’enregistrement modifié. Définissez cet en-tête sur vrai dans la demande de suppression du corps de la réponse. |
| 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.
| 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é. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| paires nom-valeur | Tous les champs (pas seulement modifiés) avec leurs valeurs associées pour la demande de changement. |
Demande cURL
Mettez à jour un enregistrement dans la table Incident.
curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
--user 'username':'password'
La réponse contient les paires nom-valeur de l’enregistrement mis à jour.
{
"result": {
"upon_approval": "proceed",
"location": {
"link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
"value": "108752c8c611227501d4ab0e392ba97f"
},
"expected_start": "",
"reopen_count": "",
"close_notes": "",
"additional_assignee_list": "",
"impact": "1",
"urgency": "1",
"correlation_id": "",
"sys_tags": "",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"description": "",
"group_list": "",
"priority": "1",
"delivery_plan": "",
"sys_mod_count": "7",
"work_notes_list": "",
"business_service": "",
"follow_up": "",
"closed_at": "",
"sla_due": "2017-07-05 05:58:24",
"delivery_task": "",
"sys_updated_on": "2016-01-22 14:12:37",
"parent": "",
"work_end": "",
"number": "INC0000050",
"closed_by": "",
"work_start": "",
"calendar_stc": "",
"category": "hardware",
"business_duration": "",
"incident_state": "2",
"activity_due": "2016-01-22 16:12:37",
"correlation_display": "",
"company": {
"link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
"value": "31bea3d53790200044e0bfc8bcbe5dec"
},
"active": "true",
"due_date": "",
"assignment_group": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
"value": "8a5055c9c61122780043563ef53438e3"
},
"caller_id": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
"value": "5b7c200d0a640069006b3845b5d0fa7c"
},
"knowledge": "false",
"made_sla": "true",
"comments_and_work_notes": "",
"parent_incident": "",
"state": "2",
"user_input": "",
"sys_created_on": "2015-11-02 18:05:40",
"approval_set": "",
"reassignment_count": "0",
"rfc": "",
"child_incidents": "",
"opened_at": "2015-11-02 21:58:24",
"short_description": "Can't access Exchange server - is it down?",
"order": "",
"sys_updated_by": "admin",
"resolved_by": "",
"notify": "1",
"upon_reject": "cancel",
"approval_history": "",
"problem_id": "",
"work_notes": "",
"calendar_duration": "",
"close_code": "",
"sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
"approval": "not requested",
"caused_by": "",
"severity": "3",
"sys_created_by": "glide.maint",
"resolved_at": "",
"assigned_to": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
"value": "681b365ec0a80164000fb0b05854a0cd"
},
"business_stc": "",
"wf_activity": "",
"sys_domain_path": "/",
"cmdb_ci": {
"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
"value": "281190e3c0a8000b003f593aa3f20ca6"
},
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
"value": "glide.maint"
},
"subcategory": "",
"rejection_goto": "",
"sys_class_name": "incident",
"watch_list": "",
"time_worked": "",
"contact_type": "phone",
"escalation": "3",
"comments": ""
}
}