Obtenir un incident ServiceNow

Récupère un incident existant depuis ServiceNow à l'aide de l'API Table.

Pour la configuration de l’authentification, voir les actions d’incident ServiceNow.

Saisir	Type	Description	Exemple
domain	Chaîne	Obligatoire. Domaine de l'instance ServiceNow. Utilisé pour construire l'URL de base `your-domain.service-now.com` .	`"your-domain"`
apiKey	Chaîne	Obligatoire. Clé API REST ServiceNow pour l'authentification. Transmis en tant qu'en-tête de requête `x-sn-apikey` . Doit être fourni en tant que secret.	`"${{ :secrets:serviceNowApiKey }}"`
sysId	Chaîne	Obligatoire. ID système unique de l'incident à récupérer. Doit être une chaîne alphanumérique de 32 caractères (non au format UUID).	`"fa7616894723b210f89ff3ac416d43c2"`
paramètres	Carte	Facultatif. Paramètres de requête d'URL facultatifs pour la requête d'API ServiceNow. Contrôle le format et le contenu de la réponse de l'API. Consultez le tableau de référence des paramètres ci-dessous.	`"{\"sysparm_fields\": \"name,short_description\", \"sysparm_exclude_reference_link\": \"true\", \"sysparm_input_display_value\": \"false\", \"sysparm_display_value\": \"true\"}"` Consultez Exportation vers la spécification OpenAPI pour obtenir une liste des paramètres acceptés.
selectors	List	Facultatif.	`[{\"name\": \"incidentNumber\", \"expression\": \".responseBody.result.number\"}]`

Référence des paramètres d'URL courants

paramètres	Type	Description	Défaut
sysparm_fields	Chaîne	Liste de champs séparés par des virgules à renvoyer dans la réponse.
sysparm_exclude_reference_link	Chaîne	`true` ou `false` pour exclure les liens de référence de la réponse.	`false`
sysparm_display_value	Chaîne	`true` , `false` ou `all` pour renvoyer des valeurs d'affichage au lieu des valeurs réelles.	`false`
sysparm_input_display_value	Chaîne	`true` ou `false` . Lorsque `true` , définit les valeurs des champs en utilisant leur valeur d'affichage au lieu de la valeur réelle.	`false`
sysparm_suppress_auto_sys_field	Chaîne	`true` ou `false` . Lorsque `true` , supprime la génération automatique des champs système.	`false`
sysparm_view	Chaîne	Restitue la réponse selon une vue spécifique de l'interface utilisateur. Remplacé par `sysparm_fields` .	`default`
sysparm_query_no_domain	Chaîne	`true` ou `false` . Lorsque `true` , permet l'accès aux données entre les domaines si autorisé.	`false`

Sortir	Type	Exemple
response	Objet	`{ "result": { "number": "INC0019382", "description": "The server is on fire.", "short_description": "The server is on fire.", "priority": "3" } }`
success	Booléen	`success: true \| false`
errorMessage	Chaîne	`[ { "success": false, "errorMessage": "{\"error\":{\"message\":\"User Not Authenticated\",\"detail\":\"Required to provide Auth information\"},\"status\":\"failure\"}" } ]`

Sortir

Type

Exemple

response

Objet

{
"result": {
    "number": "INC0019382",
    "description": "The server is on fire.",
    "short_description": "The server is on fire.",
    "priority": "3"
}
}

success

Booléen

success: true | false

errorMessage

Chaîne

[
  {
    "success": false,
    "errorMessage": "{\"error\":{\"message\":\"User Not Authenticated\",\"detail\":\"Required to provide Auth information\"},\"status\":\"failure\"}"
  }
]

Exemple de workflow
`name: get-servicenow-incident description: to get a incident from ServiceNow steps: - type: action name: getIncident action: serviceNow.incident.get version: 1 inputs: domain: "your-domain" apiKey: "${{ :secrets:serviceNowApiKey }}" sysId: "ed59ab193b67ba10e811026aa5e45a2d" parameters: sysparm_fields: "number,short_description,description,priority" selectors: - name: sysId expression: .responseBody.result.sys_id next: end`

Exemple de workflow

name: get-servicenow-incident
description: to get a incident from ServiceNow
steps:
  - type: action
    name: getIncident
    action: serviceNow.incident.get
    version: 1
    inputs:
      domain: "your-domain"
      apiKey: "${{ :secrets:serviceNowApiKey }}"
      sysId: "ed59ab193b67ba10e811026aa5e45a2d"
      parameters:
        sysparm_fields: "number,short_description,description,priority"
      selectors:
        - name: sysId
          expression: .responseBody.result.sys_id
    next: end

Cette traduction automatique est fournie pour votre commodité.

Référence des paramètres d'URL courants