API „ActivitySubscriptions“

Zürich-API-Referenz

Release

zurich

ft:locale

de-DE

ft:publication_title

Zürich-API-Referenz

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

API „ActivitySubscriptions“

Freigeben Version: Zurich

Aktualisiert 31. Juli 2025

14 Minuten Lesedauer

Die Aktivitätsabonnements Die API stellt Endpunkte zum Abrufen von Aktivitätsentitäten aus den Abonnements und dem Aktivitäts-Feed-Framework bereit.

Diese API erfordert die Aktivierung des Plugins „Abonnements“ und „Aktivitäts-Feed-Framework“ (com.snc.activity_Subscriptions). Aktivieren Sie das Plugin „Kundenzentrale“ (com.sn_csm_Customer_Central), um die Konfiguration in allen erforderlichen Tabellen zu starten. Weitere Informationen zu den Konfigurationseinstellungen der Kundenzentrale finden Sie unter Konfigurieren Sie die Kundenzentrale .

ActivitySubscriptions – GET /now/actsub/activities

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

Für den Zugriff auf diesen Endpunkt ist keine Rolle erforderlich, aber die zurückgegebenen Daten werden durch die Anwenderzugriffseinstellungen eingeschränkt.

URL-Format

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

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

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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. Vordefinierte Aktivitätskontexte umfassen Verbraucher und Kontakt. Datentyp: Zeichenfolge Tabelle: Aktivitätskontext [sn_actsub_activity_context]
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. Beispiel: Wenn Sie festlegen contextLegen Sie für die sys_ID des Verbraucheraktivitätskontexts diesen Parameter auf die sys_ID des Tabellendatensatzes „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 von definierten Zeitraums erstellt wurden start_dateUnd diesen Parameter. Muss zusammen mit festgelegt werden start_date. 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. Weitere Informationen zu Aktivitätsaspekten finden Sie unter Erstellen Sie Aspekte für Aktivitätskontexte . Datentyp: Zeichenfolge Standard: Gibt alle für den Aktivitätskontext konfigurierten Aktivitätsaspekttypen zurück. Tabelle: Aktivitätsaspekt [sn_actsub_facet]
letzte	Indexwert der ersten Ergebniszeile, der im Antworttext ausgelassen wurde. Der Ergebniszeilenindex beginnt bei 0, daher ist die letzte Zeile im Antworttext diejenige mit dem Index last-1. Beispiel: Einstellung `Last=5` Ignoriert Zeilen mit Index 5 und höher und gibt höchstens die ersten fünf Ergebniszeilen zurück (mit Indexwerten 0 bis 4). Einstellung `StFrom=1` Und `Last=5` Überspringt die erste Ergebniszeile und gibt die zweite bis fünfte Ergebniszeile zurück (mit Indexwerten 1 bis 4). Datentyp: Zahl (Ganzzahl) Standard: Der Wert von Com.snc.actsub.activities.api.fetch.limit Systemeigenschaft (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 Erstellen Sie Aspekte für Aktivitätskontexte . Datentyp: Zeichenfolge
start_date	Datums-/Uhrzeitwert. Die Anforderung gibt nur Datensätze zurück, die während des durch diesen Parameter und definierten Zeitraums erstellt wurden end_date. Muss zusammen mit festgelegt werden end_date. 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. Beispiel: `StFrom=2` Überspringt 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 REST API-HTTP-Antwortcodes .

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 Antworttext result.messageParameter beschreibt die Art des Fehlers. Beispielfehlermeldungen: `Stellen Sie sicher, dass ein gültiger context und context_instance übergeben werden` Oder `Stellen Sie sicher, dass ein gültiger Stream und ein gültiger Anwender übergeben werden` Gibt an, dass der Anforderung eine oder beide fehlt contextUnd context_instanceAbfrageparameter. Diese Parameter sind erforderlich. `StFrom darf nicht größer als zuletzt sein` Gibt an, dass stFromAbfrageparameterwert überschreitet lastAbfrageparameterwert. `Geben Sie Start_date und end_date an` Gibt an, dass die Anforderung nur einen der enthält start_dateUnd end_dateAbfrageparameter, die nicht separat verwendet werden können. `Start_date darf nicht vor End_date liegen` Gibt an, dass der angegeben wird start_dateAbfrageparameterwert liegt nach dem angegebenen end_dateAbfrageparameterwert. `Angegebener Kontext ist im System nicht konfiguriert` Gibt an, dass contextDer Abfrageparameterwert stellt keinen gültigen Aktivitätskontext dar. `Stellen Sie sicher, dass eine gültige context_instance übergeben wird` Gibt an, dass context_instanceDer Abfrageparameterwert stellt keine gültige Instanz des angegebenen Aktivitätskontexts dar.
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.

Antworttext-Parameter (JSON oder XML)


Name	Beschreibung
Ergebnis	Ergebnisobjekt. Datentyp: Objekt `"result": { "activities": [Array], "message": "String", "status": Number, "stream": "String", "user": "String" }`
Ergebnis.Aktivitäten	Array von Objekten, in denen jedes Objekt einen Aktivitätsdatensatz aus dem angegebenen Aktivitätskontext und der angegebenen Kontextinstanz darstellt. Datentyp: Array von Objekten `"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" } ]`
Ergebnis.Aktivitäten.Aktivität_Typ_ID	SYS_ID des Datensatzes aus der Tabelle „Aktivitätstypen“ [sn_actsub_activity_type], der dem Typ dieses Aktivitätsdatensatzes entspricht. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Inhalt_Felder	Array von Objekten, in denen jedes Objekt ein Feld darstellt, das als Inhalt in der Kachel für den Aktivitätsdatensatz angezeigt werden soll. Datentyp: Array von Objekten `"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: Wahr: Das Inhaltsfeld wird als Hyperlink zum Datensatz für das Objekt angezeigt, für das diese Aktivität ausgeführt wurde. Falsch: Das Inhaltsfeld wird als Hyperlink zum Datensatz für das Objekt angezeigt, für das diese Aktivität ausgeführt wurde. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Content_fields.Display_as_timeago	Kennzeichnung, die angibt, ob das Inhaltsfeld im Format „vor“ angezeigt wird. Gültige Werte: Wahr: Das Inhaltsfeld wird im Format „vor“ angezeigt. Falsch: Das Inhaltsfeld wird nicht im Format „vor“ angezeigt. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Inhalt_Felder.Bezeichnung	Bezeichnung für das Inhaltsfeld. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.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: Wahr: Die Inhaltsfeldbezeichnung wird für Inhaltsfeldwerte in der Kachel für diesen Aktivitätsdatensatz angezeigt. Falsch: Die Inhaltsfeldbezeichnung wird für Inhaltsfeldwerte in der Kachel für diesen Aktivitätsdatensatz nicht angezeigt. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Inhalt_Felder.Typ	Typ des Inhaltsfelds. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Inhalt_Felder.Wert	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
Ergebnis.Aktivitäten.Symbol	Name des Symbols, das auf der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Quelle_Tabelle_Name	Name der Tabelle, in der sich dieser Aktivitätsdatensatz befindet. Bestimmt durch die Aktivitätsquelle, die in der Tabelle „Aktivitätstypen“ [sn_actsub_activity_type] für den Typ definiert ist, der diesem Aktivitätsdatensatz zugeordnet ist. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Subheader_Felder	Array von Objekten, in denen jedes Objekt ein Feld darstellt, das im Unterheader der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Datentyp: Array von Objekten `"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: Wahr: Das Feld „Unterheader“ wird als Hyperlink zum Datensatz für das Objekt angezeigt, für das diese Aktivität ausgeführt wurde. Falsch: Das Feld „Unterheader“ wird nicht als Hyperlink zum Datensatz für das Objekt angezeigt, für das diese Aktivität ausgeführt wurde. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Subheader_fields.Display_as_timeago	Kennzeichnung, die angibt, ob das Unterheader-Feld im Format „vor“ angezeigt wird. Gültige Werte: Wahr: Das Feld „Unterheader“ wird im Format „vor“ angezeigt. Falsch: Das Feld „Unterheader“ wird nicht im Format „vor“ angezeigt. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Subheader_fields.label	Bezeichnung für das Subheader-Feld. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Subheader_fields.Show_label	Kennzeichnung, die angibt, ob die Bezeichnung des Unterheader-Felds für Unterheader-Feldwerte in der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Gültige Werte: Wahr: Die Feldbezeichnung des Unterheaders wird für Subheader-Feldwerte in der Kachel für diesen Aktivitätsdatensatz angezeigt. Falsch: Die Bezeichnung des Unterheader-Felds wird für Unterheader-Feldwerte in der Kachel für diesen Aktivitätsdatensatz nicht angezeigt. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Subheader_fields.type	Typ des Subheader-Felds. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.subHeader_fields.value	Wert des Subheader-Felds. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.subobject_sys_ID	SYS_ID des Datensatzes für das Objekt, für das diese Aktivität ausgeführt wurde. Befindet sich in der in angegebenen Tabelle subobject_table_nameParameterwert. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.subobject_table_Name	Name der Tabelle, die den Datensatz für das Objekt enthält, für das diese Aktivität ausgeführt wurde. Bestimmt durch den Tabellennamen, der in der Tabelle „Aktivitätsgruppe“ [sn_actsub_subscribable_object] für die Gruppe definiert ist, die den Aktivitätstyp enthält, der diesem Aktivitätsdatensatz zugeordnet ist. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.sys_ID	SYS_ID dieses Aktivitätsdatensatzes. Befindet sich in der Tabelle, die als angegeben ist source_table_nameParameterwert des Antworttexts. Datentyp: Zeichenfolge
Ergebnis.Aktivitäten.Titel	Titel, der auf der Kachel für diesen Aktivitätsdatensatz angezeigt wird. Datentyp: Zeichenfolge
Ergebnis.hasWeiterDatensätze	Kennzeichnung, die angibt, ob die Liste der Aktivitäten im Antworttext von gekürzt wird lastAbfrageparameterwert. Gültige Werte: Wahr: Die Liste der Aktivitäten im Antworttext wird von gekürzt lastAbfrageparameterwert. Anforderung wird mit einem höheren wiederholt lastDer Abfrageparameterwert gibt zusätzliche Aktivitäten für diesen Kontext und diese Kontextinstanz zurück. Falsch: Die Liste der Aktivitäten im Antworttext wird nicht von gekürzt lastAbfrageparameterwert. Für diesen Kontext und diese Kontextinstanz sind keine weiteren Aktivitäten verfügbar. Datentyp: Zeichenfolge
Ergebnis.Nachricht	Fehlermeldung, die das während der Anforderungsverarbeitung aufgetretene Problem beschreibt. Datentyp: Zeichenfolge
Ergebnis.Status	HTTP-Statuscode, der für die Anforderung zurückgegeben wird. Gültige Werte: Siehe Statuscodes. Datentyp: Zahl
Ergebnis.Stream	SYS_ID in Anforderung angegeben contextAbfrageparameter. Datentyp: Zeichenfolge Tabelle: Aktivitätskontext [sn_actsub_activity_context]
result.user	SYS_ID in Anforderung angegeben context_instanceAbfrageparameter. Befindet sich in der entsprechenden Tabelle für den Aktivitätskontext. Datentyp: Zeichenfolge

cURL-Anforderung

Fordern Sie die zweiten und dritten Aktivitätsdatensätze für einen bestimmten Kontakt an, und beschränken Sie sich auf Daten von 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"

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

Aktivitätsabonnements – GET /now/actsub/facets/{activity_context}/{context_instance}

Ruft Aspekte ab, die für einen Aktivitätskontext aus dem Framework für Abonnements und Aktivitäts-Feed konfiguriert sind. Zeigt Aktivitätsanzahlen und -Daten für jeden Aspekt an, wie durch Aktivitätstyp, Gruppe und Kontexteinstellungen festgelegt.

Anwender müssen über die Rolle „actsub_user“ oder „admin“ verfügen, um auf diesen Endpunkt zuzugreifen. Die zurückgegebenen Daten werden durch Anwenderzugriffseinstellungen eingeschränkt.

Weitere Informationen zu Aspekten des Aktivitätskontexts finden Sie unter Erstellen Sie Aspekte für Aktivitätskontexte .

URL-Format

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

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