API REST du test exécutable dans le cloud

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 8 minutes de lecture
  • Gère les tests à exécuter dans un exécuteur dans le cloud pour Framework de tests automatisés (ATF).

    L’API Cloud Runner Test Runner nécessite le (sn_atf_tg) module d’extension ATF Test Generator and Cloud Runner . Les méthodes disponibles avec cette API s’exécutent dans l’espace de noms Now et peuvent être appelées à l’aide de Nom de l’API, Test de régression en un clic pour ATF, dans l’explorateur d’API REST. Le rôle admin est requis pour accéder à cette API.

    Vous pouvez utiliser cette API pour les tâches suivantes :
    • Démarrez un test ATF ou une suite de tests dans le navigateur Cloud Runner.
    • Vérifiez la progression de la tâche de test.
    • Annulez la tâche de test.

    L’API Cloud Runner Test Runner peut être utilisée en tandem avec les balises API REST de génération des tests de l’exécuteur dans le cloud et API REST de l’utilisateur test de l’exécuteur dans le cloud. Par exemple, vous pouvez générer un test (API de génération de test de l’exécuteur dans le cloud), puis obtenir la progression du test dans la file d’attente d’orchestration du navigateur (API de génération de test de l’exécuteur dans le cloud) et vérifier le nombre de tests qui ont réussi ou échoué.

    Pour consulter la documentation de référence de l’API Server relative à cette API, reportez-vous à la section TestRunnerAPI de l’exécuteur dans le cloud : champ d’application, global.

    Test exécutable dans le cloud : GET /now/sn_atf_tg/test_runner_progress

    Fournit l’état de chaque test exécuté pour un enregistrement de file d’attente d’orchestration du navigateur (BOQ) fourni.

    Format d'URL

    URL par défaut : GET /api/now/sn_atf_tg/test_runner_progress

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    Néant
    Tableau 2. Paramètres de requête
    Nom Description
    snboqId Requis. L’enregistrement BOQ sys_id de la tâche d’exécuteur de test dont la progression.

    Type de données : chaîne

    Table : Boq [sn_atf_tg_sn_boq]

    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 Progression de la tâche de nomenclature récupérée avec succès.
    400 Erreur lors de l’obtention de l’état d’enregistrement de nomenclature. Renvoie l’un des messages suivants :
    • Aucun ID de devis transmis : aucun identifiant de devis n’a été fourni. Ajoutez l’ID de nomenclature au corps de la demande.
    • Impossible de trouver l’enregistrement BOQ : ID système non valide. Vérifiez que le sys_id de l’enregistrement de nomenclature est valide et que l’enregistrement existe.
    403 Erreur lors de l’octroi de l’accès de l’utilisateur au point de terminaison. Assurez-vous que l’utilisateur dispose du rôle administrateur.

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

    Nom Description
    résultat Objet contenant les résultats de progression de la tâche de test exécutable ou un message expliquant pourquoi la demande a échoué.

    Type de données : objet

    "result": { 
        "progress": 100, 
        "state": "completed" 
      }

    Ou :

    {
      "result": { 
        "message": "String" 
      } 
    }
    résultat.message Message d’erreur expliquant pourquoi la progression du test exécutable ne peut pas être récupérée. Le paramètre message n’est pas renvoyé dans une réponse réussie.

    Type de données : chaîne

    Résultat.Progrès Pourcentage qui indique à quel point un test est proche de l’achèvement lorsqu’il est à l’état En cours d’exécution.

    Type de données : nombre

    résultat.état État actuel de l’enregistrement de la nomenclature.
    Valeurs possibles :
    • Navigateurs demandés : une demande a été envoyée à l’infrastructure dans le cloud pour démarrer les navigateurs pour la génération ou l’exécution du test.
    • Terminé : la tâche de test est terminée.
    • État Échec : la tâche de test a échoué.
    • En attente : l’activité de test demandée a été créée et attend d’être exécutée.
    • Traitement : l’instance recherche des enregistrements pour s’assurer que les suivis d’exécution sont marqués pour l’exécuteur dans le cloud avant que la demande ne soit envoyée à l’infrastructure dans le cloud.
    • En cours d’exécution : Les navigateurs de l’infrastructure cloud détectent et exécutent des tests en attente.

    Type de données : chaîne

    Demande cURL

    La demande suivante récupère la progression de la tâche de test exécutable de l’enregistrement BOQ.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=<sys_id of SNBOQ record>" \ 
    --request GET \ 
    --header "Accept:application/json" \ 
    --user "username:password"

    La réponse indique que le test est terminé à 100 %.

    { 
      "result": { 
        "progress": 100, 
        "state": "completed" 
      } 
    }

    L’exemple suivant renvoie un message d’erreur 400 lorsqu’aucun ID de nomenclature n’est transmis.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress" \
    --request GET \
    --header "Accept:application/json" \
    --user "username:password"

    Réponse :

    {
      "result": {
        "message": "No SNBOQ ID passed in, add snboqId to request body"
      }
    }

    L’exemple suivant renvoie un message d’erreur 400 lorsqu’un ID de nomenclature non valide est transmis.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=invalid_sys_id" \
    --request GET \
    --header "Accept:application/json" \
    --user "username:password"

    Réponse :

    {
      "result": {
        "message": "Invalid SNBOQ sys_id passed in"
      }
    }

    Test exécutable de l’exécuteur dans le cloud : POST /now/sn_atf_tg/cancel_test_runner

    Définit la tâche de test exécutable sur l’état Terminé et annule les suivis racines de tous les tests générés en cours d’exécution.

    Format d'URL

    URL par défaut : GET /now/sn_atf_tg/cancel_test_runner

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    Néant
    Tableau 8. Paramètres de requête
    Nom Description
    Néant
    Tableau 9. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    snboqId Sys_id de l’enregistrement de file d’attente d’orchestration du navigateur (BOQ) (sn_atf_tg_sn_boq) associé à la tâche d’exécuteur de test à annuler.

    Type de données : chaîne

    Table : Boq [sn_atf_tg_sn_boq]

    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

    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 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 Réussi. La demande a été traitée avec succès.
    400 Erreur lors de l’annulation de la tâche. Renvoie l’un des messages suivants :
    • Aucun ID de devis transmis : aucun identifiant de devis n’a été fourni. Ajoutez l’ID de nomenclature au corps de la demande.
    • Impossible de trouver l’enregistrement BOQ : ID système non valide. Vérifiez que le sys_id de l’enregistrement de nomenclature est valide et que l’enregistrement existe.
    403 Erreur lors de l’octroi de l’accès de l’utilisateur au point de terminaison. Assurez-vous que l’utilisateur dispose du rôle administrateur.

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

    Nom Description
    résultat Objet contenant les résultats de la demande.
    
      "result": { 
        "message": String
      }

    Type de données : objet

    résultat.message Message détaillant si l’annulation du test a réussi.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment former une demande d’annulation de test exécutable en fonction de l’sys_id de l’enregistrement BOQ.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_runner" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \ 
    --user "username:password"

    Message de réponse indiquant que le test exécutable a été annulé avec succès.

    { 
      "result": { 
        "message": "success" 
      } 
    } 

    Test exécutable de l’exécuteur dans le cloud : POST /now/sn_atf_tg/test_runner

    Insère une tâche d’exécuteur de test dans la table BOQ [sn_atf_tg_sn_boq] pour un test ou une suite de tests donné, qui est ensuite exécutée sur l’exécuteur dans le cloud.

    Format d'URL

    URL par défaut : POST api/now/sn_atf_tg/test_runner

    Paramètres de demande pris en charge

    Tableau 13. Paramètres de chemin d'accès
    Nom Description
    Néant
    Tableau 14. Paramètres de requête
    Nom Description
    Néant
    Tableau 15. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    ID du test Sys_id du test [sys_atf_test] ou de la suite de tests [sys_atf_test_suite] à exécuter sur l’exécuteur dans le cloud.

    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
    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 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 Une tâche BOQ de test exécutable a été insérée avec succès.
    400 Erreur lors du démarrage de la tâche de test exécutable. Renvoie l’un des messages suivants :
    • Impossible de trouver le test ou la suite de tests avec l’ID système <testId> : ID de test non valide. Assurez-vous que la sys_id de l’enregistrement du test (sys_atf_test) ou de la suite de tests (sys_atf_test_suite) est valide et que l’enregistrement existe.
    • Aucun ID de test transmis : aucun ID de test n’a été transmis. Ajoutez l’ID de test au corps de la demande.
    403 Erreur lors de l’octroi de l’accès de l’utilisateur au point de terminaison. Assurez-vous que l’utilisateur dispose du rôle administrateur.

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

    Nom Description
    résultat Objet contenant les résultats de la demande.

    Type de données : objet

    { 
      "result": { 
        "snboqId": "String" 
      } 
    }

    Ou :

    
      "result": { 
        "message": "String"
      }
    résultat.snboqId Sys_id de l’enregistrement BOQ inséré au démarrage de l’exécuteur de test.

    Type de données : chaîne

    Table : Boq [sn_atf_tg_sn_boq]

    résultat.message Message d’erreur expliquant pourquoi le test exécutable ne peut pas être démarré.

    Type de données : chaîne

    Demande cURL

    La demande suivante insère une tâche d’exécuteur de test dans la table BOQ [sn_atf_tg_sn_boq].

    curl "https://instance.service-now.com/api/now/sn_atf_tg/test_runner" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{\"testId\":\"<sys_id of ATF test or test suite>\"}" \ 
    --user "username:password"

    Le corps de la réponse renvoie le sys_id de la tâche du test exécutable qui a été insérée avec succès.

    { 
      "result": { 
        "snboqId": "<sys_id of newly inserted SNBOQ record>" 
      } 
    }