ServiceNow
Usługa ServiceNow poprawia poziom usług, zwiększa energię pracowników i umożliwia przedsiębiorstwu pracę w lekkim tempie. Tworzenie, odczytywanie i aktualizowanie rekordów przechowywanych w usłudze ServiceNow, w tym zdarzenia, pytania, użytkownicy i inne.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - China Cloud obsługiwane przez firmę 21Vianet |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - China Cloud obsługiwane przez firmę 21Vianet |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - China Cloud obsługiwane przez firmę 21Vianet |
| Kontakt | |
|---|---|
| Name | Microsoft |
| adres URL | https://learn.microsoft.com/connectors/service-now/ |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://www.servicenow.com/ |
| Zasady ochrony prywatności | https://www.servicenow.com/privacy-statement.html |
| Kategorie | Witryna internetowa |
Uwaga / Notatka
Operacja Uzyskiwanie artykułów merytorycznych może być używana tylko wtedy, gdy wtyczka interfejsu API wiedzy (sn_km_api) jest aktywowana.
Bezpieczeństwo i zarządzanie
Ważne
Ten łącznik uwidacznia ogólne akcje tworzenia, odczytu, aktualizacji i usuwania w dowolnej tabeli usługi ServiceNow. Jeśli używasz go za pośrednictwem agenta sztucznej inteligencji lub serwera MCP, instrukcje w umiejętności lub monituj o zmniejszenie ryzyka, ale nie są kontrolą zabezpieczeń. Duży model językowy nie wykonuje instrukcji deterministycznych.
Przed użyciem tego łącznika skonfiguruj szczegółowe mechanizmy kontroli dostępu w usłudze ServiceNow:
- Użyj dedykowanego konta integracji, a nie osobistego lub administratora.
- Udziel kontu tylko ról i list ACL tabel, których potrzebuje (najmniej uprawnień).
- Odmowa dostępu do zapisu do zatwierdzeń, ról, list ACL, poświadczeń i stanu użytkownika oraz do dowolnej tabeli, których agent nie potrzebuje.
- Regularnie przeglądaj dziennik inspekcji konta.
Elementy konfiguracji (CMDB)
-
Tworzenie lub aktualizowanie elementów konfiguracji używa aparatu identyfikacji i uzgadniania usługi ServiceNow (IRE), więc unika się duplikatów. Użytkownik połączenia musi mieć
itilrolę lubasset. Ustaw opcję Źródło danych nadiscovery_sourcewartość wyboru lub usługa ServiceNow nie zatwierdza ładunku. Usługa ServiceNow zwraca wartość 200, nawet jeśli pojedyncze urzędy certyfikacji kończą się niepowodzeniem, więc zaewidencjonujsummary.hasErrorsodpowiedź. -
Dodaj relacje elementów konfiguracji dodaje relacje typizowane za pomocą interfejsu API wystąpienia usługi CMDB. Powtarzanie identycznego dodawania zwraca istniejącą relację, więc nie jest tworzona żadna duplikat. Użyj go zamiast polecenia Utwórz rekord w obiekcie
cmdb_rel_ci, który nie sprawdza pod kątem duplikatów. - Aby usunąć relację, użyj polecenia Usuń rekord w
cmdb_rel_citabeli z sys_id relacji. - Aby usunąć ciągłą integrację, użyj polecenia Usuń rekord w swojej tabeli klas. Usługa ServiceNow usuwa również relacje ciągłej integracji.
- W przypadku innych odczytów CMDB użyj polecenia Pobierz rekordy z tabelą
cmdb_ci*. -
Funkcja Pobierz typy rekordów zwraca każdą tabelę (tysiące). Ustaw wyszukiwanie (pasuje do nazwy lub etykiety), Limit (1–500, wartość domyślna 50) i Przesunięcie , aby uzyskać stronę;
metapokazujetotalihasMore. Bez tych danych wejściowych zwracana jest pełna lista.
Znane problemy i ograniczenia
W przypadku korzystania z akcji Utwórz rekord nie można określić pełnego opisu rekordu. Wartość pola zostanie zignorowana z powodu ograniczeń interfejsu API REST Service-Now.
Akcja Pobierz rekordy może zwrócić wartość "Nieprawidłowa tabela" lub inny błąd w usłudze Power Apps. W przypadku implementacji usługi Power Apps sugerowana praca polega na użyciu akcji Pobierz rekordy w usłudze Power Automate i przekazania danych z powrotem do usługi Power Apps.
Łącznik obsługuje obecnie tylko adresy URL wystąpień kończące się ciągiem "service-now.com". Użycie domen alternatywnych, takich jak "servicenowservices.com", może prowadzić do błędów połączenia. W takich przypadkach — szczególnie podczas pracy z nową domeną usługi ServiceNow w GCC — zaleca się użycie uwierzytelniania podstawowego.
Jeśli wystąpi błąd wyskakującego z komunikatem "Invalid redirect_uri", skopiuj pełny adres URL z okna podręcznego i wyodrębnij parametr redirect_uri (np. redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect). Po dekodowaniu adresu URL (zastępując %3a ciągiem : i %2f ciągiem /), zaktualizuj pole Adres URL przekierowania w rejestrze aplikacji OAuth wystąpienia usługi ServiceNow, jak pokazano na poniższej ilustracji. Następnie spróbuj ponownie dodać połączenie.
Jak skonfigurować połączenie usługi ServiceNow Power Platform korzystające z identyfikatora Entra firmy Microsoft
Istnieją dwa typy połączeń:
Microsoft Entra ID OAuth przy użyciu certyfikatu: jest to typ uwierzytelniania opartego na tokenach aplikacji, w którym aplikacja zarejestrowana w identyfikatorze Entra może służyć do uzyskiwania dostępu do usługi ServiceNow przez uzyskanie tokenu z zestawem zasobów jako przedstawiciel usługi ServiceNow aplikacji Entra ID.
Microsoft Entra ID OAuth przy użyciu identyfikatora logowania użytkownika: jest to typ uwierzytelniania opartego na tokenie użytkownika, w którym użytkownik końcowy może zalogować się do aplikacji Entra ID 1P (aplikacja ServiceNow Connector 1p) i uzyskać token dostępu z zakresem ustawionym dla aplikacji Entra id przedstawiciela usługi ServiceNow.
Kroki tworzenia połączenia OAuth identyfikatora entra firmy Microsoft przy użyciu certyfikatu
Krok 1. Rejestrowanie aplikacji "Application A" w usłudze Microsoft Entra ID na potrzeby integracji OIDC z usługą ServiceNow. Jest to aplikacja Entra ID przedstawiciela usługi ServiceNow.
Przejdź do obszaru Rejestracje > aplikacji Nowa rejestracja, aby utworzyć nową rejestrację aplikacji
Nazwa: dowolna wybrana nazwa
Identyfikator URI przekierowania: nie jest wymagany
Dodaj
audelement iemailupndo oświadczeń w obszarze "Opcjonalne oświadczenia"
Krok 2. Rejestrowanie tego samego identyfikatora co dostawca OIDC w usłudze ServiceNow
Przejdź do adresu ,
System OAuth > Application Registry > New > Configure an OIDC provideraby zweryfikować tokeny identyfikatorów- Nazwa: dowolna wybrana nazwa
-
Identyfikator klienta:
client IDwartość "Application A" utworzona w kroku 1 - Klucz tajny klienta: w rzeczywistości nie będzie używany, można ustawić dowolną wartość
W formularzu rejestracji dostawcy OIDC dodaj nową konfigurację dostawcy OIDC. Wybierz ikonę wyszukiwania względem pola Konfiguracja dostawcy OAuth OIDC , aby otworzyć rekordy konfiguracji OIDC, wybierz pozycję "Nowy".
- Dostawca OIDC: Microsoft Entra ID
-
Adres URL metadanych OIDC: adres URL musi mieć postać
https://login.microsoftonline.com/<tenantID>/.well-known/openid-configuration, zastąp ciągtenantIDciągiemDirectory (tenant) ID - Okres życia pamięci podręcznej konfiguracji OIDC: 120
- Aplikacja: globalna
- Oświadczenie użytkownika: oid
- Pole użytkownika: identyfikator użytkownika
- Włącz weryfikację oświadczenia JTI: wyłączone
Wybierz pozycję "Submit" (Prześlij) i zaktualizuj formularz jednostki OAuth OIDC
Krok 3. Rejestrowanie "aplikacji B" w identyfikatorze entra firmy Microsoft na potrzeby użycia łącznika. Jest to aplikacja, która odgrywa rolę użytkownika z podwyższonym poziomem uprawnień w wystąpieniu usługi ServiceNow
Przejdź do witryny , aby
Rejestracje aplikacji > New registrationutworzyć nową aplikację- Nazwa: dowolna wybrana nazwa
- W obszarze Certyfikaty i wpisy tajne przekaż plik .cer certyfikatu W przypadku certyfikatu SNI wystarczy dodać
trustedCertificateSubjectsmanifest aplikacji z odpowiednimauthorityIdelementem isubjectName
Krok 4. Tworzenie użytkownika systemu w usłudze ServiceNow. Jest to "Aplikacja B" jako użytkownik w wystąpieniu usługi ServiceNow
Przejdź do witryny ,
User Administration > Usersaby utworzyć nowego użytkownika- Identyfikator użytkownika: identyfikator obiektu jednostki usługi "Application B" utworzony w kroku 3
- Sprawdź
Web service access only
Krok 5. Nawiązywanie połączenia przy użyciu łącznika — Copilot Studio — konfiguracja łącznika
Skonfiguruj łącznik przy użyciu następujących informacji i nawiąż połączenie:
- Nazwa wystąpienia: nazwa wystąpienia usługi ServiceNow
- Identyfikator dzierżawy: identyfikator dzierżawy dzierżawy Microsoft Entra
- Identyfikator klienta: identyfikator klienta aplikacji B utworzony w kroku 3
- Identyfikator URI zasobu: identyfikator klienta aplikacji A utworzony w kroku 1 (a nie identyfikator URI aplikacji)
- Klucz tajny certyfikatu klienta: plik pfx certyfikatu utworzonego w kroku 3
- Hasło certyfikatu: hasło pliku pfx
Kroki tworzenia logowania użytkownika OAuth identyfikatora entra firmy Microsoft
Aby skonfigurować połączenie logowania użytkownika OAuth identyfikatora entra firmy Microsoft, wykonaj krok 1 i krok 2 zgodnie z opisem w powyższej sekcji uwierzytelniania certyfikatu.
Krok 1 pozostaje taki sam. W kroku 2 zaktualizuj oświadczenie użytkownika do właściwości Upn lub custom claim z tokenu (dla dostawców tożsamości innych firm niż Entra) w usłudze ServiceNow. Pole użytkownika powinno być zgodne z polem tabeli użytkownika systemu ServiceNow zawierającym nazwę upn lub identyfikator użytkownika.
Kroki 3 i 4 z powyższej sekcji uwierzytelniania certyfikatu nie są wymagane. Zamiast tego "Aplikacja B" w tym przypadku jest aplikacją 1p utworzoną dla łącznika usługi ServiceNow. Poniższa aplikacja musi mieć przyznane uprawnienia w obszarze "Aplikacja A".
Identyfikator "Application B": c26b24aa-7874-4e06-ad55-7d06b1f79b63
Ważne
W tym scenariuszu "Aplikacja B" musi używać identyfikatora c26b24aa-7874-4e06-ad55-7d06b1f79b63 , który jest wcześniej istniejącą aplikacją 1p należącą do firmy Microsoft, a nie aplikacją utworzoną przez użytkownika (co jest wymagane do utworzenia połączenia OAuth oauth identyfikatora entra firmy Microsoft przy użyciu certyfikatu).
Podczas tworzenia połączenia dla łącznika usługi ServiceNow użytkownik musi wybrać opcję "Identyfikator użytkownika identyfikatora firmy Microsoft" jako typ uwierzytelniania i musi podać nazwę wystąpienia usługi ServiceNow i identyfikator zasobu (który byłby identyfikatorem "Aplikacja A"). Następnie przycisk logowania przeprowadzi użytkownika za pomocą identyfikatora Entra ID przy użyciu własnego konta.
Używanie dostawcy tożsamości innej firmy lub niezgodności danych między użytkownikiem w identyfikatorze Entra i tabeli użytkowników usługi ServiceNow
- W przypadku niezgodności właściwości identyfikatora użytkownika w tokenie Entra ID i wartości identyfikatora użytkownika, która znajduje się w tabeli ServiceNow
- Na przykład token zawiera pełną nazwę upn (wraz z domeną —
abc@contoso.com), a tabela użytkowników usługi ServiceNow zawiera tylko identyfikator użytkownika (abc). Zaleca się dodanie atrybutu niestandardowego do tokenu zawierającego wartość zgodną z identyfikatorem użytkownika w identyfikatorze usługi ServiceNow przez zastosowanie formuły, a następnie użycie tej nowej właściwości w celu wykonania mapowania oświadczeń w kroku 2. - Dokumentacja usługi Microsoft Learn opisująca proces dodawania nowej właściwości oświadczenia: https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token
- Na przykład token zawiera pełną nazwę upn (wraz z domeną —
"How to set up a ServiceNow Power Platform connection that uses Microsoft Entra ID" references(Jak skonfigurować połączenie usługi ServiceNow Power Platform korzystające z Microsoft Entra ID):
- Uwierzytelnianie tokenu identyfikatora zewnętrznego (OIDC) dla interfejsów API REST — obsługa i rozwiązywanie problemów
- Łącznik Microsoft Graph katalogu usługi ServiceNow | Microsoft Learn
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Uwierzytelnianie podstawowe | Logowanie przy użyciu uwierzytelniania podstawowego | Wszystkie regiony | Nie można udostępniać |
| Microsoft Entra ID uwierzytelnianie OAuth przy użyciu certyfikatu | Uwierzytelnianie OAuth z identyfikatorem Entra firmy Microsoft przy użyciu certyfikatu PFX. | Tylko POWERPLATFORM | Udostępnialne |
| logowanie użytkownika Microsoft Entra ID | Logowanie przy użyciu poświadczeń identyfikatora entra firmy Microsoft | Wszystkie regiony | Nie można udostępniać |
| Korzystanie z protokołu Oauth2 | Logowanie przy użyciu protokołu Oauth2 | Wszystkie regiony | Nie można udostępniać |
| Domyślne [PRZESTARZAŁE] | Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami. | Wszystkie regiony | Nie można udostępniać |
Uwierzytelnianie podstawowe
Identyfikator uwierzytelniania: basicAuthentication
Dotyczy: wszystkie regiony
Logowanie przy użyciu uwierzytelniania podstawowego
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Instance | ciąg | Nazwa wystąpienia dla service-now.com lub niestandardowego adresu URL migrowanego konta | Prawda |
| Nazwa użytkownika | ciąg | Nazwa użytkownika dla tego wystąpienia | Prawda |
| Hasło | securestring | Hasło dla tego konta | Prawda |
Microsoft Entra OAuth identyfikatora przy użyciu certyfikatu
Identyfikator uwierzytelniania: aadOAuthCert
Dotyczy: tylko POWERPLATFORM
Uwierzytelnianie OAuth z identyfikatorem Entra firmy Microsoft przy użyciu certyfikatu PFX.
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz Omówienie łączników dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Nazwa wystąpienia | ciąg | Nazwa wystąpienia używana do identyfikowania listy URl witryny usługi ServiceNow | Prawda |
| Identyfikator dzierżawy | ciąg | Prawda | |
| ID klienta | ciąg | Prawda | |
| Adres URI zasobu | ciąg | Prawda | |
| Klucz tajny certyfikatu klienta | certyfikat klienta | Klucz tajny certyfikatu klienta dozwolony przez tę aplikację | Prawda |
Identyfikator użytkownika entra firmy Microsoft
Identyfikator uwierzytelniania: entraIDUserLogin
Dotyczy: wszystkie regiony
Logowanie przy użyciu poświadczeń identyfikatora entra firmy Microsoft
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Adres URI zasobu | ciąg | Prawda | |
| Nazwa wystąpienia | ciąg | Nazwa wystąpienia używana do identyfikowania adresu URL witryny usługi ServiceNow | Prawda |
Korzystanie z protokołu Oauth2
Identyfikator uwierzytelniania: oauth2ServiceNow
Dotyczy: wszystkie regiony
Logowanie przy użyciu protokołu Oauth2
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Nazwa wystąpienia | ciąg | Nazwa wystąpienia używana do identyfikowania listy URl witryny usługi ServiceNow | Prawda |
| Identyfikator klienta | ciąg | Identyfikator używany do identyfikowania tej aplikacji u dostawcy usług | Prawda |
| Tajemnica klienta | securestring | Wspólny klucz tajny używany do uwierzytelniania tej aplikacji u dostawcy usług | Prawda |
Domyślne [PRZESTARZAŁE]
Dotyczy: wszystkie regiony
Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Instance | ciąg | Nazwa wystąpienia dla service-now.com lub niestandardowego adresu URL migrowanego konta | Prawda |
| Nazwa użytkownika | ciąg | Nazwa użytkownika dla tego wystąpienia | Prawda |
| Hasło | securestring | Hasło dla tego konta | Prawda |
Limity ograniczania
| Nazwisko | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 600 | 60 sekund |
Akcje
| Aktualizuj rekord |
Aktualizuje rekord w tabeli ServiceNow, na przykład zdarzenie lub change_request |
| Dodawanie relacji elementów konfiguracji |
Dodaje relacje ruchu przychodzącego lub wychodzącego do elementu konfiguracji. Pola relacji dla ruchu przychodzącego i wychodzącego ustawiają kierunek. |
| Element zamówienia |
Zamawia lub kupuje określony element wykazu. |
| Lista rekordów |
Pobiera rekordy z tabeli ServiceNow, na przykład zdarzenia lub change_request |
| Pobieranie elementu wykazu |
Pobieranie określonego elementu wykazu. |
| Pobieranie elementów wykazu |
Wyświetla listę elementów wykazu, opcjonalnie według tekstu wyszukiwania lub wykazu. |
| Pobieranie kategorii wykazu |
Pobiera listę kategorii dla określonego wykazu |
| Pobieranie metadanych załącznika |
Pobieranie metadanych dla załączników |
| Pobieranie metadanych załącznika |
Pobieranie metadanych załącznika |
| Pobieranie rekordu |
Pobiera rekord z tabeli ServiceNow, na przykład incydent lub change_request |
| Pobieranie typów rekordów |
Wyświetla listę dostępnych typów rekordów. Użyj wyszukiwania, limitu i przesunięcia, aby stronicować wynik. W przypadku dowolnego z tych danych wejściowych nieczytelna odpowiedź usługi ServiceNow zwraca wartość 502. |
| Pobieranie wykazów |
Pobiera listę wykazów |
| Pobieranie zawartości załącznika |
Pobieranie zawartości załącznika |
| Przekazywanie pliku binarnego jako załącznika |
Przekazuje plik binarny jako załącznik do określonego rekordu |
| Przekazywanie załącznika do pliku wieloczęściowego |
Przekazywanie załącznika z formularza wieloczęściowego |
| Tworzenie lub aktualizowanie elementów konfiguracji |
Tworzy lub aktualizuje elementy konfiguracji (CI) w bazie danych CMDB. Użyj tej funkcji zamiast bezpośrednich tabel CMDB. Zawsze sprawdź plik summary.hasErrors w odpowiedzi dla pojedynczej ciągłej integracji kończy się niepowodzeniem. |
| Tworzenie rekordu |
Tworzy rekord w tabeli ServiceNow, na przykład zdarzenie lub change_request. |
| Usuwanie załącznika |
Usuwanie załącznika |
| Usuń rekord |
Usuwa rekord z tabeli ServiceNow, na przykład incydent lub change_request |
| Uzyskiwanie artykułu merytorycznego |
Zwraca pełną zawartość artykułu bazy wiedzy (KB), w tym sekcje szablonu. |
| Uzyskiwanie artykułów merytorycznych |
Zwraca listę artykułów bazy wiedzy ,które można przeszukiwać i filtrować |
Aktualizuj rekord
Aktualizuje rekord w tabeli ServiceNow, na przykład zdarzenie lub change_request
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ rekordu
|
tableType | True | string |
Nazwa tabeli ServiceNow, na przykład incydentu, change_request lub tabeli niestandardowej. |
|
Identyfikator systemu
|
sysid | True | string |
Identyfikator systemu rekordu. |
|
body
|
body | True | dynamic | |
|
Wyświetlanie odwołań systemowych
|
sysparm_display_value | boolean |
Określa, czy należy uwzględnić odwołania systemowe |
|
|
Wykluczanie linków referencyjnych
|
sysparm_exclude_reference_link | boolean |
Określa, czy łącza referencyjne powinny być wykluczone |
|
|
Pola formularza
|
sysparm_fields | string |
Rozdzielona przecinkami lista pól do zwrócenia. Przykład: nazwa, adres e-mail, telefon |
Zwraca
Dodawanie relacji elementów konfiguracji
Dodaje relacje ruchu przychodzącego lub wychodzącego do elementu konfiguracji. Pola relacji dla ruchu przychodzącego i wychodzącego ustawiają kierunek.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ci, klasa
|
className | True | string |
Nazwa klasy CMDB (tabela) ciągłej integracji, taka jak cmdb_ci_linux_server. |
|
Identyfikator ciągłej integracji
|
sys_id | True | string |
Sys_id ciągłej integracji w celu dodania relacji. |
|
Source
|
source | True | string |
Źródło stosunków. Musi być wartością wyboru discovery_source dla cmdb_ci. |
|
Powiązany identyfikator ciągłej integracji
|
target | True | string |
Sys_id powiązanej ciągłej integracji z tabeli Element konfiguracji [cmdb_ci]. |
|
Identyfikator typu relacji
|
type | True | string |
Sys_id typu relacji (cmdb_rel_type). |
|
Powiązany identyfikator ciągłej integracji
|
target | True | string |
Sys_id powiązanej ciągłej integracji z tabeli Element konfiguracji [cmdb_ci]. |
|
Identyfikator typu relacji
|
type | True | string |
Sys_id typu relacji (cmdb_rel_type). |
Zwraca
Element zamówienia
Zamawia lub kupuje określony element wykazu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator elementu
|
sys_id | True | string |
Sys_id elementu wykazu do zamówienia |
|
Treść elementu zamówienia
|
body | True | dynamic |
Ilość, żądana dla zmiennej użytkownika i elementu. |
Zwraca
- Body
- OrderItemResponse
Lista rekordów
Pobiera rekordy z tabeli ServiceNow, na przykład zdarzenia lub change_request
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ rekordu
|
tableType | True | string |
Nazwa tabeli ServiceNow, na przykład incydentu, change_request lub tabeli niestandardowej. |
|
Wyświetlanie odwołań systemowych
|
sysparm_display_value | boolean |
Określa, czy należy uwzględnić odwołania systemowe |
|
|
Wykluczanie linków referencyjnych
|
sysparm_exclude_reference_link | boolean |
Określa, czy łącza referencyjne powinny być wykluczone |
|
|
Query
|
sysparm_query | string |
Zakodowane zapytanie używane do filtrowania zestawu wyników. Przykład: active=true^ORDERBYnumber^ORDERBYDESCcategory |
|
|
Ograniczenie
|
sysparm_limit | integer |
Limit do zastosowania w przypadku stronicowania. Wartość domyślna to 10000. |
|
|
Przesunięcie
|
sysparm_offset | integer |
Liczba rekordów do wykluczenia z zapytania. |
|
|
Pola formularza
|
sysparm_fields | string |
Rozdzielona przecinkami lista pól do zwrócenia. Przykład: nazwa, adres e-mail, telefon |
Zwraca
Pobieranie elementu wykazu
Pobieranie określonego elementu wykazu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator elementu
|
sys_id | True | string |
Sys_id elementu wykazu do pobrania |
Zwraca
Pobieranie elementów wykazu
Wyświetla listę elementów wykazu, opcjonalnie według tekstu wyszukiwania lub wykazu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kategoria
|
sysparm_category | string |
Identyfikator kategorii do filtrowania elementów według. Jeśli nie zostanie określony, zwracane są wszystkie elementy. |
|
|
Ograniczenie
|
sysparm_limit | True | integer |
Liczba elementów wykazu do pobrania |
|
Tekst wyszukiwania
|
sysparm_text | string |
Wyszukiwanie tekstu w celu filtrowania elementów według |
|
|
Catalog
|
sysparm_catalog | string |
Identyfikator wykazu do filtrowania elementów według. Jeśli nie zostanie określony, zwracane są elementy ze wszystkich wykazów |
Zwraca
Pobieranie kategorii wykazu
Pobiera listę kategorii dla określonego wykazu
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wykazu
|
catalogId | True | string |
Identyfikator wykazu, dla którego mają być pobierane kategorie |
|
Ograniczenie
|
sysparm_limit | integer |
Liczba kategorii wykazu do pobrania |
|
|
Przesunięcie
|
sysparm_offset | integer |
Przesunięcie zapytania |
Zwraca
Pobieranie metadanych załącznika
Pobieranie metadanych dla załączników
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ograniczenie
|
sysparm_limit | string |
Maksymalna liczba rekordów do zwrócenia. Wartość domyślna 1000. |
|
|
Przesunięcie
|
sysparm_offset | string |
Liczba rekordów do pominięcia. Użyj go, aby uzyskać następną stronę. Wartość domyślna 0. |
|
|
Query
|
sysparm_query | string |
Zakodowane zapytanie na sys_attachment. Przykład: file_name=attachment.doc |
Pobieranie metadanych załącznika
Pobieranie metadanych załącznika
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
sys_id | True | string |
Sys_id załącznika w celu pobrania metadanych dla |
Pobieranie rekordu
Pobiera rekord z tabeli ServiceNow, na przykład incydent lub change_request
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ rekordu
|
tableType | True | string |
Nazwa tabeli ServiceNow, na przykład incydentu, change_request lub tabeli niestandardowej. |
|
Identyfikator systemu
|
sysid | True | string |
Identyfikator systemu rekordu. |
|
Wyświetlanie odwołań systemowych
|
sysparm_display_value | boolean |
Określa, czy należy uwzględnić odwołania systemowe |
|
|
Wykluczanie linków referencyjnych
|
sysparm_exclude_reference_link | boolean |
Określa, czy łącza referencyjne powinny być wykluczone |
|
|
Pola formularza
|
sysparm_fields | string |
Rozdzielona przecinkami lista pól do zwrócenia. Przykład: nazwa, adres e-mail, telefon |
Zwraca
Pobieranie typów rekordów
Wyświetla listę dostępnych typów rekordów. Użyj wyszukiwania, limitu i przesunięcia, aby stronicować wynik. W przypadku dowolnego z tych danych wejściowych nieczytelna odpowiedź usługi ServiceNow zwraca wartość 502.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Search
|
search | string |
Zwracanie tylko typów rekordów, których nazwa lub etykieta zawiera ten tekst |
|
|
Ograniczenie
|
limit | integer |
Maksymalna liczba zwracanych typów rekordów, od 1 do 500. Wartość domyślna 50 podczas ustawiania wyszukiwania lub przesunięcia. Bez wyszukiwania, limitu i przesunięcia zwracane są wszystkie typy rekordów. |
|
|
Przesunięcie
|
offset | integer |
Liczba pasujących typów rekordów do pominięcia, posortowana według nazwy |
Zwraca
- Body
- GetTypesResponse
Pobieranie wykazów
Pobiera listę wykazów
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ograniczenie
|
sysparm_limit | integer |
Liczba wykazów do pobrania |
|
|
Tekst wyszukiwania
|
sysparm_text | string |
Wyszukiwanie tekstu w celu filtrowania wykazów według nazwy lub opisu |
Zwraca
- Body
- GetCatalogsResponse
Pobieranie zawartości załącznika
Pobieranie zawartości załącznika
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator systemu
|
sys_id | True | string |
Sys_id załącznika w celu pobrania zawartości dla |
Przekazywanie pliku binarnego jako załącznika
Przekazuje plik binarny jako załącznik do określonego rekordu
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa tabeli
|
table_name | True | string |
Nazwa tabeli, do której chcesz dołączyć plik |
|
Identyfikator systemu
|
table_sys_id | True | string |
Sys_id rekordu w określonej tabeli, do której chcesz dołączyć plik |
|
Nazwa pliku
|
file_name | True | string |
Nazwa, aby nadać załącznik |
|
File
|
file | True | binary |
Plik binarny do dołączenia do określonego rekordu |
Zwraca
Przekazywanie załącznika do pliku wieloczęściowego
Przekazywanie załącznika z formularza wieloczęściowego
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa tabeli
|
table_name | True | string |
Nazwa tabeli, do której chcesz dołączyć plik. |
|
Identyfikator tabeli
|
table_sys_id | True | string |
Sys_id rekordu w określonej tabeli, do której chcesz dołączyć plik |
|
Zawartość załącznika
|
attachment_content | True | file |
Załącznik do przekazania. Musi być ostatnią częścią formularza wieloczęściowego. |
Zwraca
Tworzenie lub aktualizowanie elementów konfiguracji
Tworzy lub aktualizuje elementy konfiguracji (CI) w bazie danych CMDB. Użyj tej funkcji zamiast bezpośrednich tabel CMDB. Zawsze sprawdź plik summary.hasErrors w odpowiedzi dla pojedynczej ciągłej integracji kończy się niepowodzeniem.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Źródło danych
|
sysparm_data_source | True | string |
Źródło danych ciągłej integracji. Musi być wartością wyboru discovery_source dla cmdb_ci. Required. |
|
Ci, klasa
|
className | True | string |
Sys_class_name (tabela) ciągłej integracji, na przykład cmdb_ci_linux_server. |
|
Identyfikator wewnętrzny
|
internal_id | string |
Identyfikator tego elementu wewnątrz ładunku. Musi być unikatowy w ładunku. |
|
|
Values
|
values | object |
Wartości pól ciągłej integracji jako pary nazw i wartości. |
|
|
Lookup
|
Lookup | object | ||
|
Powiązane elementy
|
Related Items | object | ||
|
Settings
|
settings | object |
Opcjonalne flagi ograniczające aktualizację, takie jak updateWithoutDowngrade. |
|
|
Informacje o źródle
|
sys_object_source_info | object |
Opcjonalny unikatowy identyfikator ciągłej integracji w jego źródle. |
Zwraca
Tworzenie rekordu
Tworzy rekord w tabeli ServiceNow, na przykład zdarzenie lub change_request.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ rekordu
|
tableType | True | string |
Nazwa tabeli ServiceNow, na przykład incydentu, change_request lub tabeli niestandardowej. |
|
body
|
body | True | dynamic | |
|
Wyświetlanie odwołań systemowych
|
sysparm_display_value | boolean |
Określa, czy należy uwzględnić odwołania systemowe |
|
|
Wykluczanie linków referencyjnych
|
sysparm_exclude_reference_link | boolean |
Określa, czy łącza referencyjne powinny być wykluczone |
|
|
Pola formularza
|
sysparm_fields | string |
Rozdzielona przecinkami lista pól do zwrócenia. Przykład: nazwa, adres e-mail, telefon |
Zwraca
Usuwanie załącznika
Usuwanie załącznika
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator systemu
|
sys_id | True | string |
Sys_id załącznika do usunięcia |
Usuń rekord
Usuwa rekord z tabeli ServiceNow, na przykład incydent lub change_request
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ rekordu
|
tableType | True | string |
Nazwa tabeli ServiceNow, na przykład incydentu, change_request lub tabeli niestandardowej. |
|
Identyfikator systemu
|
sysid | True | string |
Identyfikator systemu rekordu. |
Uzyskiwanie artykułu merytorycznego
Zwraca pełną zawartość artykułu bazy wiedzy (KB), w tym sekcje szablonu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator systemu artykułu
|
articleSysId | True | string |
Numer sys_id lub KB artykułu wiedzy do pobrania. |
|
Pola formularza
|
fields | string |
Rozdzielona przecinkami lista pól z tabeli Knowledge do zwrócenia. |
|
|
Język
|
language | string |
Rozdzielona przecinkami lista języków artykułu bazy wiedzy, które mają być zwracane. |
Zwraca
- Body
- GetArticleResponse
Uzyskiwanie artykułów merytorycznych
Zwraca listę artykułów bazy wiedzy ,które można przeszukiwać i filtrować
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pola formularza
|
fields | string |
Rozdzielona przecinkami lista pól z tabeli Knowledge. |
|
|
Ograniczenie
|
limit | integer |
Maksymalna liczba rekordów do zwrócenia. |
|
|
Query
|
query | True | string |
Tekst do wyszukania. |
|
Filter
|
filter | string |
Zakodowane zapytanie do użycia do filtrowania zestawu wyników. |
|
|
Baza wiedzy
|
kb | string |
Rozdzielona przecinkami lista sys_ids bazy wiedzy. |
Zwraca
- Body
- GetArticlesResponse
Definicje
UpsertConfigurationItemsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
result.items | array of ReconciledItem |
Wynik dla każdej przesłanej ciągłej integracji. |
|
Dodatkowe elementy
|
result.additionalCommittedItems | array of ReconciledItem |
Identyfikatory CI, które zostały zatwierdzone, ale nie były częścią żądania. |
|
Relacje
|
result.relations | array of object |
Relacje przetwarzane z elementami. |
|
items
|
result.relations | object | |
|
Dodatkowe relacje
|
result.additionalCommittedRelations | array of object |
Relacje, które zostały popełnione, ale nie były częścią wniosku. |
|
items
|
result.additionalCommittedRelations | object | |
|
Przetworzone elementy
|
summary.processedItems | integer |
Liczba identyfikatorów CI zgłoszonych przez usługę ServiceNow. |
|
Elementy, które zakończyły się niepowodzeniem
|
summary.failedItems | integer |
Liczba identyfikatorów CI, które zgłosiły błędy lub nieczytelną wartość błędu. |
|
Przetworzone relacje
|
summary.processedRelations | integer |
Liczba relacji zgłoszonych przez usługę ServiceNow. |
|
Relacje z niepowodzeniem
|
summary.failedRelations | integer |
Liczba relacji, które zgłosiły błędy lub nieczytelną wartość błędu. |
|
Zawiera błędy
|
summary.hasErrors | boolean |
Wartość true, jeśli co najmniej jedna ciągła integracja lub relacja nie powiodła się albo parametr ServiceNow ustawił wynik.hasError ma wartość true lub wartość nieczytelną. |
|
Błędy
|
summary.failures | array of object |
Urzędy certyfikacji i relacje, które zgłaszały błędy. |
|
Sekcja
|
summary.failures.section | string |
Sekcja wyniku wpisu, który zakończył się niepowodzeniem: items, additionalCommittedItems, relations lub additionalCommittedRelations. |
|
Ci, klasa
|
summary.failures.className | string |
Klasa ciągłej integracji lub relacji, która nie powiodła się. |
|
Indeksy wejściowe
|
summary.failures.inputIndices | array of integer |
Pozycje wpisu zakończonego niepowodzeniem w tablicy elementów żądania. W przypadku sekcji relacji pozycje odnoszą się do relacji uzyskanych przez usługę ServiceNow. |
|
Errors
|
summary.failures.errors | array of object |
Błędy zgłaszane dla ciągłej integracji lub relacji. Łącznik dodaje MALFORMED_RESPONSE, gdy usługa ServiceNow zwróciła nieczytelne błędy lub wartość errorCount. |
|
błąd
|
summary.failures.errors.error | string |
Rodzaj błędu. |
|
komunikat
|
summary.failures.errors.message | string |
Komunikat o błędzie. |
Uzgadnianie elementu
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Ci, klasa
|
className | string |
Sys_class_name ciągłej integracji. |
|
Identyfikator ciągłej integracji
|
sysId | string |
Sys_id ciągłej integracji, która została utworzona lub zaktualizowana. |
|
Operacja
|
operation | string |
To, co zrobiliśmy w przypadku ciągłej integracji, na przykład INSERT, UPDATE lub NO_CHANGE. |
|
Liczba błędów
|
errorCount | integer |
Liczba błędów dla tej ciągłej integracji. |
|
Errors
|
errors | array of object |
Błędy dla tej ciągłej integracji. |
|
błąd
|
errors.error | string |
Rodzaj błędu. |
|
komunikat
|
errors.message | string |
Komunikat o błędzie. |
|
Indeksy wejściowe
|
inputIndices | array of integer |
Pozycje elementów żądania, które wygenerowały tę ciągłą integrację. |
|
Znaczniki
|
markers | array of string |
Znaczniki IRE dla tej ciągłej integracji. |
LinkConfigurationItemsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Attributes
|
result.attributes | object |
Bieżące atrybuty ciągłej integracji. Atrybuty zależą od klasy ciągłej integracji. |
|
Relacje przychodzące
|
result.inbound_relations | array of CIRelation |
Relacje przychodzące ciągłej integracji. |
|
Relacje ruchu wychodzącego
|
result.outbound_relations | array of CIRelation |
Relacje ruchu wychodzącego z ciągłej integracji. |
CiRelation
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator relacji
|
sys_id | string |
Sys_id relacji (cmdb_rel_ci). |
|
value
|
target.value | string |
Sys_id powiązanej ciągłej integracji. |
|
display_value
|
target.display_value | string |
Nazwa wyświetlana powiązanej ciągłej integracji. |
|
łącze
|
target.link | string |
Link do powiązanej ciągłej integracji. |
|
value
|
type.value | string |
Sys_id typu relacji. |
|
display_value
|
type.display_value | string |
Nazwa wyświetlana typu relacji. |
|
łącze
|
type.link | string |
Połącz z typem relacji. |
GetArticleResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Number
|
result.number | string |
Numer KB artykułu. |
|
Identyfikator systemu
|
result.sys_id | string |
Sys_id artykułu. |
|
Krótki opis
|
result.short_description | string |
Krótki opis (tytuł) artykułu. |
|
Tekst
|
result.text | string |
Treść standardowych artykułów. Puste dla artykułów szablonu; zobacz zawartość. |
|
Template
|
result.template | boolean |
Prawda dla artykułu szablonu; jego treść jest w zawartości. |
|
Tabela szablonów
|
result.template_table | string |
Tabela szablonów artykułu szablonu, na przykład kb_template_how_to. |
|
Język
|
result.language | string |
Język zwróconego artykułu. |
|
Content
|
result.content | array of object |
Zmontowane sekcje szablonu dla artykułów szablonów/Knowledge-Block. |
|
Etykieta
|
result.content.label | string |
Etykieta wyświetlana sekcji szablonu. |
|
Column
|
result.content.column | string |
Kolumna szablonu zawierająca kopię zapasową sekcji. |
|
Typ
|
result.content.type | string |
Typ zawartości sekcji (na przykład html). |
|
Content
|
result.content.content | string |
Treść sekcji. |
UploadAttachmentResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
average_image_color
|
result.average_image_color | string |
Jeśli załącznik jest obrazem, suma wszystkich kolorów. |
|
Skompresowane
|
result.compressed | string |
Flaga wskazująca, czy plik załącznika został skompresowany. |
|
content_type
|
result.content_type | string |
Typ zawartości pliku załącznika, na przykład image/png. |
|
created_by_name
|
result.created_by_name | string |
Pełna nazwa jednostki, która pierwotnie utworzyła plik załącznika. |
|
download_link
|
result.download_link | string |
Pobierz adres URL załącznika w wystąpieniu usługi ServiceNow. |
|
nazwa_pliku
|
result.file_name | string |
Nazwa pliku załącznika. |
|
image_height
|
result.image_height | string |
Jeśli plik obrazu, wysokość obrazu. Jednostka: Piksele |
|
image_width
|
result.image_width | string |
Jeśli plik obrazu, szerokość obrazu. Jednostka: Piksele |
|
size_bytes
|
result.size_bytes | string |
Rozmiar załącznika. Jednostka: bajty |
|
size_compressed
|
result.size_compressed | string |
Rozmiar załącznika. Jednostka: bajty |
|
sys_created_by
|
result.sys_created_by | string |
Jednostka, która pierwotnie utworzyła plik załącznika. |
|
sys_created_on
|
result.sys_created_on | string |
Data i godzina początkowego zapisania pliku załącznika w wystąpieniu. |
|
sys_id
|
result.sys_id | string |
Sys_id pliku załącznika. |
|
sys_mod_count
|
result.sys_mod_count | string |
Liczba modyfikacji pliku załącznika (przekazanego do wystąpienia). |
|
sys_tags
|
result.sys_tags | string |
Wszystkie tagi systemowe skojarzone z plikiem załącznika. |
|
sys_updated_by
|
result.sys_updated_by | string |
Wszystkie tagi systemowe skojarzone z plikiem załącznika. |
|
sys_updated_on
|
result.sys_updated_on | string |
Data i godzina ostatniej aktualizacji pliku załącznika. |
|
table_name
|
result.table_name | string |
Nazwa tabeli, z którą jest skojarzony załącznik. |
|
table_sys_id
|
result.table_sys_id | string |
Sys_id tabeli skojarzonej z załącznikiem. |
|
updated_by_name
|
result.updated_by_name | string |
Pełna nazwa jednostki, która ostatnio zaktualizowała plik załącznika. |
GetTypesResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wynik
|
result | array of object |
Zestaw wyników wszystkich typów rekordów dla bieżącego wystąpienia. |
|
nazwa wyświetlana
|
result.label | string |
Nazwa wyświetlana typu rekordu. |
|
Wartość
|
result.value | string |
Wartość typu rekordu. |
|
Total
|
meta.total | integer |
Liczba pasujących typów rekordów. |
|
Przesunięcie
|
meta.offset | integer |
Liczba pominiętych dopasowań. |
|
Ograniczenie
|
meta.limit | integer |
Używany rozmiar strony. |
|
Ma więcej
|
meta.hasMore | boolean |
Wartość true, gdy więcej dopasowań następuje po tej stronie. |
GetCatalogsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wynik
|
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 | |
|
opis
|
result.description | string | |
|
desktop_image
|
result.desktop_image | string |
GetCatalogCategoriesResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wynik
|
result | array of object | |
|
title
|
result.title | string | |
|
opis
|
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 | |
|
Podkategorie
|
result.subcategories | array of object | |
|
sys_id
|
result.subcategories.sys_id | string | |
|
title
|
result.subcategories.title | string | |
|
sys_id
|
result.sys_id | string |
GetCatalogItemsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wynik
|
result | array of object | |
|
short_description
|
result.short_description | string | |
|
kb_article
|
result.kb_article | string | |
|
icon
|
result.icon | string | |
|
opis
|
result.description | string | |
|
availability
|
result.availability | string | |
|
mandatory_attachment
|
result.mandatory_attachment | boolean | |
|
request_method
|
result.request_method | string | |
|
typ
|
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 | |
|
cena
|
result.price | string | |
|
recurring_frequency
|
result.recurring_frequency | string | |
|
price_currency
|
result.price_currency | string | |
|
porządek
|
result.order | integer | |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean | |
|
właściciel
|
result.owner | string | |
|
show_price
|
result.show_price | boolean | |
|
recurring_price
|
result.recurring_price | string | |
|
show_quantity
|
result.show_quantity | boolean | |
|
obraz
|
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 | |
|
aktywny
|
result.catalogs.active | boolean | |
|
title
|
result.catalogs.title | string | |
|
nazwa
|
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
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
short_description
|
result.short_description | string |
short_description |
|
kb_article
|
result.kb_article | string |
kb_article |
|
icon
|
result.icon | string |
icon |
|
opis
|
result.description | string |
opis |
|
availability
|
result.availability | string |
availability |
|
mandatory_attachment
|
result.mandatory_attachment | boolean |
mandatory_attachment |
|
request_method
|
result.request_method | string |
request_method |
|
typ
|
result.type | string |
typ |
|
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 |
|
porządek
|
result.order | integer |
porządek |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean |
make_item_non_conversational |
|
właściciel
|
result.owner | string |
właściciel |
|
show_price
|
result.show_price | boolean |
show_price |
|
show_quantity
|
result.show_quantity | boolean |
show_quantity |
|
obraz
|
result.picture | string |
obraz |
|
URL
|
result.url | string |
URL |
|
catalogs
|
result.catalogs | array of object |
catalogs |
|
sys_id
|
result.catalogs.sys_id | string |
sys_id |
|
aktywny
|
result.catalogs.active | boolean |
aktywny |
|
title
|
result.catalogs.title | string |
title |
|
nazwa
|
result.name | string |
nazwa |
|
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 |
|
aktywny
|
result.categories.active | boolean |
aktywny |
|
sys_id
|
result.categories.category.sys_id | string |
sys_id |
|
aktywny
|
result.categories.category.active | boolean |
aktywny |
|
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
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
sys_id
|
result.sys_id | string |
sys_id |
|
Liczba
|
result.number | string |
Liczba |
|
request_number
|
result.request_number | string |
request_number |
|
identyfikator_żądania
|
result.request_id | string |
identyfikator_żądania |
|
tabela
|
result.table | string |
tabela |
GetArticlesResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ
|
meta.type | string |
Zawsze "obiekt" |
|
Liczba
|
meta.properties.count | integer |
Liczba dostępnych artykułów bazy wiedzy |
|
Koniec
|
meta.properties.end | integer |
Końcowy indeks zestawu wyników |
|
Pola formularza
|
meta.properties.fields | string |
Pola w artykule |
|
Filter
|
meta.properties.filter | string |
Filtr używany do uzyskiwania danych |
|
Baza wiedzy
|
meta.properties.kb | string |
Lista artykułów z bazy wiedzy sys_ids |
|
Język
|
meta.properties.language | string |
Lista języków rozdzielanych przecinkami artykułów bazy wiedzy, które zostały żądane |
|
Query
|
meta.properties.query | string |
Określone zapytanie żądania |
|
Start
|
meta.properties.start | integer |
Początkowy indeks zestawu wyników |
|
Status
|
meta.properties.status.code | integer |
Stan połączenia |
|
Identyfikator kwerendy wyszukiwania tekstu
|
meta.properties.ts_query_id | string |
Identyfikator zapytania wyszukiwania tekstu |
|
Artykuły
|
articles | array of object | |
|
Pola formularza
|
articles.fields | object |
Żądane pola, kluczowane według nazwy pola |
|
id
|
articles.id | string |
Artykuł merytoryczny sys_id z tabeli Knowledge [kb_knowledge] |
|
Number
|
articles.number | string |
Numer artykułu merytorycznego |
|
Ranga
|
articles.rank | float |
Ranga wyszukiwania artykułów specyficznych dla tego wyszukiwania |
|
Score
|
articles.score | float |
Wynik trafności, wyniki posortowane w kolejności malejącej według wyniku |
|
Fragment
|
articles.snippet | string |
Tekst przedstawiający niewielką część artykułu merytorycznego |
|
Title
|
articles.title | string |
Krótki opis lub tytuł artykułu merytorycznego |
|
Link
|
articles.link | string |
Link do artykułu |