ActivitySubscriptions API

Référence API de Washington DC

Release

washingtondc

ft:locale

fr-FR

ft:publication_title

Référence API de Washington DC

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

ActivitySubscriptions API

Rversion finale: Washingtondc

Mis à jour 1 févr. 2024

19 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 Customer Central (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/activities

Récupère les enregistrements d’activité à partir du cadre de travail des abonnements et du 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/activities

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 de date/d’heure. La demande renvoie uniquement les enregistrements créés avant ces date et heure. Type de données : chaîne Format : AAAA-MM-JJ 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 pour le 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 de date/d’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 : AAAA-MM-JJ hh :mm :ss ou AAAA-MM-JJ
Facettes	Liste séparée par des virgules des sys_ids de types de facettes de l’activité à récupérer pour le contexte d’activité spécifié. Ces sys_ids sont situés 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 : renvoie tous les types de facettes de l’activité configurés pour le contexte de l’activité.
dernier	Valeur d’index de la première ligne de résultat omise dans le corps de la réponse. L’index de 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, `définir last=5` omet les lignes d’index 5 et plus et ne renvoie au maximum que les cinq premières lignes de résultat (avec des valeurs d’index comprises entre 0 et 4). Les paramètres `stFrom=1` et `last=5` ignorent la première ligne de résultat et renvoient les deuxième à cinquième lignes de résultat (avec les valeurs d’index 1 à 4). Type de données : nombre (entier) Valeur 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 de détails sur les facettes dynamiques, voir Créer des facettes pour les contextes d’activité. Type de données : chaîne
start_date	Valeur de date/d’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 : AAAA-MM-JJ hh :mm :ss ou AAAA-MM-JJ
stÀ partir de	Valeur d’index de la première ligne de résultats à inclure dans le corps de la réponse. L’index de ligne du 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
Néant

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 une 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 une 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 de corps result.message de 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 ne possède pas l’un des context paramètres de requête et context_instance ou les deux. Ces paramètres sont obligatoires. `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 la valeur 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 peuvent pas être utilisés séparément. `start_date ne peut pas être en avance sur end_date` indique que la valeur spécifiée start_date du paramètre de requête se produit 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 context requête ne représente pas un contexte d’activité valide. `Assurez-vous qu’une context_instance valide est transmise` 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 de 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" }`
activités.résultats	Tableau d’objets dans lequel chaque objet représente un enregistrement d’activité à partir du contexte d’activité et de l’instance de contexte spécifiés. Type de données : tableau `"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és [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 vignette de l’enregistrement d’activité. Type de données : tableau `"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 : true : 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 : true : le champ de contenu s’affiche au format Auparavant. false : 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.afficher_étiquette	Marqueur indiquant si l’étiquette de champ de contenu s’affiche ou non pour les valeurs de champ de contenu dans la vignette de cet enregistrement d’activité. Valeurs valides : true : l’étiquette de champ de contenu s’affiche pour les valeurs de champ de contenu dans la vignette de cet enregistrement d’activité. false : l’étiquette de champ de contenu ne s’affiche pas pour les valeurs de champ de contenu dans la vignette 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ésultat	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és [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 `"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 de sous en-tête 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 : true : 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. false : 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 ou non au format Auparavant. Valeurs valides : true : 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.label	Étiquette du champ de sous-en-tête. Type de données : chaîne
result.activities.subheader_fields.afficher_étiquette	Marqueur indiquant si l’étiquette de champ d’en-tête de sous-en-tête s’affiche ou non pour les valeurs de champ d’en-tête secondaire dans la vignette de cet enregistrement d’activité. Valeurs valides : true : l’étiquette de champ d’en-tête de sous-tête s’affiche pour les valeurs de champ d’en-tête de sous-en-tête dans la vignette de cet enregistrement d’activité. false : l’étiquette de champ d’en-tête secondaire ne s’affiche pas pour les valeurs de champ d’en-tête secondaire dans la vignette 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 de 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] pour le 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 du 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 vignette pour 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 last valeur du paramètre de requête. Valeurs valides : true : 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 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é pendant le traitement de la demande. Type de données : chaîne
résultat.état	Code d’état HTTP renvoyé pour la demande. Valeurs valides : reportez-vous aux codes d’état. Type de données : nombre
result.stream	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 pour le 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 comprend 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 du flux d’activités. Affiche les nombres d’activités et les données pour chaque facette, tels que 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 admin 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 d’informations sur les facettes de contexte d’activité, voir 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}