ServiceNow
ServiceNow verbessert service levels, energisiert Mitarbeiter und ermöglicht Es Ihrem Unternehmen, mit Lightspeed zu arbeiten. Erstellen, Lesen und Aktualisieren von Datensätzen, die in ServiceNow gespeichert sind, einschließlich Vorfällen, Fragen, Benutzern und mehr.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - China Cloud betrieben von 21Vianet |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - China Cloud betrieben von 21Vianet |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - China Cloud betrieben von 21Vianet |
| Kontakt | |
|---|---|
| Name | Microsoft |
| URL | https://learn.microsoft.com/connectors/service-now/ |
| Connectormetadaten | |
|---|---|
| Herausgeber | Microsoft |
| Webseite | https://www.servicenow.com/ |
| Datenschutzrichtlinie | https://www.servicenow.com/privacy-statement.html |
| Kategorien | Webseite |
Hinweis
Der Vorgang "Wissensartikel abrufen" kann nur verwendet werden, wenn das Wissens-API-Plug-In (sn_km_api) aktiviert wird.
Bekannte Probleme und Einschränkungen
Wenn Sie die Aktion " Datensatz erstellen " verwenden, ist es nicht möglich, die vollständige Datensatzbeschreibung anzugeben. Der Feldwert wird aufgrund Service-Now REST-API-Einschränkungen ignoriert.
Die Aktion "Datensätze abrufen" gibt möglicherweise eine "Ungültige Tabelle" oder einen anderen Fehler in Power Apps zurück. Für Power Apps-Implementierungen besteht die vorgeschlagene Arbeit darin, die Aktion "Datensätze abrufen" in Power Automate zu verwenden und die Daten an Power Apps zurückzuüberreichen.
Der Connector unterstützt derzeit nur Instanz-URLs, die mit "service-now.com" enden. Die Verwendung alternativer Domänen wie "servicenowservices.com" kann zu Verbindungsfehlern führen. In solchen Fällen – insbesondere bei der Arbeit mit einer neuen ServiceNow-Domäne in GCC – wird empfohlen, die Standardauthentifizierung zu verwenden.
Wenn ein Popupfehler mit dem Hinweis "Ungültige redirect_uri" auftritt, kopieren Sie die vollständige URL aus dem Popupfenster, und extrahieren Sie den redirect_uri-Parameter (z. B. redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect). Aktualisieren Sie nach dem Decodieren der URL (ersetzen sie %3a durch : und %2f durch /), das Feld "Umleitungs-URL" in der OAuth-App-Registrierung Ihrer ServiceNow-Instanz wie in der folgenden Abbildung dargestellt. Versuchen Sie dann, die Verbindung erneut hinzuzufügen.
Einrichten einer ServiceNow Power Platform-Verbindung, die Microsoft Entra-ID verwendet
Es gibt zwei Verbindungstypen:
Microsoft Entra ID OAuth mit Zertifikat: Dies ist ein app-tokenbasierter Authentifizierungstyp, mit dem eine in der Entra-ID registrierte Anwendung für den Zugriff auf ServiceNow verwendet werden kann, indem ein Token mit der Ressource abgerufen wird, die als ServiceNow-Repräsentativ-Entra-ID-App festgelegt ist.
Microsoft Entra ID OAuth mithilfe der Benutzeranmeldung: Dies ist ein benutzertokenbasierter Authentifizierungstyp, bei dem sich der Endbenutzer bei der Entra ID 1P-Anwendung (ServiceNow Connector 1p App) anmelden und ein Zugriffstoken mit dem Für die ServiceNow-Vertreter-Entra-ID-App festgelegten Bereich abrufen kann.
Schritte zum Erstellen einer OAuth-Verbindung mit Microsoft Entra ID mithilfe des Zertifikats
Schritt 1: Registrieren sie eine "Application A" in Microsoft Entra ID für die OIDC-Integration mit ServiceNow. Dies ist der ServiceNow-Vertreter Entra ID-Anwendung .
Wechseln Sie zu App-Registrierungen > Neue Registrierung, um eine neue Anwendungsregistrierung zu erstellen.
Name: beliebiger Name der Wahl
Umleitungs-URI: nicht erforderlich
Addieren von
aud,email&upnzu den Ansprüchen unter "Optionale Ansprüche"
Schritt 2: Registrieren der gleichen ID wie ein OIDC-Anbieter in ServiceNow
Navigieren Sie zu
System OAuth > Application Registry > New > Configure an OIDC providerüberprüfen, um ID-Token zu überprüfen- Name: beliebiger Name der Wahl
-
Client-ID: die
client IDin Schritt 1 erstellte "Anwendung A" - Geheimer Clientschlüssel: Dies wird nicht verwendet, jeder Wert kann festgelegt werden.
Fügen Sie im OIDC-Anbieterregistrierungsformular eine neue OIDC-Anbieterkonfiguration hinzu. Wählen Sie das Suchsymbol für das OAuth OIDC-Anbieterkonfigurationsfeld aus, um die Datensätze von OIDC-Konfigurationen zu öffnen, und wählen Sie "Neu" aus.
- OIDC-Anbieter: Microsoft Entra ID
-
OIDC-Metadaten-URL: Die URL muss in der Form
https://login.microsoftonline.com/<tenantID>/.well-known/openid-configurationenthalten sein, ersetzen SietenantIDdurchDirectory (tenant) ID - Lebensdauer des OIDC-Konfigurationscaches: 120
- Anwendung: Global
- Benutzeranspruch: oid
- Benutzerfeld: Benutzer-ID
- Aktivieren der JTI-Anspruchsüberprüfung: Deaktiviert
Wählen Sie "Absenden" aus, und aktualisieren Sie das OAuth OIDC-Entitätsformular.
Schritt 3: Registrieren Sie eine "Anwendung B" in Microsoft Entra ID für die Connectorverwendung. Dies ist die Anwendung, die die Rolle eines Benutzers mit erhöhten Berechtigungen in der ServiceNow-Instanz spielt.
Navigieren Sie zum
App registrations > New registrationErstellen einer neuen App- Name: beliebiger Name der Wahl
- Laden Sie in Zertifikaten & Geheimnissen die .cer Datei des Zertifikats im Falle eines SNI-Zertifikats hoch, fügen Sie
trustedCertificateSubjectseinfach das Manifest der Anwendung mit dem relevantenauthorityIdundsubjectName
Schritt 4: Erstellen eines Systembenutzers in ServiceNow. Dies ist die "Application B" als Benutzer in der ServiceNow-Instanz
Navigieren Zum
User Administration > UsersErstellen eines neuen Benutzers- Benutzer-ID: Die Objekt-ID des Dienstprinzipals von "Application B", die in Schritt 3 erstellt wurde
- Überprüfen von
Web service access only
Schritt 5: Verbinden mit dem Connector – Copilot Studio – Connectorkonfiguration
Konfigurieren Sie den Connector mit den folgenden Informationen, und stellen Sie eine Verbindung her:
- Instanzname: Der Instanzname von ServiceNow
- Mandanten-ID: Die Mandanten-ID des Microsoft Entra-Mandanten
- Client-ID: Die Client-ID von "Application B", die in Schritt 3 erstellt wurde
- Ressourcen-URI: Die Client-ID von "Application A", die in Schritt 1 erstellt wurde (nicht der Anwendungs-URI)
- Geheimer Clientzertifikatschlüssel: Die PFX-Datei des in Schritt 3 erstellten Zertifikats
- Zertifikatkennwort: Das Kennwort der PFX-Datei
Schritte zum Erstellen der OAuth-Benutzeranmeldung von Microsoft Entra ID
Um eine Microsoft Entra ID OAuth-Benutzeranmeldungsverbindung zu konfigurieren, führen Sie Bitte Schritt 1 und Schritt 2 aus, wie im abschnitt "Zertifikatauthentifizierung" oben beschrieben.
Schritt 1 bleibt gleich. Aktualisieren Sie in Schritt 2 den Benutzeranspruch auf Upn oder benutzerdefinierte Anspruchseigenschaft aus dem Token (für andere Identitätsanbieter von Drittanbietern als Entra) in ServiceNow. Das Benutzerfeld sollte mit dem ServiceNow-Systembenutzertabellenfeld übereinstimmen, das den Upn oder die Benutzer-ID enthält.
Die Schritte 3 und 4 aus dem abschnitt "Zertifikatauthentifizierung" oben sind nicht erforderlich. Stattdessen ist "Application B" in diesem Fall eine 1p-App, die für den ServiceNow-Connector erstellt wird. Die folgende App muss Berechtigungen in der "Anwendung A" erhalten.
ID "Application B": c26b24aa-7874-4e06-ad55-7d06b1f79b63
Von Bedeutung
In diesem Szenario muss "Anwendung B" die ID c26b24aa-7874-4e06-ad55-7d06b1f79b63 verwenden, bei der es sich um eine bereits vorhandene 1p-App im Besitz von Microsoft handelt, nicht um eine vom Benutzer erstellte App (wie zum Erstellen einer OAuth-Verbindung mit Microsoft Entra ID mit Zertifikat erforderlich).
Beim Erstellen der Verbindung für den ServiceNow-Connector muss der Benutzer "Microsoft Entra ID User Login" als Authentifizierungstyp auswählen und nur den ServiceNow-Instanznamen und die Ressourcen-ID angeben (dies wäre der Bezeichner für "Anwendung A"). Danach übernimmt die Anmeldeschaltfläche den Benutzer über die Entra-ID-Anmeldung mit ihrem eigenen Konto.
Verwenden eines Identitätsanbieters von Drittanbietern oder Zwischenübereinstimmungen zwischen dem Benutzer in der Entra-ID und der ServiceNow-Benutzertabelle
- Wenn ein Konflikt zwischen der Benutzerbezeichnereigenschaft im Entra-ID-Token und dem Benutzerbezeichnerwert besteht, der sich in der Tabelle ServiceNow befindet
- Das Token enthält z. B. den vollständigen Upn (zusammen mit der Domäne –
abc@contoso.com) und die Tabelle "ServiceNow-Benutzer" nur den Benutzerbezeichner (abc). Es wird empfohlen, dem Token ein benutzerdefiniertes Attribut hinzuzufügen, das einen Wert enthält, der dem Benutzerbezeichner im ServiceNow-Bezeichner entspricht, indem eine Formel angewendet und dann diese neue Eigenschaft verwendet wird, um die Anspruchszuordnung in Schritt 2 auszuführen. - Microsoft Learn-Dokumentation zur Beschreibung des Prozesses zum Hinzufügen einer neuen Anspruchseigenschaft: https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token
- Das Token enthält z. B. den vollständigen Upn (zusammen mit der Domäne –
"So richten Sie eine ServiceNow Power Platform-Verbindung ein, die Microsoft Entra ID verwendet"-Verweise:
- External ID Token Authentication (OIDC) für Rest-APIs – Support und Problembehandlung
- ServiceNow-Katalog Microsoft Graph-Connector | Microsoft Learn
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Standardauthentifizierung | Anmelden mit Standardauthentifizierung | Alle Regionen | Nicht teilbar |
| Microsoft Entra ID OAuth mit Zertifikat | OAuth mit Microsoft Entra ID mit PFX-Zertifikat. | Nur POWERPLATFORM | Freigabefähig |
| Microsoft Entra ID-Benutzeranmeldung | Anmelden mit Microsoft Entra ID-Anmeldeinformationen | Alle Regionen | Nicht teilbar |
| Verwenden von Oauth2 | Anmelden mit Oauth2 | Alle Regionen | Nicht teilbar |
| Standard [VERALTET] | Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt. | Alle Regionen | Nicht teilbar |
Standardauthentifizierung
Authentifizierungs-ID: basicAuthentication
Anwendbar: Alle Regionen
Anmelden mit Standardauthentifizierung
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Instance | Schnur | Name der Instanz für service-now.com oder benutzerdefinierte URL für migriertes Konto | Richtig |
| Nutzername | Schnur | Benutzername für diese Instanz | Richtig |
| Kennwort | securestring | Das Kennwort für dieses Konto | Richtig |
Microsoft Entra ID OAuth mithilfe des Zertifikats
Auth-ID: aadOAuthCert
Anwendbar: NUR POWERPLATFORM
OAuth mit Microsoft Entra ID mit PFX-Zertifikat.
Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumente
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Instanzname | Schnur | Der Instanzname, der verwendet wird, um die ServiceNow Site URl zu identifizieren | Richtig |
| Mieter-ID | Schnur | Richtig | |
| Kunden-ID | Schnur | Richtig | |
| Ressourcen-URI | Schnur | Richtig | |
| Geheimer Clientzertifikatschlüssel | Client-Zertifikat | Der von dieser Anwendung zulässige geheime Clientzertifikatschlüssel | Richtig |
Microsoft Entra ID-Benutzeranmeldung
Auth-ID: entraIDUserLogin
Anwendbar: Alle Regionen
Anmelden mit Microsoft Entra ID-Anmeldeinformationen
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Ressourcen-URI | Schnur | Richtig | |
| Instanzname | Schnur | Der Instanzname, der zum Identifizieren der ServiceNow-Website-URL verwendet wird | Richtig |
Verwenden von Oauth2
Auth-ID: oauth2ServiceNow
Anwendbar: Alle Regionen
Anmelden mit Oauth2
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Instanzname | Schnur | Der Instanzname, der verwendet wird, um die ServiceNow Site URl zu identifizieren | Richtig |
| Client-ID | Schnur | Die ID, die verwendet wird, um diese Anwendung mit dem Dienstanbieter zu identifizieren | Richtig |
| Geheimer Clientschlüssel | securestring | Der freigegebene Geheimschlüssel, der zum Authentifizieren dieser Anwendung beim Dienstanbieter verwendet wird | Richtig |
Standard [VERALTET]
Anwendbar: Alle Regionen
Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Instance | Schnur | Name der Instanz für service-now.com oder benutzerdefinierte URL für migriertes Konto | Richtig |
| Nutzername | Schnur | Benutzername für diese Instanz | Richtig |
| Kennwort | securestring | Das Kennwort für dieses Konto | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 600 | 60 Sekunden |
Aktionen
| Abrufen von Anlageninhalten (Vorschau) |
Abrufen von Anlageninhalten |
| Abrufen von Anlagenmetadaten (Vorschau) |
Abrufen von Anlagenmetadaten |
| Abrufen von Datensatztypen |
Listet die verfügbaren Datensatztypen auf. |
| Abrufen von Katalogelementen |
Ruft eine Liste von Katalogelementen basierend auf den angegebenen Parametern ab, z. B. einen Suchtext oder einen Katalog. |
| Abrufen von Katalogen |
Ruft eine Liste von Katalogen ab. |
| Anlagenmetadaten abrufen (Vorschau) |
Abrufen von Metadaten für Anlagen |
| Artikel bestellen |
Bestellt oder kauft ein bestimmtes Katalogelement. |
| Datensatz abrufen |
Ruft einen Datensatz für einen ServiceNow-Objekttyp wie "Incidents" ab. |
| Datensatz aktualisieren |
Aktualisiert einen Datensatz für einen ServiceNow-Objekttyp wie "Incidents" |
| Datensatz erstellen |
Erstellen sie einen Datensatz in einer ServiceNow-Tabelle. |
| Datensatz löschen |
Löscht einen Datensatz für einen ServiceNow-Objekttyp wie "Incidents" |
| Datensätze auflisten |
Ruft Datensätze eines bestimmten ServiceNow-Objekttyps wie "Incidents" ab. |
| Hochladen einer Binärdatei als Anlage (Vorschau) |
Lädt eine Binärdatei als Anlage in einen angegebenen Datensatz hoch. |
| Hochladen einer mehrteiligen Dateianlage (Vorschau) |
Hochladen einer Anlage aus einem mehrteiligen Formular |
| Katalogelement abrufen |
Dient zum Abrufen eines bestimmten Katalogelements. |
| Katalogkategorien abrufen |
Ruft eine Liste der Kategorien für einen bestimmten Katalog ab. |
| Löschen einer Anlage (Vorschau) |
Löschen einer Anlage |
| Wissensartikel abrufen |
Gibt eine Liste der Kb-Artikel (Knowledge Base) zurück, die durchsucht und gefiltert werden können. |
Abrufen von Anlageninhalten (Vorschau)
Abrufen von Anlageninhalten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sys-ID
|
sys_id | True | string |
Sys_id der Anlage zum Abrufen von Inhalt für |
Abrufen von Anlagenmetadaten (Vorschau)
Abrufen von Anlagenmetadaten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID
|
sys_id | True | string |
Sys_id der Anlage zum Abrufen von Metadaten für |
Abrufen von Datensatztypen
Abrufen von Katalogelementen
Ruft eine Liste von Katalogelementen basierend auf den angegebenen Parametern ab, z. B. einen Suchtext oder einen Katalog.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kategorie
|
sysparm_category | string |
Die Kategorie-ID zum Filtern von Elementen nach. Wenn nicht angegeben, werden alle Elemente zurückgegeben. |
|
|
Limit
|
sysparm_limit | True | integer |
Anzahl der abzurufenden Katalogelemente |
|
Suchtext
|
sysparm_text | string |
Durchsuchen von Text zum Filtern von Elementen nach |
|
|
Catalog
|
sysparm_catalog | string |
Die Katalog-ID zum Filtern von Elementen nach. Wenn nicht angegeben, werden Elemente aus allen Katalogen zurückgegeben. |
Gibt zurück
Abrufen von Katalogen
Ruft eine Liste von Katalogen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | integer |
Anzahl der abzurufenden Kataloge |
|
|
Suchtext
|
sysparm_text | string |
Durchsuchen von Text zum Filtern von Katalogen nach Name oder Beschreibung |
Gibt zurück
- Body
- GetCatalogsResponse
Anlagenmetadaten abrufen (Vorschau)
Abrufen von Metadaten für Anlagen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | string |
Grenzwert, der auf die Paginierung angewendet werden soll. Hinweis: Ungewöhnlich große sysparm_limit Werte können sich auf die Systemleistung auswirken. Standardwert: 1000 |
|
|
Offset
|
sysparm_offset | string |
Anzahl der Datensätze, die von der Abfrage ausgeschlossen werden sollen. Verwenden Sie diesen Parameter, um mehr Datensätze abzurufen als in sysparm_limit angegeben. Wenn z. B. sysparm_limit auf 500 festgelegt ist, aber zusätzliche Datensätze vorhanden sind, die Sie abfragen möchten, können Sie einen sysparm_offset Wert von 500 angeben, um die zweite Gruppe von Datensätzen abzurufen. Standard: 0 |
|
|
Query
|
sysparm_query | string |
Codierte Abfrage. Abfragen für die Anlagen-API sind relativ zur Tabelle "Attachments [sys_attachment]". Beispiel: (sysparm_query=file_name=attachment.doc) |
Artikel bestellen
Bestellt oder kauft ein bestimmtes Katalogelement.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Artikel-ID
|
sys_id | True | string |
Die sys_id des zu bestellenden Katalogelements |
|
Bestellelementtext
|
body | True | dynamic |
Der Textkörper der Bestellelementanforderung. Sie enthält die Menge, den angeforderten Benutzer und alle zusätzlichen Variablen, die vom Katalogelement benötigt werden. |
Gibt zurück
- Body
- OrderItemResponse
Datensatz abrufen
Ruft einen Datensatz für einen ServiceNow-Objekttyp wie "Incidents" ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datensatztyp
|
tableType | True | string |
Typ des zu listenden Datensatzes |
|
System-ID
|
sysid | True | string |
System-ID für den Datensatz. |
|
Systemverweise anzeigen
|
sysparm_display_value | boolean |
Bestimmt, ob Systemverweise einbezogen werden sollen. |
|
|
Verweisverknüpfung ausschließen
|
sysparm_exclude_reference_link | boolean |
Bestimmt, ob Referenzlinks ausgeschlossen werden sollen |
|
|
Felder
|
sysparm_fields | string |
Kommagetrennte Liste der felder, die zurückgegeben werden sollen. Beispiel: Name,E-Mail,Telefon |
Gibt zurück
Datensatz aktualisieren
Aktualisiert einen Datensatz für einen ServiceNow-Objekttyp wie "Incidents"
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datensatztyp
|
tableType | True | string |
Typ des zu listenden Datensatzes |
|
System-ID
|
sysid | True | string |
System-ID für den Datensatz. |
|
body
|
body | True | dynamic | |
|
Systemverweise anzeigen
|
sysparm_display_value | boolean |
Bestimmt, ob Systemverweise einbezogen werden sollen. |
|
|
Verweisverknüpfung ausschließen
|
sysparm_exclude_reference_link | boolean |
Bestimmt, ob Referenzlinks ausgeschlossen werden sollen |
|
|
Felder
|
sysparm_fields | string |
Kommagetrennte Liste der felder, die zurückgegeben werden sollen. Beispiel: Name,E-Mail,Telefon |
Gibt zurück
Datensatz erstellen
Erstellen sie einen Datensatz in einer ServiceNow-Tabelle.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datensatztyp
|
tableType | True | string |
Typ des zu listenden Datensatzes |
|
body
|
body | True | dynamic | |
|
Systemverweise anzeigen
|
sysparm_display_value | boolean |
Bestimmt, ob Systemverweise einbezogen werden sollen. |
|
|
Verweisverknüpfung ausschließen
|
sysparm_exclude_reference_link | boolean |
Bestimmt, ob Referenzlinks ausgeschlossen werden sollen |
|
|
Felder
|
sysparm_fields | string |
Kommagetrennte Liste der felder, die zurückgegeben werden sollen. Beispiel: Name,E-Mail,Telefon |
Gibt zurück
Datensatz löschen
Löscht einen Datensatz für einen ServiceNow-Objekttyp wie "Incidents"
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datensatztyp
|
tableType | True | string |
Typ des zu listenden Datensatzes |
|
System-ID
|
sysid | True | string |
System-ID für den Datensatz. |
Datensätze auflisten
Ruft Datensätze eines bestimmten ServiceNow-Objekttyps wie "Incidents" ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datensatztyp
|
tableType | True | string |
Typ des zu listenden Datensatzes |
|
Systemverweise anzeigen
|
sysparm_display_value | boolean |
Bestimmt, ob Systemverweise einbezogen werden sollen. |
|
|
Verweisverknüpfung ausschließen
|
sysparm_exclude_reference_link | boolean |
Bestimmt, ob Referenzlinks ausgeschlossen werden sollen |
|
|
Query
|
sysparm_query | string |
Codierte Abfrage zum Filtern des Resultsets. Beispiel: active=true^ORDERBYnumber^ORDERBYDESCcategory |
|
|
Limit
|
sysparm_limit | integer |
Grenzwert, der auf die Paginierung angewendet werden soll. Der Standardwert ist 10000. |
|
|
Offset
|
sysparm_offset | integer |
Anzahl der Datensätze, die von der Abfrage ausgeschlossen werden sollen. |
|
|
Felder
|
sysparm_fields | string |
Kommagetrennte Liste der felder, die zurückgegeben werden sollen. Beispiel: Name,E-Mail,Telefon |
Gibt zurück
Hochladen einer Binärdatei als Anlage (Vorschau)
Lädt eine Binärdatei als Anlage in einen angegebenen Datensatz hoch.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Tabellenname
|
table_name | True | string |
Name der Tabelle, der Sie die Datei anfügen möchten |
|
Sys-ID
|
table_sys_id | True | string |
Sys_id des Datensatzes in der angegebenen Tabelle, der Sie die Datei anfügen möchten |
|
Dateiname
|
file_name | True | string |
Name, der der Anlage zugewiesen werden soll |
|
Datei
|
file | True | binary |
Binärdatei, die an den angegebenen Datensatz angefügt werden soll |
Gibt zurück
Hochladen einer mehrteiligen Dateianlage (Vorschau)
Hochladen einer Anlage aus einem mehrteiligen Formular
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anlageninhalt
|
attachment_content | True | file |
Anlage zum Hochladen |
|
Tabellenname
|
table_name | True | string |
Der Name der Tabelle, der Sie die Datei anfügen möchten. |
|
Tabellen-ID
|
table_sys_id | True | string |
Sys_id des Datensatzes in der angegebenen Tabelle, der Sie die Datei anfügen möchten |
Gibt zurück
Katalogelement abrufen
Dient zum Abrufen eines bestimmten Katalogelements.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Artikel-ID
|
sys_id | True | string |
Die sys_id des abzurufenden Katalogelements |
Gibt zurück
Katalogkategorien abrufen
Ruft eine Liste der Kategorien für einen bestimmten Katalog ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Katalog-ID
|
catalogId | True | string |
Die ID des Katalogs, für den Kategorien abgerufen werden sollen |
|
Limit
|
sysparm_limit | integer |
Anzahl der abzurufenden Katalogkategorien |
|
|
Offset
|
sysparm_offset | integer |
Offset für die Abfrage |
Gibt zurück
Löschen einer Anlage (Vorschau)
Löschen einer Anlage
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sys-ID
|
sys_id | True | string |
Sys_id der zu löschenden Anlage |
Wissensartikel abrufen
Gibt eine Liste der Kb-Artikel (Knowledge Base) zurück, die durchsucht und gefiltert werden können.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Felder
|
fields | string |
Durch Trennzeichen getrennte Liste von Feldern aus der Wissenstabelle. |
|
|
Limit
|
limit | integer |
Maximale Anzahl der zurückzugebenden Datensätze. |
|
|
Query
|
query | True | string |
Text, nach dem gesucht werden soll. |
|
Filter
|
filter | string |
Codierte Abfrage zum Filtern des Resultsets. |
|
|
Kb
|
kb | string |
Kommagetrennte Liste der Wissensbasis-sys_ids. |
Gibt zurück
- Body
- GetArticlesResponse
Definitionen
UploadAttachmentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
average_image_color
|
result.average_image_color | string |
Wenn es sich bei der Anlage um ein Bild handelt, wird die Summe aller Farben addiert. |
|
komprimiert
|
result.compressed | string |
Flag, das angibt, ob die Anlagendatei komprimiert wurde. |
|
content_type
|
result.content_type | string |
Inhaltstyp der zugeordneten Anlagendatei, z. B. Bild oder JPEG oder Application/x-shockwave-flash. |
|
created_by_name
|
result.created_by_name | string |
Vollständiger Name der Entität, die ursprünglich die Anlagedatei erstellt hat. |
|
download_link
|
result.download_link | string |
Download-URL der Anlage in der ServiceNow-Instanz. |
|
file_name
|
result.file_name | string |
Dateiname der Anlage. |
|
image_height
|
result.image_height | string |
Wenn eine Bilddatei, die Höhe des Bilds. Einheit: Pixel |
|
image_width
|
result.image_width | string |
Wenn eine Bilddatei, die Breite des Bilds. Einheit: Pixel |
|
size_bytes
|
result.size_bytes | string |
Größe der Anlage. Einheit: Bytes |
|
size_compressed
|
result.size_compressed | string |
Größe der Anlage. Einheit: Bytes |
|
sys_created_by
|
result.sys_created_by | string |
Entität, die ursprünglich die Anlagendatei erstellt hat. |
|
sys_created_on
|
result.sys_created_on | string |
Datum und Uhrzeit, zu der die Anlagendatei ursprünglich in der Instanz gespeichert wurde. |
|
sys_id
|
result.sys_id | string |
Sys_id der Anlagendatei. |
|
sys_mod_count
|
result.sys_mod_count | string |
Anzahl der Änderungen der Anlagendatei (hochgeladen in die Instanz). |
|
sys_tags
|
result.sys_tags | string |
Alle Systemtags, die der Anlagendatei zugeordnet sind. |
|
sys_updated_by
|
result.sys_updated_by | string |
Alle Systemtags, die der Anlagendatei zugeordnet sind. |
|
sys_updated_on
|
result.sys_updated_on | string |
Datum und Uhrzeit der letzten Aktualisierung der Anlagendatei. |
|
table_name
|
result.table_name | string |
Der Name der Tabelle, der die Anlage zugeordnet ist. |
|
table_sys_id
|
result.table_sys_id | string |
Sys_id der Tabelle, die der Anlage zugeordnet ist. |
|
updated_by_name
|
result.updated_by_name | string |
Vollständiger Name der Entität, die die Anlagedatei zuletzt aktualisiert hat. |
GetTypesResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object |
Resultset aller Datensatztypen für die aktuelle Instanz. |
|
Anzeigename
|
result.label | string |
Anzeigename des Datensatztyps. |
|
Wert
|
result.value | string |
Wert des Datensatztyps. |
GetCatalogsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object | |
|
title
|
result.title | string | |
|
sys_id
|
result.sys_id | string | |
|
has_categories
|
result.has_categories | boolean | |
|
has_items
|
result.has_items | boolean | |
|
Beschreibung
|
result.description | string | |
|
desktop_image
|
result.desktop_image | string |
GetCatalogCategoriesResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object | |
|
title
|
result.title | string | |
|
Beschreibung
|
result.description | string | |
|
full_description
|
result.full_description | string | |
|
Ikone
|
result.icon | string | |
|
header_icon
|
result.header_icon | string | |
|
homepage_image
|
result.homepage_image | string | |
|
count
|
result.count | integer | |
|
Unterkategorie
|
result.subcategories | array of object | |
|
sys_id
|
result.subcategories.sys_id | string | |
|
title
|
result.subcategories.title | string | |
|
sys_id
|
result.sys_id | string |
GetCatalogItemsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object | |
|
short_description
|
result.short_description | string | |
|
kb_article
|
result.kb_article | string | |
|
Ikone
|
result.icon | string | |
|
Beschreibung
|
result.description | string | |
|
availability
|
result.availability | string | |
|
mandatory_attachment
|
result.mandatory_attachment | boolean | |
|
request_method
|
result.request_method | string | |
|
type
|
result.type | string | |
|
visible_standalone
|
result.visible_standalone | boolean | |
|
local_currency
|
result.local_currency | string | |
|
sys_class_name
|
result.sys_class_name | string | |
|
sys_id
|
result.sys_id | string | |
|
content_type
|
result.content_type | string | |
|
Preis
|
result.price | string | |
|
recurring_frequency
|
result.recurring_frequency | string | |
|
price_currency
|
result.price_currency | string | |
|
order
|
result.order | integer | |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean | |
|
owner
|
result.owner | string | |
|
show_price
|
result.show_price | boolean | |
|
recurring_price
|
result.recurring_price | string | |
|
show_quantity
|
result.show_quantity | boolean | |
|
picture
|
result.picture | string | |
|
URL
|
result.url | string | |
|
recurring_price_currency
|
result.recurring_price_currency | string | |
|
localized_price
|
result.localized_price | string | |
|
kataloge
|
result.catalogs | array of object | |
|
sys_id
|
result.catalogs.sys_id | string | |
|
active
|
result.catalogs.active | boolean | |
|
title
|
result.catalogs.title | string | |
|
name
|
result.name | string | |
|
localized_recurring_price
|
result.localized_recurring_price | string | |
|
show_wishlist
|
result.show_wishlist | boolean | |
|
sys_id
|
result.category.sys_id | string | |
|
title
|
result.category.title | string | |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean | |
|
show_delivery_time
|
result.show_delivery_time | boolean |
GetCatalogItemResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
short_description
|
result.short_description | string |
short_description |
|
kb_article
|
result.kb_article | string |
kb_article |
|
Ikone
|
result.icon | string |
Ikone |
|
Beschreibung
|
result.description | string |
Beschreibung |
|
availability
|
result.availability | string |
availability |
|
mandatory_attachment
|
result.mandatory_attachment | boolean |
mandatory_attachment |
|
request_method
|
result.request_method | string |
request_method |
|
type
|
result.type | string |
type |
|
visible_standalone
|
result.visible_standalone | boolean |
visible_standalone |
|
sys_class_name
|
result.sys_class_name | string |
sys_class_name |
|
sys_id
|
result.sys_id | string |
sys_id |
|
content_type
|
result.content_type | string |
content_type |
|
order
|
result.order | integer |
order |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean |
make_item_non_conversational |
|
owner
|
result.owner | string |
owner |
|
show_price
|
result.show_price | boolean |
show_price |
|
show_quantity
|
result.show_quantity | boolean |
show_quantity |
|
picture
|
result.picture | string |
picture |
|
URL
|
result.url | string |
URL |
|
kataloge
|
result.catalogs | array of object |
kataloge |
|
sys_id
|
result.catalogs.sys_id | string |
sys_id |
|
active
|
result.catalogs.active | boolean |
active |
|
title
|
result.catalogs.title | string |
title |
|
name
|
result.name | string |
name |
|
show_wishlist
|
result.show_wishlist | boolean |
show_wishlist |
|
sys_id
|
result.category.sys_id | string |
sys_id |
|
title
|
result.category.title | string |
title |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean |
turn_off_nowassist_conversation |
|
show_delivery_time
|
result.show_delivery_time | boolean |
show_delivery_time |
|
categories
|
result.categories | array of object |
categories |
|
sys_id
|
result.categories.sys_id | string |
sys_id |
|
active
|
result.categories.active | boolean |
active |
|
sys_id
|
result.categories.category.sys_id | string |
sys_id |
|
active
|
result.categories.category.active | boolean |
active |
|
title
|
result.categories.category.title | string |
title |
|
title
|
result.categories.title | string |
title |
|
variables
|
result.variables | array of object |
variables |
|
ui_policy
|
result.ui_policy | array of |
ui_policy |
|
onChange
|
result.client_script.onChange | array of |
onChange |
|
onSubmit
|
result.client_script.onSubmit | array of |
onSubmit |
|
onLoad
|
result.client_script.onLoad | array of |
onLoad |
|
data_lookup
|
result.data_lookup | array of |
data_lookup |
|
variablesSchema
|
result.variablesSchema | object |
OrderItemResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
sys_id
|
result.sys_id | string |
sys_id |
|
number
|
result.number | string |
number |
|
request_number
|
result.request_number | string |
request_number |
|
Anfrage_ID
|
result.request_id | string |
Anfrage_ID |
|
Tisch
|
result.table | string |
Tisch |
GetArticlesResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
meta.count | integer |
Anzahl der verfügbaren KB-Artikel |
|
ENDE
|
meta.end | integer |
Endindex des Resultsets |
|
Felder
|
meta.fields | string |
Felder im Artikel |
|
Filter
|
meta.filter | string |
Zum Abrufen der Daten verwendete Filter |
|
Kb
|
meta.kb | string |
Liste der Knowledge Base-Artikel sys_ids |
|
Language
|
meta.language | string |
Liste der durch Trennzeichen getrennten Sprachen der KB-Artikel, die angefordert wurden |
|
Query
|
meta.query | string |
Angegebene Anforderungsabfrage |
|
Start
|
meta.start | string |
Startindex des Resultsets |
|
Der Status
|
meta.status.code | string |
Status des Anrufs |
|
Kb
|
meta.ts_query_id | string |
Liste der durch Trennzeichen getrennten Sprachen der KB-Artikel, die angefordert wurden |
|
Artikel
|
articles | array of object | |
|
Anzeigewert
|
articles.fields.display_value | string |
Anzeigewert des angeforderten Felds |
|
Etikett
|
articles.fields.label | string |
Bezeichnung, die das angeforderte Feld darstellt |
|
Name
|
articles.fields.name | string |
Name des angeforderten Felds |
|
Typ
|
articles.fields.type | string |
Datentyp des angeforderten Felds |
|
Wert
|
articles.fields.value | string |
Wert des angeforderten Felds |
|
Link
|
articles.Link | string |
Link zum Artikel |
|
id
|
articles.id | string |
Wissensartikel sys_id aus der Tabelle Knowledge [kb_knowledge] |
|
Number
|
articles.number | string |
Wissensartikel sys_id aus der Tabelle Knowledge [kb_knowledge] |
|
Rang
|
articles.rank | float |
Suchrang des artikelsspezifisch für diese Suche |
|
Score
|
articles.score | float |
Relevanzbewertung, Ergebnisse sortiert in absteigender Reihenfolge nach Bewertung |
|
Schnipsel
|
articles.snippet | string |
Text mit einem kleinen Teil des Wissensartikels |
|
Title
|
articles.title | string |
Kurze Beschreibung oder Titel des Wissensartikels |