Paramètres d'action

Les paramètres d’action sont distincts et différents des paramètres de données, car ils spécifient l’action à effectuer lorsque le paramètre d’objet JSON fait partie d’une demande HTTP, GET ou POST.

Les paramètres peuvent également être spécifiés en tant que champ dans l’objet JSON fourni. Ils ont pour effet de déclencher une action dans le cas d’sysparm_action, ou de filtrer les résultats d’une mise à jour ou d’une requête dans le cas d’sysparm_query.

sysparm_action

Voici les valeurs valides pour sysparm_action et l’action correspondante déclenchée par l’API.

Tableau 1. Récupération de données

Résumé de la méthode	Description
getKeys (en anglais)	Interrogez la table ciblée à l’aide d’une chaîne de requête codée et renvoyez une liste de valeurs sys_id séparées par des virgules.
getRecords	Interrogez la table ciblée à l’aide d’une chaîne de requête codée et renvoyez tous les enregistrements correspondants ainsi que leurs champs.
get	Interrogez un enregistrement unique de la table ciblée en spécifiant le sys_id dans le paramètre URL sysparm_sys_id , puis renvoyez l’enregistrement et ses champs.

Tableau 2. Modification de données

Résumé de la méthode	Description
insérer	Créez un ou plusieurs enregistrements pour la table ciblée par l’URL.
insérerMultiple	Créez plusieurs nouveaux enregistrements pour la table ciblée par l’URL.
mettre à jour	Mettez à jour les enregistrements existants dans la table ciblée dans l’URL, filtrés par une chaîne de requête codée.
deleteRecord	Supprimez un enregistrement de la table ciblée par l’URL en spécifiant son sys_id dans le paramètre d’URL sysparm_sys_id .
deleteMultiple	Supprimez plusieurs enregistrements de la table ciblée par l’URL, filtrés par une chaîne de requête codée.

sysparm_query

Spécifiez une chaîne de requête codée à utiliser dans les valeurs get, getRecords, update ou deleteMultiplesysparm_action.

sysparm_view

Spécifiez une vue de formulaire pour personnaliser les valeurs de retour pour les appels de fonction get et getRecords. Lors de l’utilisation d’une vue, la requête renvoie uniquement les champs définis dans la vue, y compris les valeurs référencées. S’il n’y a pas de nom de vue ou si le nom de vue n’est pas valide, la requête renvoie tous les noms de champs marqués comme actifs dans le dictionnaire.

sysparm_sys_id

Spécifiez un sys_id cible lors d’un appel de fonction get ou delete (valeur sysparm_action ).

sysparm_record_count

Spécifiez une valeur entière pour limiter le nombre d’enregistrements récupérés pour cette demande. Notez que cette valeur est plafonnée par la glide.processor.json.row_limit propriété système.

Valeur d’affichage

Obtenir la valeur d’affichage d’un champ de référence, le cas échéant dans l’enregistrement. Par exemple, l’enregistrement Incident peut avoir un champ assigned_to qui est une référence à un enregistrement utilisateur. Au lieu d’envoyer le sys_id de l’enregistrement utilisateur, le nom d’utilisateur est envoyé.

Le paramètre displayvalue peut avoir trois valeurs : true, false ou all.

• true : tous les champs de référence affichent la valeur d’affichage au lieu de sys_id.
• false (par défaut) : tous les champs de référence affichent sys_ids.
• all : la valeur d’affichage et les sys_id sont affichés. Par exemple, le champ assignedto de l’enregistrement d’incident est renvoyé comme suit : assigned_to :1234556, dv_assigned_to :Fred Luddy.

Variables d’affichage

Définissez cette valeur booléenne sur vrai lors d’un appel de fonction get ou getRecords pour récupérer toutes les variables jointes à cet enregistrement.