ActivitySubscriptions-API

Washington DC API-Referenz

Release

washingtondc

ft:locale

de-DE

ft:publication_title

Washington DC API-Referenz

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

ActivitySubscriptions-API

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

15 Minuten Lesedauer

Die ActivitySubscriptions -API bietet Endpunkte zum Abrufen von Aktivitätsentitäten aus dem Abonnement- und Aktivitäts-Feed-Framework.

Diese API erfordert die Aktivierung des Plugins „Subscriptions and Activity Feed Framework“ (com.snc.activity_subscriptions). Aktivieren Sie das Plugin „Customer Central“ (com.sn_csm_customer_central), um die Konfiguration in allen erforderlichen Tabellen zu ermitteln. Weitere Informationen zu den Konfigurationseinstellungen der Kundenzentralefinden Sie unter Kundenzentrale konfigurieren.

ActivitySubscriptions – GET /now/actsub/activities

Ruft Aktivitätsdatensätze aus dem Abonnement- und Aktivitäts-Feed-Framework ab.

Für den Zugriff auf diesen Endpunkt ist keine Rolle erforderlich, aber die zurückgegebenen Daten sind durch die Benutzerzugriffseinstellungen beschränkt.

URL-Format

Versionierte URL: /api/now/{api_version}/actsub/activities

Standard-URL: /api/now/actsub/activities

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter
Name	Beschreibung
vor	Datums-/Uhrzeitwert. Die Anforderung gibt nur Datensätze zurück, die vor diesem Datum und dieser Uhrzeit erstellt wurden. Datentyp: Zeichenfolge Format: JJJJ-MM-TT hh:mm:ss oder JJJJ-MM-TT
context	Erforderlich. Sys_id eines Aktivitätskontexts. Befindet sich in der Tabelle „Aktivitätskontext“ [sn_actsub_activity_context]. Zu den vordefinierten Aktivitätskontexten gehören Verbraucher und Kontakt. Datentyp: Zeichenfolge
context_instance	Erforderlich. Sys_id einer Instanz des angegebenen Aktivitätskontexts, die den Initiator der Aktivitäten darstellt, die Sie abrufen möchten. Befindet sich in der entsprechenden Tabelle für den Aktivitätskontext. Wenn Sie beispielsweise context auf die sys_id des Verbraucheraktivitätskontexts festlegen, legen Sie diesen Parameter auf die sys_id des Datensatzes der Tabelle „Verbraucher“ [csm_consumer] für den Verbraucher fest, dessen Aktivitäten Sie abrufen möchten. Datentyp: Zeichenfolge
end_date	Datums-/Uhrzeitwert. Die Anforderung gibt nur Datensätze zurück, die während des durch start_date und diesen Parameter definierten Zeitraums erstellt wurden. Muss zusammen mit start_datefestgelegt werden. Datentyp: Zeichenfolge Format: JJJJ-MM-TT hh:mm:ss oder JJJJ-MM-TT
Aspekte	Kommagetrennte Liste von sys_ids von Aktivitätsaspekttypen, die für den angegebenen Aktivitätskontext abgerufen werden sollen. Diese sys_ids befinden sich in der Tabelle „Aktivitätsaspekt“ [sn_actsub_facet]. Weitere Informationen zu Aktivitätsaspekten finden Sie unter Aspekte für Aktivitätskontexte erstellen. Datentyp: Zeichenfolge Standard: Gibt alle für den Aktivitätskontext konfigurierten Aktivitätsaspekttypen zurück.
letzte	Indexwert der ersten im Antworttext ausgelassenen Ergebniszeile. Der Ergebniszeilenindex beginnt bei 0, daher ist die letzte im Antworttext enthaltene Zeile die mit dem Index last-1. Wenn Sie beispielsweise `last=5` festlegen, werden Zeilen mit Index 5 und höher ausgelassen und höchstens die ersten fünf Ergebniszeilen zurückgegeben (mit den Indexwerten 0 bis 4). Wenn `stFrom=1` und `last=5` festgelegt wird, wird die erste Ergebniszeile übersprungen und die zweite bis fünfte Ergebniszeile (mit den Indexwerten 1 bis 4) zurückgegeben. Datentyp: Zahl (Ganzzahl) Standard: Der Wert der Systemeigenschaft com.snc.actsub.activities.api.fetch.limit (standardmäßig 10).
record_id	Sys_id eines Datensatzes, der beim Rendern dynamischer Aspekte verwendet werden soll. Befindet sich in der entsprechenden Tabelle für den Aktivitätstyp, den Sie abrufen möchten. Wenn Sie beispielsweise Aktivitäten für einen Falldatensatz abrufen möchten, legen Sie diesen Parameter auf die sys_id des betreffenden Falldatensatzes fest. Weitere Informationen zu dynamischen Aspekten finden Sie unter Aspekte für Aktivitätskontexte erstellen. Datentyp: Zeichenfolge
start_date	Datums-/Uhrzeitwert. Die Anforderung gibt nur Datensätze zurück, die während des durch diesen Parameter und end_datedefinierten Zeitraums erstellt wurden. Muss zusammen mit end_datefestgelegt werden. Datentyp: Zeichenfolge Format: JJJJ-MM-TT hh:mm:ss oder JJJJ-MM-TT
stFrom	Indexwert der ersten Ergebniszeile, die in den Antworttext aufgenommen werden soll. Der Ergebniszeilenindex beginnt bei 0. Zum Beispiel überspringt `stFrom=2` die ersten beiden Ergebniszeilen und gibt Ergebnisse ab der dritten Zeile zurück. Datentyp: Zahl (Ganzzahl) Standard: 0

Tabelle : 3. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Der Parameter des Antworttexts result.message beschreibt die Art des Fehlers. Beispiele für Fehlermeldungen: `Stellen Sie sicher, dass ein gültiger Kontext und eine gültige context_instance übergeben werden,` oder stellen `Sie sicher, dass ein gültiger Stream und ein gültiger Benutzer übergeben werden, und` geben Sie an, dass in der Anforderung einer oder beide Abfrageparameter context und context_instance fehlen. Diese Parameter sind erforderlich. `stFrom darf nicht größer als der letzte sein`, der angibt, dass der Abfrageparameterwert laststFrom den Abfrageparameterwert [] überschreitet. `Geben Sie start_date an, und end_date` gibt an, dass die Anforderung nur einen der Abfrageparameter start_date und end_date enthält, die nicht separat verwendet werden können. `start_date darf nicht vor end_date liegen`, gibt an, dass der angegebene Abfrageparameterwert start_date nach dem angegebenen Abfrageparameterwert end_date liegt. Der angegebene`Kontext ist nicht im System konfiguriert. Dies` weist darauf hin, dass der Abfrageparameterwert context keinen gültigen Aktivitätskontext darstellt. `Stellen Sie sicher, dass eine gültige context_instance übergeben wird. Gibt an`, dass der Wert des Abfrageparameters context_instance keine gültige Instanz des angegebenen Aktivitätskontexts darstellt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
Ergebnis	Ergebnisobjekt. Datentyp: Objekt `"result": { "activities": [Array], "message": "String", "status": Number, "stream": "String", "user": "String" }`
result.activities	Array von Objekten, in dem jedes Objekt einen Aktivitätsdatensatz aus dem angegebenen Aktivitätskontext und der Kontextinstanz darstellt. Datentyp: Array `"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 des Datensatzes aus der Tabelle „Aktivitätstypen“ [sn_actsub_activity_type], der dem Typ dieses Aktivitätsdatensatzes entspricht. Datentyp: Zeichenfolge
result.activities.content_fields	Array von Objekten, in dem jedes Objekt ein Feld darstellt, das als Inhalt in der Kachel für den Aktivitätsdatensatz angezeigt werden soll. Datentyp: Array `"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	Kennzeichnung, die angibt, ob das Inhaltsfeld als Hyperlink zum Datensatz für das Objekt angezeigt wird, für das diese Aktivität ausgeführt wurde. Gültige Werte: true: Das Inhaltsfeld wird als Hyperlink zum Datensatz für das Objekt angezeigt, für das diese Aktivität ausgeführt wurde. false: Das Inhaltsfeld wird als Hyperlink zum Datensatz für das Objekt angezeigt, für das diese Aktivität ausgeführt wurde. Datentyp: Zeichenfolge
result.activities.content_fields.display_as_timeago	Kennzeichnung, die angibt, ob das Inhaltsfeld im Format „Vor“ angezeigt wird. Gültige Werte: true: Das Inhaltsfeld wird im Format „Vor“ angezeigt. false: Das Inhaltsfeld wird nicht im Format „Vor“ angezeigt. Datentyp: Zeichenfolge
result.activities.content_fields.label	Bezeichnung für das Inhaltsfeld. Datentyp: Zeichenfolge
result.activities.content_fields.show_label	Kennzeichnung, die angibt, ob die Inhaltsfeldbezeichnung für Inhaltsfeldwerte in der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Gültige Werte: true: Die Inhaltsfeldbezeichnung wird für Inhaltsfeldwerte in der Kachel für diesen Aktivitätsdatensatz angezeigt. false: Die Inhaltsfeldbezeichnung wird für Inhaltsfeldwerte in der Kachel für diesen Aktivitätsdatensatz nicht angezeigt. Datentyp: Zeichenfolge
result.activities.content_fields.type	Typ des Inhaltsfelds. Datentyp: Zeichenfolge
result.activities.content_fields.value	Wert des Inhaltsfelds. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Erstellt	Erstellungsdatum/-uhrzeit für diesen Aktivitätsdatensatz. Datentyp: Zeichenfolge Format: JJJJ-TT-MM hh:mm:ss
result.activities.icon	Name des Symbols, das auf der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Datentyp: Zeichenfolge
result.activities.source_table_name	Name der Tabelle, in der sich dieser Aktivitätsdatensatz befindet. Wird durch die Aktivitätsquelle bestimmt, die in der Tabelle „Aktivitätstypen“ [sn_actsub_activity_type] für den mit diesem Aktivitätsdatensatz verknüpften Typ definiert ist. Datentyp: Zeichenfolge
result.activities.subheader_fields	Array von Objekten, in dem jedes Objekt ein Feld darstellt, das im Subheader der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Datentyp: Array `"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	Kennzeichnung, die angibt, ob das Subheader-Feld als Hyperlink zum Datensatz für das Objekt angezeigt wird, für das diese Aktivität ausgeführt wurde. Gültige Werte: true: Das Subheader-Feld wird als Hyperlink zum Datensatz für das Objekt angezeigt, für das diese Aktivität ausgeführt wurde. false: Das Subheader-Feld wird nicht als Hyperlink zum Datensatz für das Objekt angezeigt, für das diese Aktivität ausgeführt wurde. Datentyp: Zeichenfolge
result.activities.subheader_fields.display_as_timeago	Kennzeichnung, die angibt, ob das Subheader-Feld im Format „Vor“ angezeigt wird. Gültige Werte: true: Das Subheader-Feld wird im Format „Vor“ angezeigt. false: Das Subheader-Feld wird nicht im Format „Vor“ angezeigt. Datentyp: Zeichenfolge
result.activities.subheader_fields.label	Bezeichnung für das Subheader-Feld. Datentyp: Zeichenfolge
result.activities.subheader_fields.show_label	Kennzeichnung, die angibt, ob die Unterkopfzeilen-Feldbezeichnung für Unterkopfzeilen-Feldwerte in der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Gültige Werte: true: Die Subheader-Feldbezeichnung wird für Subheader-Feldwerte in der Kachel für diesen Aktivitätsdatensatz angezeigt. false: Die Subheader-Feldbezeichnung wird für Subheader-Feldwerte in der Kachel für diesen Aktivitätsdatensatz nicht angezeigt. Datentyp: Zeichenfolge
result.activities.subheader_fields.type	Typ des Subheader-Felds. Datentyp: Zeichenfolge
result.activities.subheader_fields.value	Wert des Subheader-Felds. Datentyp: Zeichenfolge
result.activities.subobject_sys_id	Sys_id des Datensatzes für das Objekt, für das diese Aktivität ausgeführt wurde. Befindet sich in der Tabelle, die im Parameterwert subobject_table_name angegeben ist. Datentyp: Zeichenfolge
result.activities.subobject_table_name	Name der Tabelle, die den Datensatz für das Objekt enthält, für das diese Aktivität ausgeführt wurde. Wird durch den Tabellennamen bestimmt, der in der Tabelle „Aktivitätsgruppe“ [sn_actsub_subsscribeable_object] für die Gruppe definiert ist, die den mit diesem Aktivitätsdatensatz verknüpften Aktivitätstyp enthält. Datentyp: Zeichenfolge
result.activities.sys_id	Sys_id dieses Aktivitätsdatensatzes. Befindet sich in der Tabelle, die als Wert des Antworttextparameters source_table_name angegeben ist. Datentyp: Zeichenfolge
ergebnis.aktivitäten.titel	Titel, der auf der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Datentyp: Zeichenfolge
result.hatMehrDatensätze	Kennzeichnung, die angibt, ob die Liste der Aktivitäten im Antworttext durch den Abfrageparameterwert last gekürzt wird. Gültige Werte: true: Die Liste der Aktivitäten im Antworttext wird durch den Abfrageparameterwert last gekürzt. Wenn Sie die Anforderung mit einem höheren Abfrageparameterwert last wiederholen, werden zusätzliche Aktivitäten für diesen Kontext und diese Kontextinstanz zurückgegeben. false: Die Liste der Aktivitäten im Antworttext wird nicht durch den Abfrageparameterwert last gekürzt. Für diesen Kontext und diese Kontextinstanz sind keine weiteren Aktivitäten verfügbar. Datentyp: Zeichenfolge
result.message	Fehlermeldung, die das Problem beschreibt, das bei der Anforderungsverarbeitung aufgetreten ist. Datentyp: Zeichenfolge
result.status	HTTP-Statuscode, der für die Anforderung zurückgegeben wird. Gültige Werte: Siehe Statuscodes. Datentyp: Zahl
result.stream	Sys_id, die im Abfrageparameter der Anforderung context angegeben ist. Befindet sich in der Tabelle „Aktivitätskontext“ [sn_actsub_activity_context]. Datentyp: Zeichenfolge
result.user	Sys_id, die im Abfrageparameter der Anforderung context_instance angegeben ist. Befindet sich in der entsprechenden Tabelle für den Aktivitätskontext. Datentyp: Zeichenfolge

cURL-Anforderung

Fordern Sie den zweiten und dritten Aktivitätsdatensatz für einen bestimmten Kontakt an, der auf Daten aus dem Jahr 2020 beschränkt ist:

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"

Der Antworttext enthält die beiden angeforderten Aktivitätsdatensätze für den angegebenen Kontakt:

{
  "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}

Ruft für einen Aktivitätskontext konfigurierte Aspekte aus dem Abonnement- und Aktivitäts-Feed-Framework ab. Zeigt Aktivitätsanzahlen und Daten für jeden Aspekt an, wie durch Aktivitätstyp, Gruppe und Kontexteinstellungen bestimmt.

Benutzer müssen über die Rolle „actsub_user“ oder „admin“ verfügen, um auf diesen Endpunkt zugreifen zu können. Die zurückgegebenen Daten sind durch die Benutzerzugriffseinstellungen beschränkt.

Weitere Informationen zu Aktivitätskontextaspekten finden Sie unter Aspekte für Aktivitätskontexte erstellen.

URL-Format

Versionierte URL: /api/now/{api_version}/actsub/facets/{activity_context}/{context_instance}

Standard-URL: /api/now/actsub/facets/{activity_context}/{context_instance}