ServiceNow
ServiceNow verbetert serviceniveaus, activeert werknemers en stelt uw onderneming in staat om met lichte snelheid te werken. Records maken, lezen en bijwerken die zijn opgeslagen in ServiceNow, inclusief incidenten, vragen, gebruikers en meer.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - China Cloud beheerd door 21Vianet |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - China Cloud beheerd door 21Vianet |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - China Cloud beheerd door 21Vianet |
| Contactpersoon | |
|---|---|
| Naam | Microsoft |
| URL | https://learn.microsoft.com/connectors/service-now/ |
| Connectormetagegevens | |
|---|---|
| Uitgever | Microsoft |
| Webpagina | https://www.servicenow.com/ |
| Privacybeleid | https://www.servicenow.com/privacy-statement.html |
| Categorieën | Webpagina |
Opmerking
De bewerking Kennisartikelen ophalen kan alleen worden gebruikt wanneer de invoegtoepassing Knowledge API (sn_km_api) is geactiveerd.
Bekende problemen en beperkingen
Wanneer u de actie Record maken gebruikt, is het niet mogelijk om de volledige recordbeschrijving op te geven. De veldwaarde wordt genegeerd vanwege Service-Now REST API-beperkingen.
De actie Records ophalen retourneert mogelijk een ongeldige tabel of een andere fout in Power Apps. Voor Power Apps-implementaties is het voorgestelde werk om de actie Records ophalen in Power Automate te gebruiken en de gegevens terug te geven aan Power Apps.
De connector ondersteunt momenteel alleen exemplaar-URL's die eindigen op 'service-now.com'. Het gebruik van alternatieve domeinen, zoals 'servicenowservices.com', kan leiden tot verbindingsfouten. In dergelijke gevallen, met name wanneer u met een nieuw ServiceNow-domein in GCC werkt, wordt u aangeraden basisverificatie te gebruiken.
Als er een pop-upfout optreedt met de melding 'Ongeldige redirect_uri', kopieert u de volledige URL uit het pop-upvenster en extraheert u de parameter redirect_uri (bijvoorbeeld redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect). Nadat u de URL hebt gedecodering (waarbij u %3a vervangt door: en %2f door /), werkt u het veld Omleidings-URL bij in het OAuth-app-register van uw ServiceNow-exemplaar, zoals wordt weergegeven in de onderstaande afbeelding. Voeg vervolgens de verbinding opnieuw toe.
Een ServiceNow Power Platform-verbinding instellen die gebruikmaakt van Microsoft Entra-id
Er zijn twee verbindingstypen:
Microsoft Entra ID OAuth met behulp van certificaat: dit is een verificatietype op basis van een app-token waarbij een toepassing die is geregistreerd in Entra-id, kan worden gebruikt voor toegang tot ServiceNow door een token op te halen met de resource die is ingesteld als de ServiceNow-representatieve Entra ID-app.
Microsoft Entra ID OAuth met behulp van gebruikersaanmelding: dit is een verificatietype op basis van gebruikerstoken, waarbij de eindgebruiker zich kan aanmelden bij de Entra ID 1P-toepassing (ServiceNow Connector 1p-app) en een toegangstoken kan ophalen met het bereik dat is ingesteld voor de ServiceNow-vertegenwoordiger entra-id-app.
Stappen voor het maken van een Microsoft Entra ID OAuth-verbinding met behulp van certificaat
Stap 1: Registreer een 'Toepassing A' in Microsoft Entra-id voor OIDC-integratie met ServiceNow. Dit is de ServiceNow-representatieve Entra ID-toepassing .
Ga naar App-registraties Nieuwe registratie om een nieuwe toepassingsregistratie > te maken
Naam: elke gewenste naam
Omleidings-URI: niet vereist
Toevoegen
aud,email&upnaan de claims onder "Optionele claims"
Stap 2: Dezelfde id registreren als een OIDC-provider in ServiceNow
Ga naar
System OAuth > Application Registry > New > Configure an OIDC providerid-tokens controleren- Naam: elke gewenste naam
-
Client-id: de
client IDtoepassing A die is gemaakt in stap 1 - Clientgeheim: dit wordt niet daadwerkelijk gebruikt, elke waarde kan worden ingesteld
Voeg in het registratieformulier van de OIDC-provider een nieuwe OIDC-providerconfiguratie toe. Selecteer het zoekpictogram in het veld Configuratie van OAuth OIDC-provider om de records van OIDC-configuraties te openen en selecteer 'Nieuw'.
- OIDC-provider: Microsoft Entra-id
-
URL voor OIDC-metagegevens: de URL moet in de vorm
https://login.microsoftonline.com/<tenantID>/.well-known/openid-configurationstaan, vervangen doortenantIDDirectory (tenant) ID - Levensduur van OIDC-configuratiecache: 120
- Toepassing: Globaal
- Gebruikersclaim: oid
- Gebruikersveld: Gebruikers-id
- Verificatie van JTI-claim inschakelen: Uitgeschakeld
Selecteer Verzenden en werk het formulier OAuth OIDC-entiteit bij
Stap 3: Registreer een toepassing B in Microsoft Entra ID voor connectorgebruik. Dit is de toepassing die de rol van een gebruiker speelt met verhoogde machtigingen in het ServiceNow-exemplaar
Ga naar het
App registrations > New registrationmaken van een nieuwe app- Naam: elke gewenste naam
- Upload in Certificaten en geheimen het .cer-bestand van het certificaat in het geval van een SNI-certificaat, voeg
trustedCertificateSubjectsgewoon het manifest van de toepassing toe met de relevanteauthorityIdensubjectName
Stap 4: Maak een systeemgebruiker in ServiceNow. Dit is de toepassing B als gebruiker in het ServiceNow-exemplaar
Ga naar
User Administration > Usershet maken van een nieuwe gebruiker- Gebruikers-id: de object-id van de service-principal van 'Toepassing B' die is gemaakt in stap 3
- Controleer
Web service access only
Stap 5: Verbinding maken met behulp van de connector - Copilot Studio - Connectorconfiguratie
Configureer de connector met de volgende informatie en maak verbinding:
- Exemplaarnaam: de naam van het exemplaar van ServiceNow
- Tenant-id: de tenant-id van de Microsoft Entra-tenant
- Client-id: de client-id van 'Toepassing B' die is gemaakt in stap 3
- Resource-URI: de client-id van 'Toepassing A' die is gemaakt in stap 1 (niet de toepassings-URI)
- Clientcertificaatgeheim: het PFX-bestand van het certificaat dat is gemaakt in stap 3
- Certificaatwachtwoord: het wachtwoord van het PFX-bestand
Stappen voor het maken van OAuth-gebruikersaanmelding voor Microsoft Entra ID
Als u een OAuth-gebruikersaanmeldingsverbinding met Microsoft Entra ID wilt configureren, moet u stap 1 en stap 2 voltooien, zoals beschreven in de sectie certificaatverificatie hierboven.
Stap 1 blijft hetzelfde. Werk in stap 2 de claim van de gebruiker bij naar Upn of aangepaste claimeigenschap van het token (voor andere id-providers dan Entra) in ServiceNow. Het gebruikersveld moet overeenkomen met het gebruikerstabelveld van het ServiceNow-systeem dat de upn of gebruikers-id bevat.
Stap 3 en 4 uit de bovenstaande sectie over certificaatverificatie zijn niet vereist. In plaats daarvan is 'Application B' in dit geval een 1p-app die wordt gemaakt voor de ServiceNow-connector. De onderstaande app moet machtigingen krijgen in de toepassing A.
Id van toepassing B: c26b24aa-7874-4e06-ad55-7d06b1f79b63
Belangrijk
In dit scenario moet 'Toepassing B' de id c26b24aa-7874-4e06-ad55-7d06b1f79b63 gebruiken die een bestaande 1p-app is die eigendom is van Microsoft, niet een door de gebruiker gemaakte app (zoals vereist voor het maken van een Microsoft Entra ID OAuth-verbinding met behulp van certificaat).
Tijdens het maken van de verbinding voor de ServiceNow-connector moet de gebruiker 'Microsoft Entra ID User Login' selecteren als verificatietype en hoeft alleen de serviceNow Instance-naam en de resource-id op te geven (dit is de id voor 'Toepassing A'). Hierna neemt de aanmeldingsknop de gebruiker via de Entra ID-aanmelding via zijn eigen account.
Een id-provider van derden gebruiken of gegevens komen niet overeen tussen de gebruiker in Entra ID en de tabel ServiceNow-gebruikers
- Als er een onjuiste overeenkomst is tussen de eigenschap gebruikers-id in het Entra ID-token en de waarde van de gebruikers-id die zich in de tabel ServiceNow bevindt
- Het token bevat bijvoorbeeld de volledige upn (samen met domein –
abc@contoso.com) en de tabel ServiceNow-gebruikers bevat alleen de gebruikers-id (abc). Het is raadzaam om een aangepast kenmerk toe te voegen aan het token dat een waarde bevat die overeenkomt met de gebruikers-id in de ServiceNow-id door een formule toe te passen en vervolgens die nieuwe eigenschap te gebruiken om de claimtoewijzing uit te voeren in stap 2. - Microsoft Learn-documentatie waarin het proces voor het toevoegen van een nieuwe claimeigenschap wordt beschreven: https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token
- Het token bevat bijvoorbeeld de volledige upn (samen met domein –
"Een ServiceNow Power Platform-verbinding instellen die gebruikmaakt van Microsoft Entra ID"-verwijzingen:
- Externe id tokenverificatie (OIDC) for Rest API's - Ondersteuning en probleemoplossing
- ServiceNow Catalog Microsoft Graph-connector | Microsoft Learn
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| Basisverificatie | Aanmelden met basisverificatie | Alle regio's | Niet deelbaar |
| Microsoft Entra ID OAuth met behulp van certificaat | OAuth met Microsoft Entra-id met pfx-certificaat. | Alleen POWERPLATFORM | Deelbaar |
| Gebruikersaanmelding voor Microsoft Entra ID | Aanmelden met Microsoft Entra ID-referenties | Alle regio's | Niet deelbaar |
| Oauth2 gebruiken | Aanmelden met Oauth2 | Alle regio's | Niet deelbaar |
| Standaard [AFGESCHAFT] | Deze optie is alleen bedoeld voor oudere verbindingen zonder expliciet verificatietype en is alleen beschikbaar voor compatibiliteit met eerdere versies. | Alle regio's | Niet deelbaar |
Basisverificatie
Verificatie-id: basicAuthentication
Van toepassing: Alle regio's
Aanmelden met basisverificatie
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Instantie | touw | Naam van het exemplaar voor service-now.com of aangepaste URL voor gemigreerd account | Klopt |
| Gebruikersnaam | touw | Gebruikersnaam voor dit exemplaar | Klopt |
| Wachtwoord | beveiligde string | Het wachtwoord voor dit account | Klopt |
OAuth Microsoft Entra-id met behulp van certificaat
Verificatie-id: aadOAuthCert
Van toepassing: alleen POWERPLATFORM
OAuth met Microsoft Entra-id met pfx-certificaat.
Dit is deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt de verbinding ook gedeeld. Zie het overzicht van connectors voor canvas-apps - Power Apps | Microsoft Docs
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Instantienaam | touw | De instantienaam die wordt gebruikt om de ServiceNow-site-URl te identificeren | Klopt |
| Huurder-ID | touw | Klopt | |
| Klant-ID | touw | Klopt | |
| Resource-URI | touw | Klopt | |
| Clientcertificaatgeheim | clientcertificaat | Het clientcertificaatgeheim dat door deze toepassing is toegestaan | Klopt |
Gebruikersaanmelding voor Microsoft Entra ID
Verificatie-id: entraIDUserLogin
Van toepassing: Alle regio's
Aanmelden met Microsoft Entra ID-referenties
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Resource-URI | touw | Klopt | |
| Instantienaam | touw | De instantienaam die wordt gebruikt om de URL van de ServiceNow-site te identificeren | Klopt |
Oauth2 gebruiken
Verificatie-id: oauth2ServiceNow
Van toepassing: Alle regio's
Aanmelden met Oauth2
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Instantienaam | touw | De instantienaam die wordt gebruikt om de ServiceNow-site-URl te identificeren | Klopt |
| Client-id | touw | De id die wordt gebruikt om deze toepassing te identificeren bij de serviceprovider | Klopt |
| Clientgeheim | beveiligde string | Het gedeelde geheim dat wordt gebruikt om deze toepassing te verifiëren bij de serviceprovider | Klopt |
Standaard [AFGESCHAFT]
Van toepassing: Alle regio's
Deze optie is alleen bedoeld voor oudere verbindingen zonder expliciet verificatietype en is alleen beschikbaar voor compatibiliteit met eerdere versies.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Instantie | touw | Naam van het exemplaar voor service-now.com of aangepaste URL voor gemigreerd account | Klopt |
| Gebruikersnaam | touw | Gebruikersnaam voor dit exemplaar | Klopt |
| Wachtwoord | beveiligde string | Het wachtwoord voor dit account | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 600 | 60 seconden |
Acties
| Bijlage-inhoud ophalen (preview) |
Bijlage-inhoud ophalen |
| Catalogi ophalen |
Hiermee haalt u een lijst met catalogi op |
| Cataloguscategorieën ophalen |
Lijst met categorieën voor een specifieke catalogus ophalen |
| Catalogusitem ophalen |
Een specifiek catalogusitem ophalen. |
| Catalogusitems ophalen |
Hiermee wordt een lijst met catalogusitems opgehaald op basis van de opgegeven parameters, zoals een zoektekst of een catalogus. |
| Een bijlage met meerdere onderdelen uploaden (preview) |
Een bijlage uploaden vanuit een formulier met meerdere onderdelen |
| Een bijlage verwijderen (preview) |
Een bijlage verwijderen |
| Een binair bestand uploaden als bijlage (preview) |
Uploadt een binair bestand als bijlage naar een opgegeven record |
| Kennisartikelen ophalen |
Retourneert een lijst met knowledge base-artikelen (KB) die kunnen worden doorzocht en gefilterd |
| Metagegevens van bijlagen ophalen (preview) |
Metagegevens voor bijlagen ophalen |
| Metagegevens van bijlagen ophalen (preview) |
Metagegevens van bijlagen ophalen |
| Orderitem |
Orders of koopt een specifiek catalogusitem. |
| Record bijwerken |
Hiermee werkt u een record bij voor een ServiceNow-objecttype, zoals 'Incidenten' |
| Record maken |
Maak een record in een ServiceNow-tabel. |
| Record ophalen |
Hiermee haalt u een record op voor een ServiceNow-objecttype zoals 'Incidenten' |
| Record verwijderen |
Hiermee verwijdert u een record voor een ServiceNow-objecttype, zoals Incidenten |
| Records vermelden |
Records ophalen van een bepaald ServiceNow-objecttype, zoals 'Incidenten' |
| Recordtypen ophalen |
Een lijst met de beschikbare recordtypen |
Bijlage-inhoud ophalen (preview)
Bijlage-inhoud ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sys-id
|
sys_id | True | string |
Sys_id van de bijlage voor het ophalen van inhoud voor |
Catalogi ophalen
Hiermee haalt u een lijst met catalogi op
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | integer |
Aantal catalogi dat moet worden opgehaald |
|
|
Zoektekst
|
sysparm_text | string |
Zoeken in tekst om catalogi te filteren op naam of beschrijving |
Retouren
- Body
- GetCatalogsResponse
Cataloguscategorieën ophalen
Lijst met categorieën voor een specifieke catalogus ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Catalogus-id
|
catalogId | True | string |
De id van de catalogus waarvoor categorieën moeten worden opgehaald |
|
Limit
|
sysparm_limit | integer |
Aantal cataloguscategorieën dat moet worden opgehaald |
|
|
Offset
|
sysparm_offset | integer |
Verschuiving voor de query |
Retouren
Catalogusitem ophalen
Een specifiek catalogusitem ophalen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Item-id
|
sys_id | True | string |
Het sys_id van het catalogusitem dat moet worden opgehaald |
Retouren
Catalogusitems ophalen
Hiermee wordt een lijst met catalogusitems opgehaald op basis van de opgegeven parameters, zoals een zoektekst of een catalogus.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Categorie
|
sysparm_category | string |
De categorie-id voor het filteren van items op. Als dit niet is opgegeven, worden alle items geretourneerd. |
|
|
Limit
|
sysparm_limit | True | integer |
Aantal catalogusitems dat moet worden opgehaald |
|
Zoektekst
|
sysparm_text | string |
Tekst zoeken om items te filteren op |
|
|
Catalog
|
sysparm_catalog | string |
De catalogus-id voor het filteren van items op. Als dit niet is opgegeven, worden items uit alle catalogi geretourneerd |
Retouren
Een bijlage met meerdere onderdelen uploaden (preview)
Een bijlage uploaden vanuit een formulier met meerdere onderdelen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bijlage-inhoud
|
attachment_content | True | file |
Bijlage die moet worden geüpload |
|
Tabelnaam
|
table_name | True | string |
De naam van de tabel waaraan u het bestand wilt toevoegen. |
|
Tabel-id
|
table_sys_id | True | string |
Sys_id van de record in de opgegeven tabel waaraan u het bestand wilt toevoegen |
Retouren
Een bijlage verwijderen (preview)
Een bijlage verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sys-id
|
sys_id | True | string |
Sys_id van de bijlage die u wilt verwijderen |
Een binair bestand uploaden als bijlage (preview)
Uploadt een binair bestand als bijlage naar een opgegeven record
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Tabelnaam
|
table_name | True | string |
Naam van de tabel waaraan u het bestand wilt toevoegen |
|
Sys-id
|
table_sys_id | True | string |
Sys_id van de record in de opgegeven tabel waaraan u het bestand wilt toevoegen |
|
Bestandsnaam
|
file_name | True | string |
Naam om de bijlage te geven |
|
Bestand
|
file | True | binary |
Binair bestand dat moet worden gekoppeld aan de opgegeven record |
Retouren
Kennisartikelen ophalen
Retourneert een lijst met knowledge base-artikelen (KB) die kunnen worden doorzocht en gefilterd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Fields
|
fields | string |
Door komma's gescheiden lijst met velden uit de knowledge-tabel. |
|
|
Limit
|
limit | integer |
Maximum aantal records dat moet worden geretourneerd. |
|
|
Query
|
query | True | string |
Te zoeken tekst. |
|
Filter
|
filter | string |
Gecodeerde query die moet worden gebruikt om de resultatenset te filteren. |
|
|
Kb
|
kb | string |
Door komma's gescheiden lijst met knowledge base-sys_ids. |
Retouren
- Body
- GetArticlesResponse
Metagegevens van bijlagen ophalen (preview)
Metagegevens voor bijlagen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | string |
Limiet die moet worden toegepast op paginering. Opmerking: Ongebruikelijk grote sysparm_limit waarden kunnen van invloed zijn op de systeemprestaties. Standaard: 1000 |
|
|
Offset
|
sysparm_offset | string |
Aantal records dat moet worden uitgesloten van de query. Gebruik deze parameter om meer records op te halen dan is opgegeven in sysparm_limit. Als sysparm_limit bijvoorbeeld is ingesteld op 500, maar er extra records zijn die u wilt opvragen, kunt u een sysparm_offset waarde van 500 opgeven om de tweede set records op te halen. Standaardwaarde: 0 |
|
|
Query
|
sysparm_query | string |
Gecodeerde query. Query's voor de bijlage-API zijn relatief ten opzichte van de tabel Bijlagen [sys_attachment]. Bijvoorbeeld: (sysparm_query=file_name=attachment.doc) |
Metagegevens van bijlagen ophalen (preview)
Metagegevens van bijlagen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ID-kaart
|
sys_id | True | string |
Sys_id van de bijlage voor het ophalen van metagegevens voor |
Orderitem
Orders of koopt een specifiek catalogusitem.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Item-id
|
sys_id | True | string |
De sys_id van het catalogusitem dat moet worden besteld |
|
Hoofdtekst orderitem
|
body | True | dynamic |
De hoofdtekst van de aanvraag voor het orderitem. Het bevat de hoeveelheid, de gebruiker die is aangevraagd en eventuele aanvullende variabelen die vereist zijn voor het catalogusitem |
Retouren
- Body
- OrderItemResponse
Record bijwerken
Hiermee werkt u een record bij voor een ServiceNow-objecttype, zoals 'Incidenten'
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Recordtype
|
tableType | True | string |
Type record dat moet worden weergegeven |
|
Systeem-id
|
sysid | True | string |
Systeem-id voor de record. |
|
body
|
body | True | dynamic | |
|
Systeemverwijzingen weergeven
|
sysparm_display_value | boolean |
Bepaalt of systeemverwijzingen moeten worden opgenomen |
|
|
Verwijzingskoppelingen uitsluiten
|
sysparm_exclude_reference_link | boolean |
Bepaalt of verwijzingskoppelingen moeten worden uitgesloten |
|
|
Fields
|
sysparm_fields | string |
Door komma's gescheiden lijst met velden die moeten worden geretourneerd. Voorbeeld: naam, e-mail, telefoon |
Retouren
Record maken
Maak een record in een ServiceNow-tabel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Recordtype
|
tableType | True | string |
Type record dat moet worden weergegeven |
|
body
|
body | True | dynamic | |
|
Systeemverwijzingen weergeven
|
sysparm_display_value | boolean |
Bepaalt of systeemverwijzingen moeten worden opgenomen |
|
|
Verwijzingskoppelingen uitsluiten
|
sysparm_exclude_reference_link | boolean |
Bepaalt of verwijzingskoppelingen moeten worden uitgesloten |
|
|
Fields
|
sysparm_fields | string |
Door komma's gescheiden lijst met velden die moeten worden geretourneerd. Voorbeeld: naam, e-mail, telefoon |
Retouren
Record ophalen
Hiermee haalt u een record op voor een ServiceNow-objecttype zoals 'Incidenten'
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Recordtype
|
tableType | True | string |
Type record dat moet worden weergegeven |
|
Systeem-id
|
sysid | True | string |
Systeem-id voor de record. |
|
Systeemverwijzingen weergeven
|
sysparm_display_value | boolean |
Bepaalt of systeemverwijzingen moeten worden opgenomen |
|
|
Verwijzingskoppelingen uitsluiten
|
sysparm_exclude_reference_link | boolean |
Bepaalt of verwijzingskoppelingen moeten worden uitgesloten |
|
|
Fields
|
sysparm_fields | string |
Door komma's gescheiden lijst met velden die moeten worden geretourneerd. Voorbeeld: naam, e-mail, telefoon |
Retouren
Record verwijderen
Hiermee verwijdert u een record voor een ServiceNow-objecttype, zoals Incidenten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Recordtype
|
tableType | True | string |
Type record dat moet worden weergegeven |
|
Systeem-id
|
sysid | True | string |
Systeem-id voor de record. |
Records vermelden
Records ophalen van een bepaald ServiceNow-objecttype, zoals 'Incidenten'
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Recordtype
|
tableType | True | string |
Type record dat moet worden weergegeven |
|
Systeemverwijzingen weergeven
|
sysparm_display_value | boolean |
Bepaalt of systeemverwijzingen moeten worden opgenomen |
|
|
Verwijzingskoppelingen uitsluiten
|
sysparm_exclude_reference_link | boolean |
Bepaalt of verwijzingskoppelingen moeten worden uitgesloten |
|
|
Query
|
sysparm_query | string |
Gecodeerde query die wordt gebruikt om de resultatenset te filteren. Voorbeeld: active=true^ORDERBYnumber^ORDERBYDESCcategory |
|
|
Limit
|
sysparm_limit | integer |
Limiet die moet worden toegepast op paginering. De standaardwaarde is 10000. |
|
|
Offset
|
sysparm_offset | integer |
Aantal records dat moet worden uitgesloten van de query. |
|
|
Fields
|
sysparm_fields | string |
Door komma's gescheiden lijst met velden die moeten worden geretourneerd. Voorbeeld: naam, e-mail, telefoon |
Retouren
Recordtypen ophalen
Definities
UploadAttachmentResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
average_image_color
|
result.average_image_color | string |
Als de bijlage een afbeelding is, wordt de som van alle kleuren weergegeven. |
|
samengedrukt
|
result.compressed | string |
Vlag die aangeeft of het bijlagebestand is gecomprimeerd. |
|
content_type
|
result.content_type | string |
Inhoudstype van het bijbehorende bijlagebestand, zoals afbeelding of jpeg of toepassing/x-shockwave-flash. |
|
created_by_name
|
result.created_by_name | string |
Volledige naam van de entiteit die oorspronkelijk het bijlagebestand heeft gemaakt. |
|
download_link
|
result.download_link | string |
Download de URL van de bijlage op het ServiceNow-exemplaar. |
|
bestandsnaam
|
result.file_name | string |
Bestandsnaam van de bijlage. |
|
image_height
|
result.image_height | string |
Als een afbeeldingsbestand, de hoogte van de afbeelding. Eenheid: pixels |
|
image_width
|
result.image_width | string |
Als een afbeeldingsbestand, de breedte van de afbeelding. Eenheid: pixels |
|
size_bytes
|
result.size_bytes | string |
Grootte van de bijlage. Eenheid: bytes |
|
size_compressed
|
result.size_compressed | string |
Grootte van de bijlage. Eenheid: bytes |
|
sys_created_by
|
result.sys_created_by | string |
Entiteit die oorspronkelijk het bijlagebestand heeft gemaakt. |
|
sys_created_on
|
result.sys_created_on | string |
De datum en tijd waarop het bijlagebestand in eerste instantie is opgeslagen in het exemplaar. |
|
sys_id
|
result.sys_id | string |
Sys_id van het bijlagebestand. |
|
sys_mod_count
|
result.sys_mod_count | string |
Aantal keren dat het bijlagebestand is gewijzigd (geüpload naar het exemplaar). |
|
sys_tags
|
result.sys_tags | string |
Systeemtags die zijn gekoppeld aan het bijlagebestand. |
|
sys_updated_by
|
result.sys_updated_by | string |
Systeemtags die zijn gekoppeld aan het bijlagebestand. |
|
sys_updated_on
|
result.sys_updated_on | string |
Datum en tijd waarop het bijlagebestand voor het laatst is bijgewerkt. |
|
table_name
|
result.table_name | string |
Naam van de tabel waaraan de bijlage is gekoppeld. |
|
table_sys_id
|
result.table_sys_id | string |
Sys_id van de tabel die aan de bijlage is gekoppeld. |
|
updated_by_name
|
result.updated_by_name | string |
Volledige naam van de entiteit die het bijlagebestand voor het laatst heeft bijgewerkt. |
GetTypesResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
resultaat
|
result | array of object |
Resultatenset van alle recordtypen voor het huidige exemplaar. |
|
Weergavenaam
|
result.label | string |
Weergavenaam van het recordtype. |
|
Waarde
|
result.value | string |
Waarde van het recordtype. |
GetCatalogsResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
resultaat
|
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 | |
|
beschrijving
|
result.description | string | |
|
desktop_image
|
result.desktop_image | string |
GetCatalogCategoriesResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
resultaat
|
result | array of object | |
|
title
|
result.title | string | |
|
beschrijving
|
result.description | string | |
|
full_description
|
result.full_description | string | |
|
icon
|
result.icon | string | |
|
header_icon
|
result.header_icon | string | |
|
homepage_image
|
result.homepage_image | string | |
|
count
|
result.count | integer | |
|
Subcategorieën
|
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 | Pad | Type | Description |
|---|---|---|---|
|
resultaat
|
result | array of object | |
|
short_description
|
result.short_description | string | |
|
kb_article
|
result.kb_article | string | |
|
icon
|
result.icon | string | |
|
beschrijving
|
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 | |
|
prijs
|
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 | |
|
foto / afbeelding
|
result.picture | string | |
|
url
|
result.url | string | |
|
recurring_price_currency
|
result.recurring_price_currency | string | |
|
localized_price
|
result.localized_price | string | |
|
catalogs
|
result.catalogs | array of object | |
|
sys_id
|
result.catalogs.sys_id | string | |
|
active
|
result.catalogs.active | boolean | |
|
title
|
result.catalogs.title | string | |
|
naam
|
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 | Pad | Type | Description |
|---|---|---|---|
|
short_description
|
result.short_description | string |
short_description |
|
kb_article
|
result.kb_article | string |
kb_article |
|
icon
|
result.icon | string |
icon |
|
beschrijving
|
result.description | string |
beschrijving |
|
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 |
|
foto / afbeelding
|
result.picture | string |
foto / afbeelding |
|
url
|
result.url | string |
url |
|
catalogs
|
result.catalogs | array of object |
catalogs |
|
sys_id
|
result.catalogs.sys_id | string |
sys_id |
|
active
|
result.catalogs.active | boolean |
active |
|
title
|
result.catalogs.title | string |
title |
|
naam
|
result.name | string |
naam |
|
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 | Pad | Type | Description |
|---|---|---|---|
|
sys_id
|
result.sys_id | string |
sys_id |
|
nummer
|
result.number | string |
nummer |
|
request_number
|
result.request_number | string |
request_number |
|
request_id
|
result.request_id | string |
request_id |
|
table
|
result.table | string |
table |
GetArticlesResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Aantal
|
meta.count | integer |
Aantal beschikbare KB-artikelen |
|
Einde
|
meta.end | integer |
Eindindex van de resultatenset |
|
Fields
|
meta.fields | string |
Velden in het artikel |
|
Filter
|
meta.filter | string |
Filter dat wordt gebruikt om de gegevens te verkrijgen |
|
Kb
|
meta.kb | string |
Lijst met knowledge base-artikelen sys_ids |
|
Language
|
meta.language | string |
Lijst met door komma's gescheiden talen van de KB-artikelen die zijn aangevraagd |
|
Query
|
meta.query | string |
Opgegeven aanvraagquery |
|
Start
|
meta.start | string |
Index van resultatenset starten |
|
Toestand
|
meta.status.code | string |
Status van de aanroep |
|
Kb
|
meta.ts_query_id | string |
Lijst met door komma's gescheiden talen van de KB-artikelen die zijn aangevraagd |
|
Artikelen
|
articles | array of object | |
|
Weergavewaarde
|
articles.fields.display_value | string |
De waarde van het aangevraagde veld weergeven |
|
Etiket
|
articles.fields.label | string |
Label voor het aangevraagde veld |
|
Naam
|
articles.fields.name | string |
Naam van het aangevraagde veld |
|
Typologie
|
articles.fields.type | string |
Gegevenstype van aangevraagd veld |
|
Waarde
|
articles.fields.value | string |
Waarde van het aangevraagde veld |
|
Link
|
articles.Link | string |
Koppeling naar het artikel |
|
identiteitskaart
|
articles.id | string |
Kennisartikel sys_id uit de tabel Knowledge [kb_knowledge] |
|
Number
|
articles.number | string |
Kennisartikel sys_id uit de tabel Knowledge [kb_knowledge] |
|
Rang
|
articles.rank | float |
Zoekpositie van artikel dat specifiek is voor deze zoekopdracht |
|
Score
|
articles.score | float |
Relevantiescore, resultaten gesorteerd in aflopende volgorde op score |
|
Fragment
|
articles.snippet | string |
Tekst met een klein deel van het kennisartikel |
|
Title
|
articles.title | string |
Korte beschrijving of titel van het kennisartikel |