AssessmentCreation : global

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 4 minutes de lecture
  • L’API AssessmentCreation fournit des méthodes que les administrateurs peuvent utiliser pour générer des évaluations et des enquêtes.

    Il existe plusieurs façons d’appeler la méthode createAssessments( ). Vous devez définir le typeID paramètre dans tous les cas pour identifier un type de mesure ou une définition d’enquête.

    Certains des facteurs qui influencent le comportement de la méthode incluent :
    • Indique si la cible est une évaluation ou une enquête
    • Indique si le type de calendrier d’évaluation est sur demande ou planifié
    • Périodes de calendrier des enquêtes
    • Paramètres fournis

    Par exemple, lorsque la méthode est appelée avec uniquement le jeu de typeID paramètres, la méthode recherche les personnes concernées ou les utilisateurs de l’enquête auxquels envoyer des invitations. En revanche, lorsque la méthode est appelée avec les typeID paramètres and userID définis, elle tente d’envoyer des invitations aux utilisateurs spécifiés.

    AssessmentCreation : createAssessments (chaîne typeID, chaîne sourceRecordID, chaîne userID)

    Crée une ou plusieurs évaluations ou enquêtes pour le type de mesure ou la définition d’enquête spécifié.

    Tableau 1. Paramètres
    Nom Type Description
    TypeID Chaîne Le sys_id du type de mesure ou de la définition d’enquête pour lequel générer des évaluations ou des enquêtes.
    sourceRecordID Chaîne Une ou plusieurs définitions d’enquête séparées par des virgules sys_ids à inclure dans les évaluations générées. Un enregistrement évaluable doit être associé au type de mesure spécifié pour chaque enregistrement source. Si ce paramètre est laissé vide, les évaluations générées incluent tous les enregistrements évaluables pour le type spécifié. Ce paramètre est destiné à être utilisé uniquement avec des évaluations.
    userID Chaîne Une ou plusieurs sys_ids d’utilisateurs séparés par des virgules auxquels envoyer des instances d’évaluation ou d’enquête. Si ce paramètre est laissé vide, les personnes concernées par l’évaluation ou les utilisateurs de l’enquête reçoivent des instances. Ce paramètre est requis pour les évaluations à la demande.
    Tableau 2. Renvoie
    Type Description
    Chaîne Si la méthode réussit, elle renvoie une chaîne séparée par des virgules telle que 7a2ad2253784200044e0bfc8bcbe5de1, 10, b7e8b5d4c0a80169008b49e468920048 (ID d’instance, nombre d’instances, ID de groupe) avec les valeurs suivantes :
    • instanceID : Sys_id de l’instance d’évaluation ou d’enquête créée, s’il n’y en a qu’une. Sys_id d’une des instances, s’il y en a plusieurs. S’il existe plusieurs instances, utilisez l’ID du groupe pour récupérer les données.
    • #instances : nombre d’instances d’évaluation ou d’enquête créées.
    • groupID : Sys_id du groupe d’évaluation qui contient les instances d’évaluation ou d’enquête créées.

    Si la méthode ne parvient pas à générer des évaluations ou des enquêtes, elle renvoie l’un des codes d’erreur.

    Codes d'erreur
    • isscheduled : indique que le paramètre ou sourceRecordID n’aurait userID pas dû être utilisé. Lorsque la typeID valeur représente un type de mesure avec le champ Type de calendrier défini sur Planifié, le typeID paramètre est le seul paramètre qui peut être utilisé.
    • draft_state : indique que la typeID valeur est un type de mesure ou une définition d’enquête qui n’est pas publiée. Publiez le type de mesure ou la définition de l’enquête.
    • invalidType : indique qu’aucun type de mesure existant ne correspond à la typeID valeur.
    • inactif : indique que la valeur est un type de mesure ou une définition d’enquête qui n’est typeID pas active. Accédez au type de mesure ou à la définition de l’enquête et cochez la case Actif .
    • not_available : indique que la typeID valeur est un type de mesure ou une définition d’enquête qui n’a pas de mesures ou de questions d’enquête. Ajoutez au moins une question de mesure ou d’enquête.
    • notyet : indique qu’au moins un des utilisateurs dans la userID valeur est affecté à une instance d’enquête pour la définition d’enquête spécifiée qui n’a pas encore expiré. Le code d’erreur renvoie la date d’expiration.
    • WIP : indique qu’au moins un des utilisateurs dans la userID valeur est déjà affecté à une instance d’enquête pour l’enquête.
    • not_authorized : indique qu’au moins un des utilisateurs dans la userID valeur n’est pas autorisé à participer à l’enquête. Vérifiez que l’une des affirmations suivantes est vraie :
      • Il n’y a aucun utilisateur participant à l’enquête pour la définition d’enquête spécifiée.
      • Tous les utilisateurs de la valeur userID sont enregistrés en tant qu’utilisateurs de l’enquête pour la définition d’enquête spécifiée.
    • terminé : indique que la typeID valeur est une définition d’enquête dont le champ Période de calendrier est défini sur Une seule fois et qu’au moins un des utilisateurs dans la userID valeur a déjà terminé une instance d’enquête pour cette définition d’enquête.
    • nousers : indique que le paramètre n’a userID pas été utilisé et que l’une des affirmations suivantes est vraie :
      • Aucune personne concernée n’est associée au type de mesure spécifié. Définissez le userID paramètre ou créez au moins une personne concernée.
      • Aucun utilisateur de l’enquête n’est associé à la définition d’enquête spécifiée. Définissez le userID paramètre ou créez au moins un utilisateur d’enquête.
    • nosources : indique que la typeID valeur est un type de mesure avec le champ Type de calendrier défini sur Sur demande et que ni le paramètre ni sourceRecordID n’a userID été utilisé. Définissez au moins un de ces paramètres.

    Cet exemple de code montre comment générer une instance d’évaluation dans un widget du portail de services. Cet exemple ne fonctionnera pas si le type de calendrier est défini sur Sur demande.

    (function() {
      var gdtSurvey = new GlideDateTime();
      if (gdtSurvey.getDayOfMonthUTC() == 23) {
        (new SNC.AssessmentCreation()).createAssessments('d902e09a075730101263f19d7c1ed03a', // Assessment metric type sys_id
          '4baec2fe07d3f0101263f19d7c1ed0a6', // Assessable record which is the source of the assessment
          gs.getUserID()); // Users ID to send the assessment instances to
      }
    })();

    Renvoyer les résultats :

    bbf0b9b8072330101263f19d7c1ed00b,1,33f0f978072330101263f19d7c1ed05f