ActivitySubscriptions API

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 18 minutes de lecture

    • L’API ActivitySubscriptions fournit des points de terminaison pour récupérer les entités d’activité à partir du cadre de travail des abonnements et du flux d’activités.

    Cette API nécessite l’activation du module d’extension Subscriptions and Activity Feed Framework (com.snc.activity_subscriptions). Activez le module d’extension Centre client (com.sn_csm_customer_central) pour amorcer la configuration dans toutes les tables requises. Pour plus d’informations sur les paramètres de configuration du centre client, consultez Configurer le centre client.

    ActivitySubscriptions : GET /now/actsub/activités

    Récupère les enregistrements d’activité à partir du cadre de travail des abonnements et des flux d’activités.

    Aucun rôle n’est requis pour accéder à ce point de terminaison, mais les données renvoyées sont limitées par les paramètres d’accès utilisateur.

    Format d'URL

    URL versionnée : /api/now/{api_version}/actsub/activités

    URL par défaut : /api/now/actsub/activities

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 2. Paramètres de requête
    Nom Description
    avant Valeur date/heure. La demande renvoie uniquement les enregistrements créés avant cette date et cette heure.

    Type de données : chaîne

    Format : JJ-MM-AAAA hh :mm :ss ou AAAA-MM-JJ
    contexte Requis. Sys_id d’un contexte d’activité. Situé dans la table Contexte de l’activité [sn_actsub_activity_context].

    Les contextes d’activité prédéfinis incluent le consommateur et le contact.

    Type de données : chaîne
    context_instance Requis. Sys_id d’une instance du contexte d’activité spécifié, représentant l’initiateur des activités que vous souhaitez récupérer. Situé dans la table appropriée au contexte de l’activité.

    Par exemple, si vous définissez context le sys_id du contexte d’activité du consommateur, définissez ce paramètre sur le sys_id de l’enregistrement de la table Consommateur [csm_consumer] pour le consommateur dont vous souhaitez récupérer les activités.

    Type de données : chaîne
    end_date Valeur date/heure. La demande renvoie uniquement les enregistrements créés pendant la période définie par start_date et ce paramètre. Doit être défini avec start_date.

    Type de données : chaîne

    Format : JJ-MM-AAAA hh :mm :ss ou AAAA-MM-JJ
    Facettes Liste séparée par des virgules des sys_ids de types de facettes d’activité à récupérer pour le contexte d’activité spécifié. Ces sys_ids se trouvent dans la table Facette de l’activité [sn_actsub_facet].

    Pour plus de détails sur les facettes d’activité, consultez Créer des facettes pour les contextes d’activité.

    Type de données : chaîne

    Par défaut : renvoyer tous les types de facettes d’activité configurés pour le contexte d’activité.
    dernier Valeur d’index de la première ligne de résultat omise dans le corps de la réponse. L’index de la ligne de résultat commence à 0, donc la dernière ligne incluse dans le corps de la réponse est celle dont l’index lastest -1.

    Par exemple, la définition de last=5 omet les lignes d’index 5 ou plus et ne renvoie au maximum que les cinq premières lignes de résultats (avec des valeurs d’index comprises entre 0 et 4). La définition de stFrom=1 et last=5 ignore la première ligne de résultat et renvoie les deuxième à cinquième lignes de résultats (avec les valeurs d’index 1 à 4).

    Type de données : nombre (entier)

    Par défaut : valeur de la propriété système com.snc.actsub.activities.api.fetch.limit (10 par défaut).
    record_id Sys_id d’un enregistrement à utiliser lors du rendu des facettes dynamiques. Situé dans la table appropriée pour le type d’activité que vous souhaitez récupérer.

    Par exemple, si vous souhaitez extraire les activités d’un enregistrement de ticket, définissez ce paramètre sur le sys_id de l’enregistrement de ticket en question.

    Pour plus d’informations sur les facettes dynamiques, consultez Créer des facettes pour les contextes d’activité.

    Type de données : chaîne
    start_date Valeur date/heure. La demande renvoie uniquement les enregistrements créés pendant la période définie par ce paramètre et end_date. Doit être défini avec end_date.

    Type de données : chaîne

    Format : JJ-MM-AAAA hh :mm :ss ou AAAA-MM-JJ
    stÀ partir de Valeur d’index de la première ligne de résultat à inclure dans le corps de la réponse. L’index de ligne de résultat commence à 0.

    Par exemple, stFrom=2 ignore les deux premières lignes de résultats et renvoie les résultats à partir de la troisième ligne.

    Type de données : nombre (entier)

    Par défaut : 0
    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement 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
    Aucun

    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 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. Le paramètre Corps result.message de la réponse décrit la nature de l’erreur.
    Exemples de messages d’erreur :
    • Assurez-vous qu’un contexte et des context_instance valides sont transmis ou assurez-vous qu’un flux et un utilisateur valides sont transmis indique que la demande manque l’un des paramètres de context requête et context_instance ou les deux. Ces paramètres sont requis.
    • La valeur stFrom ne peut pas être supérieure à la dernière indique que la valeur du paramètre de stFrom requête dépasse celle du paramètre de last requête.
    • Veuillez fournir start_date et end_date indique que la demande inclut un seul des paramètres de start_date requête et end_date , qui ne peut pas être utilisé séparément.
    • start_date ne peut pas être en avance sur end_date indique que la valeur spécifiée du paramètre de requête survient start_date après la valeur spécifiée du paramètre de end_date requête.
    • Le contexte fourni n’est pas configuré dans le système indique que la valeur du paramètre de requête ne représente pas un contexte d’activité context valide.
    • Assurez-vous qu’un context_instance valide est transmis indique que la valeur du context_instance paramètre de requête ne représente pas une instance valide du contexte d’activité spécifié.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

    Nom Description
    résultat Objet de résultat.

    Type de données : objet

    
"result": {
  "activities": [Array],
  "message": "String",
  "status": Number,
  "stream": "String",
  "user": "String"
}
    Résultat.Activités Tableau d’objets dans lequel chaque objet représente un enregistrement d’activité provenant du contexte d’activité et de l’instance de contexte spécifiés.

    Type de données : tableau d’objets

    "activities": [
  {
    "activity_type_id": "String",
    "content_fields": [Array],
    "created": "String",
    "icon": "String",
    "source_table_name": "String",
    "subheader_fields": [Array],
    "subobject_sys_id": "String",
    "subobject_table_name": "String",
    "sys_id": "String",
    "title": "String"
  }
]
    result.activities.activity_type_id Sys_id de l’enregistrement de la table Types d’activité [sn_actsub_activity_type] qui correspond au type de cet enregistrement d’activité.

    Type de données : chaîne
    result.activities.content_fields Tableau d’objets dans lequel chaque objet représente un champ à afficher en tant que contenu dans la tuile de l’enregistrement d’activité.

    Type de données : tableau d’objets

    "content_fields": [
  {
    "deeplink_to_subobject": "String",
    "display_as_timeago": "String",
    "label": "String",
    "show_label": "String",
    "type": "String",
    "value": "String"
  }
]
    result.activities.content_fields.deeplink_to_subobject Marqueur indiquant si le champ de contenu s’affiche ou non sous forme de lien hypertexte vers l’enregistrement de l’objet sur lequel cette activité a été effectuée.
    Valeurs valides :
    • vrai : le champ de contenu s’affiche sous la forme d’un lien hypertexte vers l’enregistrement de l’objet sur lequel cette activité a été effectuée.
    • false : le champ de contenu s’affiche sous la forme d’un lien hypertexte vers l’enregistrement de l’objet sur lequel cette activité a été effectuée.

    Type de données : chaîne
    result.activities.content_fields.display_as_timeago Marqueur indiquant si le champ de contenu s’affiche ou non au format Auparavant.
    Valeurs valides :
    • vrai : le champ de contenu s’affiche au format Auparavant.
    • faux : le champ de contenu ne s’affiche pas au format Auparavant.

    Type de données : chaîne
    result.activities.content_fields.label Étiquette du champ de contenu.

    Type de données : chaîne
    result.activities.content_fields.show_label Marqueur indiquant si l’étiquette de champ de contenu s’affiche ou non pour les valeurs de champ de contenu dans la tuile de cet enregistrement d’activité.
    Valeurs valides :
    • vrai : l’étiquette de champ de contenu s’affiche pour les valeurs de champ de contenu dans la tuile de cet enregistrement d’activité.
    • faux : l’étiquette du champ de contenu ne s’affiche pas pour les valeurs de champ de contenu dans la tuile de cet enregistrement d’activité.

    Type de données : chaîne
    result.activities.content_fields.type Type du champ de contenu.

    Type de données : chaîne
    result.activities.content_fields.valeur Valeur du champ de contenu.

    Type de données : chaîne
    résultat.activités.créé Date/heure de création de cet enregistrement d’activité.

    Type de données : chaîne

    Format : AAAA-JJ-MM hh :mm :ss
    icône.activités.résultats Nom de l’icône affichée sur la vignette pour cet enregistrement d’activité.

    Type de données : chaîne
    result.activities.source_table_name Nom de la table dans laquelle se trouve cet enregistrement d’activité.

    Déterminé par la source d’activité définie dans la table Types d’activité [sn_actsub_activity_type] pour le type associé à cet enregistrement d’activité.

    Type de données : chaîne
    result.activities.subheader_fields Tableau d’objets dans lequel chaque objet représente un champ affiché dans le sous-en-tête de la vignette pour cet enregistrement d’activité.

    Type de données : tableau d’objets

    "subheader_fields": [
  {
    "deeplink_to_subobject": "String",
    "display_as_timeago": "String",
    "label": "String",
    "show_label": "String",
    "type": "String",
    "value": "String"
  }
]
    result.activities.subheader_fields.deeplink_to_subobject Marqueur indiquant si le champ d’en-tête s’affiche ou non sous la forme d’un lien hypertexte vers l’enregistrement de l’objet sur lequel cette activité a été effectuée.
    Valeurs valides :
    • vrai : le champ de sous-en-tête s’affiche sous la forme d’un lien hypertexte vers l’enregistrement de l’objet sur lequel cette activité a été effectuée.
    • faux : le champ de sous-en-tête ne s’affiche pas sous la forme d’un lien hypertexte vers l’enregistrement de l’objet sur lequel cette activité a été effectuée.

    Type de données : chaîne
    result.activities.subheader_fields.display_as_timeago Marqueur indiquant si le champ de sous-en-tête s’affiche au format Auparavant ou non.
    Valeurs valides :
    • vrai : le champ de sous-en-tête s’affiche au format Auparavant.
    • false : le champ de sous-en-tête ne s’affiche pas au format Auparavant.

    Type de données : chaîne
    result.activities.subheader_fields.étiquette Étiquette du champ de sous-en-tête.

    Type de données : chaîne
    result.activities.subheader_fields.show_label Marqueur indiquant si l’étiquette du champ de sous-en-tête s’affiche ou non pour les valeurs de champ de sous-en-tête dans la tuile de cet enregistrement d’activité.
    Valeurs valides :
    • vrai : l’étiquette du champ de sous-en-tête s’affiche pour les valeurs de champ de sous-en-tête dans la tuile de cet enregistrement d’activité.
    • faux : l’étiquette du champ de sous-en-tête ne s’affiche pas pour les valeurs de champ de sous-en-tête dans la tuile de cet enregistrement d’activité.

    Type de données : chaîne
    result.activities.subheader_fields.type Type du champ de sous-en-tête.

    Type de données : chaîne
    result.activities.subheader_fields.valeur Valeur du champ de sous-en-tête.

    Type de données : chaîne
    result.activities.subobject_sys_id Sys_id de l’enregistrement pour l’objet sur lequel cette activité a été effectuée. Situé dans la table spécifiée dans la valeur du subobject_table_name paramètre.

    Type de données : chaîne
    result.activities.subobject_table_name Nom de la table contenant l’enregistrement de l’objet sur lequel cette activité a été effectuée.

    Déterminé par le nom de table défini dans la table Groupe d’activités [sn_actsub_subscribable_object] du groupe contenant le type d’activité associé à cet enregistrement d’activité.

    Type de données : chaîne
    result.activities.sys_id Sys_id de cet enregistrement d’activité. Situé dans la table spécifiée comme valeur du paramètre Corps de la source_table_name réponse.

    Type de données : chaîne
    Résultat.Activités.Titre Titre qui s’affiche sur la tuile de cet enregistrement d’activité.

    Type de données : chaîne
    result.hasMoreRecords Marqueur indiquant si la liste des activités dans le corps de la réponse est tronquée par la valeur du last paramètre de requête.
    Valeurs valides :
    • vrai : la liste des activités dans le corps de la réponse est tronquée par la valeur du last paramètre de requête. La répétition de la demande avec une valeur de paramètre de requête plus élevée last renvoie des activités supplémentaires pour ce contexte et cette instance de contexte.
    • false : la liste des activités dans le corps de la réponse n’est pas tronquée par la valeur du last paramètre de requête. Aucune autre activité n’est disponible pour ce contexte et cette instance de contexte.

    Type de données : chaîne
    résultat.message Message d’erreur décrivant le problème rencontré lors du traitement de la demande.

    Type de données : chaîne
    Résultat.État Code d’état HTTP renvoyé pour la demande.

    Valeurs valides : consultez la section Codes d’état.

    Type de données : nombre
    flux_résultats Sys_id spécifié dans le paramètre de requête de la demande context . Situé dans la table Contexte de l’activité [sn_actsub_activity_context].

    Type de données : chaîne
    résultat.utilisateur Sys_id spécifié dans le paramètre de requête de la demande context_instance . Situé dans la table appropriée au contexte de l’activité.

    Type de données : chaîne

    Demande cURL

    Demander les deuxième et troisième enregistrements d’activité pour un contact spécifique, en se limitant aux données de 2020 :

    curl "https://instance.servicenow.com/api/now/actsub/activities\
?context=4a6a035a73d30010e37d71ef64f6a714\
&context_instance=ddce70866f9331003b3c498f5d3ee417\
&stFrom=1&last=3\
&start_date=2020-01-01%2000:00:00&end_date=2020-12-31%2023:59:59" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

    Le corps de réponse inclut les deux enregistrements d’activité demandés pour le contact spécifié :

    {
  "result": {
    "hasMoreRecords": true,
    "activities": [
      {
        "subobject_table_name": "sn_customerservice_case",
        "source_table_name": "sn_customerservice_case",
        "content_fields": [
          {
            "value": "Test",
            "show_label": "false",
            "type": "string",
            "label": "Short description",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "false"
          }
        ],
        "created": "2020-05-29 18:42:16",
        "activity_type_id": "baf0aace73530010e37d71ef64f6a748",
        "title": "Lamar Wilson created case",
        "subobject_sys_id": "1687360e8d819010f87705a074e52ac9",
        "icon": "clipboard_outline",
        "sys_id": "1687360e8d819010f87705a074e52ac9",
        "subheader_fields": [
          {
            "value": "CS0001007",
            "show_label": "false",
            "type": "string",
            "label": "Number",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "true"
          },
          {
            "value": "2020-05-29 18:42:16",
            "show_label": "false",
            "type": "glide_date_time",
            "label": "Created",
            "display_as_timeago": "true",
            "deeplink_to_subobject": "false"
          },
          {
            "value": "",
            "show_label": "false",
            "type": "reference",
            "label": "Assigned to",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "false"
          },
          {
            "value": "Lamar Wilson",
            "show_label": "false",
            "type": "reference",
            "label": "Contact",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "false"
          }
        ]
      },
      {
        "subobject_table_name": "kb_knowledge",
        "source_table_name": "kb_use",
        "content_fields": [
          {
            "value": "How to Set Up a Broadband Router",
            "show_label": "false",
            "type": "string",
            "label": "Short description",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "false"
          }
        ],
        "created": "2020-05-26 10:00:00",
        "activity_type_id": "4a8c329273d30010e37d71ef64f6a7c1",
        "title": "Lamar Wilson viewed knowledge article",
        "subobject_sys_id": "f855a0a89f011200550bf7b6077fcf4f",
        "icon": "document_outline",
        "sys_id": "b929dd5873941010e37d71ef64f6a719",
        "subheader_fields": [
          {
            "value": "KB0000110",
            "show_label": "false",
            "type": "string",
            "label": "Number",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "true"
          },
          {
            "value": "2020-05-26 10:00:00",
            "show_label": "false",
            "type": "glide_date_time",
            "label": "Created",
            "display_as_timeago": "true",
            "deeplink_to_subobject": "false"
          }
        ]
      }
    ]
  }
}

    ActivitySubscriptions : GET /now/actsub/facets/{activity_context}/{context_instance}

    Récupère les facettes configurées pour un contexte d’activité à partir du cadre de travail des abonnements et des flux d’activités. Affiche les nombres d’activités et les données de chaque facette déterminés par le type d’activité, le groupe et les paramètres de contexte.

    Les utilisateurs doivent avoir le rôle actsub_user ou administrateur pour accéder à ce point de terminaison. Les données renvoyées sont limitées par les paramètres d’accès de l’utilisateur.

    Pour plus de détails sur les facettes de contexte d’activité, consultez Créer des facettes pour les contextes d’activité.

    Format d'URL

    URL versionnée : /api/now/{api_version}/actsub/facets/{activity_context}/{context_instance}

    URL par défaut : /api/now/actsub/facets/{activity_context}/{context_instance}

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    activity_context Sys_id d’un contexte d’activité. Situé dans la table Contextes d’activité [sn_actsub_activity_context].

    Les contextes d’activité prédéfinis incluent le consommateur et le contact. Accédez à la Centre clientèle > Activité du client > Contextes des activités pour afficher la liste complète des contextes d’activité définis pour votre instance.

    Type de données : chaîne
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    context_instance Sys_id d’une instance du contexte d’activité spécifié, représentant l’initiateur des activités pour lesquelles vous souhaitez récupérer des facettes. Situé dans la table de contexte spécifiée pour l’enregistrement de contexte d’activité dans la table Contextes d’activité [sn_actsub_activity_context].

    Par exemple, si vous définissez activity_context le sys_id du contexte d’activité Contact, vous devez définir ce paramètre sur le sys_id de l’enregistrement Contact [customer_contact] pour le contact dont vous souhaitez récupérer les facettes de l’activité.

    Type de données : chaîne
    Tableau 8. Paramètres de requête
    Nom Description
    end_date Valeur date/heure. La demande renvoie uniquement les enregistrements créés pendant la période définie par start_date et ce paramètre. Doit être défini avec start_date.

    Type de données : chaîne

    Format : JJ-MM-AAAA hh :mm :ss ou AAAA-MM-JJ
    Facettes Liste séparée par des virgules des sys_ids de facettes d’activité à récupérer pour le contexte d’activité spécifié.

    Pour afficher les types de facettes d’activité définis pour un contexte d’activité, accédez à Centre clientèle > Activité du client > Contextes des activités et examinez la liste connexe Facettes .

    Type de données : chaîne

    Par défaut : renvoie toutes les facettes d’activité configurées pour le contexte d’activité.
    get_activity_count Marqueur indiquant s’il faut inclure ou non les nombres d’activités pour chaque facette dans le corps de la réponse.
    Valeurs valides :
    • true : inclure les nombres d’activités des facettes.
    • faux : omettre les nombres d’activités des facettes.

    Type de données : booléennes

    Valeur par défaut : false
    lazy_load Marqueur indiquant s’il faut ou non améliorer les performances en omettant les données d’activité des facettes et les nombres d’activités du corps de la réponse. Ce paramètre est prioritaire sur get_activity_count.
    Valeurs valides :
    • vrai : omettez les données d’activité des facettes et les nombres d’activités.
    • faux : récupérer les données d’activité des facettes et les nombres d’activités.

    Type de données : booléennes

    Valeur par défaut : false
    start_date Valeur date/heure. La demande renvoie uniquement les enregistrements créés pendant la période définie par ce paramètre et end_date. Doit être défini avec end_date.

    Type de données : chaîne

    Format : JJ-MM-AAAA hh :mm :ss ou AAAA-MM-JJ
    Tableau 9. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement 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
    Tableau 11. En-têtes de réponses
    En-tête Description
    Aucun

    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é correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. Le paramètre Corps result.message de la réponse décrit la nature de l’erreur.
    Exemples de messages d’erreur :
    • Assurez-vous que les détails d’un contexte d’activité valide sont transmis indiquent que la valeur du paramètre de chemin d’accès activity_context ne représente pas un contexte d’activité valide, que la valeur du context_instance paramètre de chemin d’accès ne représente pas une instance valide du contexte d’activité spécifié, ou les deux.
    • Veuillez fournir start_date et end_date indique que la demande inclut un seul des paramètres de start_date requête et end_date , qui ne peut pas être utilisé séparément.
    • start_date ne peut pas être en avance sur end_date indique que la valeur spécifiée du paramètre de requête survient start_date après la valeur spécifiée du paramètre de end_date requête.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

    Nom Description
    résultat Liste des facettes de l’activité.

    Type de données : tableau d’objets

    "result": [
  {
    "activity_count": Number,
    "children": [Array],
    "facets": [Array],
    "icon": "String",
    "is_dynamic": "String",
    "message": "String",
    "name": "String",
    "status": Number
  }
]
    result.activity_count Nombre d’enregistrements d’activités inclus dans cette facette (et ses enfants, le cas échéant. S’affiche uniquement lorsque le paramètre de requête est faux et get_activity_count que le lazy_load paramètre de requête est vrai.

    Type de données : nombre
    result.enfants Tableau d’objets dans lequel chaque objet représente un enregistrement d’activité (s’il s’agit d’une facette dynamique) ou une facette enfant (s’il s’agit d’une facette statique).

    Type de données : tableau d’objets

    
"children": [
  {
    "activity_count": Number
    "facet": "String",
    "icon": "String",
    "title": "String"
  }
]
    result.children.activity_count Nombre d’enregistrements d’activités inclus dans cette facette enfant (et ses enfants, le cas échéant). S’affiche uniquement lorsque le paramètre de lazy_load requête est faux et que le paramètre de get_activity_count requête est vrai.

    Type de données : nombre
    résultat.enfants.créés Date/heure de création de cet enregistrement d’activité.

    Type de données : chaîne

    Format : JJ-MM-AAAA hh :mm :ss
    result.enfants.facette Sys_id de cet enregistrement de facette enfant. Situé dans la table Facette de l’activité [sn_actsub_facet].

    Type de données : chaîne
    icône.enfants.résultats Nom de l’icône associée à cette facette enfant.

    Type de données : chaîne
    result.children.sys_id Sys_id de cet enregistrement d’activité. Situé dans la table appropriée pour le type de facette parent.

    Par exemple, un enregistrement d’activité inclus dans la facette Tickets a un sys_id situé dans la table Ticket [sn_customerservice_case].

    Type de données : chaîne
    result.enfants.metadata Tableau d’objets dans lequel chaque objet inclut des données d’enregistrement d’activité pour un champ de facette configuré dans l’enregistrement de la table Facette d’activité [sn_actsub_facet] pour ce type de facette.

    Type de données : tableau d’objets

    
"metadata": [
  {
    "key": "String",
    "label": "String",
    "type": "String",
    "value": "String"
  }
]
    result.children.metadata.key Nom de ce champ de facette.

    Type de données : chaîne
    résultat.enfants.métadonnées.étiquette Étiquette de ce champ de facette.

    Type de données : chaîne
    résultat.enfants.métadonnées.type Type de ce champ de facette.

    Type de données : chaîne
    résultat.enfants.métadonnées.valeur Valeur de ce champ de facette.

    Type de données : chaîne
    résultat.enfants.titre Nom de cet enregistrement d’activité ou de cette facette enfant.

    Type de données : chaîne
    result.facets Tableau des sys_ids associés à cet enregistrement de facette. Situé dans la table Facette de l’activité [sn_actsub_facet]. Pour une facette dynamique, ce tableau contient la sys_id de la facette elle-même. Pour une facette statique, il contient plutôt la sys_ids de toutes les facettes qui sont des enfants de la facette.

    Type de données : tableau

    
"facets": [
  "510d7e2e73570010e37d71ef64f6a70d",
  "bc9bfaaa73570010e37d71ef64f6a771"
]
    icône résultat.icône Nom de l’icône associée à cette facette.

    Type de données : chaîne
    result.is_dynamic Marqueur indiquant si cette facette est une facette dynamique ou non. Cette valeur détermine le type d’informations incluses dans le paramètre Corps de la children réponse.
    Valeurs possibles :
    • true : il s’agit d’une facette dynamique. La children valeur du paramètre Corps de la réponse contient des détails sur l’enregistrement d’activité et le facets paramètre contient les sys_id de facette dynamique.
    • false : il s’agit d’une facette statique (un groupe de facettes). La children valeur du paramètre corps de réponse contient des facettes enfants et le facets paramètre contient la sys_ids de ces facettes enfants.

    Type de données : booléennes
    résultat.message Message d’erreur décrivant un problème rencontré pendant le traitement de la demande.

    Type de données : chaîne
    result.name Nom de la facette ou du groupe de facettes.

    Type de données : chaîne
    Résultat.État Code d’état HTTP renvoyé pour la demande.

    Valeurs possibles : consultez le tableau Code d’état.

    Type de données : nombre

    Demande cURL

    Récupérer les facettes et les nombres d’activités des articles de messagerie instantanée, de téléphone et de connaissances pour un contact :

    curl "https://instance.servicenow.com/api/now/actsub/facets/4a6a035a73d30010e37d71ef64f6a714/ddce70866f9331003b3c498f5d3ee417\
?get_activity_count=true\
&facets=510d7e2e73570010e37d71ef64f6a70d,bc9bfaaa73570010e37d71ef64f6a771,c72d7e2e73570010e37d71ef64f6a7b8" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

    Le corps de la réponse inclut les trois facettes demandées en tant qu’enfants de leurs groupes de facettes, avec des nombres d’activités affichés :

    {
  "result": [
    {
      "is_dynamic": false,
      "name": "Interactions",
      "activity_count": 4.0,
      "facets": [
        "510d7e2e73570010e37d71ef64f6a70d",
        "bc9bfaaa73570010e37d71ef64f6a771"
      ],
      "children": [
        {
          "facet": "510d7e2e73570010e37d71ef64f6a70d",
          "icon": "chat_outline",
          "activity_count": 2.0,
          "title": "Chat"
        },
        {
          "facet": "bc9bfaaa73570010e37d71ef64f6a771",
          "icon": "phone_outline",
          "activity_count": 2.0,
          "title": "Phone"
        }
      ]
    },
    {
      "is_dynamic": false,
      "name": "Portal Activity",
      "activity_count": 5.0,
      "facets": [
        "c72d7e2e73570010e37d71ef64f6a7b8"
      ],
      "children": [
        {
          "facet": "c72d7e2e73570010e37d71ef64f6a7b8",
          "icon": "document_outline",
          "activity_count": 5.0,
          "title": "Knowledge articles"
        }
      ]
    }
  ]
}