ServiceNow

ServiceNow улучшает уровни обслуживания, активизирует сотрудников и позволяет вашей организации работать на лампочках. Создание, чтение и обновление записей, хранящихся в ServiceNow, включая инциденты, вопросы, пользователи и многое другое.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     — Облако Китая, управляемое 21Vianet
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     — Облако Китая, управляемое 21Vianet
Power Automate Премия Все регионы Power Automate , кроме следующих:
     — Облако Китая, управляемое 21Vianet
Контакт
Имя Microsoft
URL https://learn.microsoft.com/connectors/service-now/
Метаданные соединителя
Publisher Microsoft
Website https://www.servicenow.com/
Политика конфиденциальности https://www.servicenow.com/privacy-statement.html
Категории Website

Замечание

Операция получения статей знаний может использоваться только при активации подключаемого модуля API знаний (sn_km_api).

Известные проблемы и ограничения

  1. При использовании действия "Создать запись " невозможно указать полное описание записи. Значение поля будет игнорироваться из-за ограничений REST API Service-Now.

  2. Действие Get Records может возвращать ошибку "Недопустимая таблица" или другую ошибку в Power Apps. Для реализации Power Apps рекомендуемая работа — использовать действие Get Records в Power Automate и передать данные обратно в Power Apps.

  3. В настоящее время соединитель поддерживает только URL-адреса экземпляров, заканчивающиеся "service-now.com". Использование альтернативных доменов, таких как "servicenowservices.com", может привести к ошибкам подключения. В таких случаях, особенно при работе с новым доменом ServiceNow в GCC, рекомендуется использовать обычную проверку подлинности.

  4. Если возникла ошибка всплывающего окна с сообщением "Недопустимый redirect_uri", скопируйте полный URL-адрес из всплывающего окна и извлеките параметр redirect_uri (например, redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect). После декодирования URL-адреса (замены %3a на : и %2f с /), обновите поле URL-адреса перенаправления в реестре приложений OAuth экземпляра ServiceNow, как показано на рисунке ниже. Затем попробуйте повторно добавить подключение.

Проблема с созданием подключения

Настройка подключения ServiceNow Power Platform, использующего идентификатор Microsoft Entra

Существует два типа подключения:

  1. Идентификатор Microsoft Entra ID OAuth с помощью сертификата: это тип проверки подлинности на основе маркера приложения, в котором приложение, зарегистрированное в идентификаторе Entra, можно использовать для доступа к ServiceNow, получив маркер с набором ресурсов в качестве приложения идентификатора записи ServiceNow.

  2. Идентификатор Microsoft Entra ID OAuth с помощью имени входа пользователя. Это тип проверки подлинности на основе маркера пользователя, в котором конечный пользователь может войти в приложение Entra ID 1P (приложение ServiceNow Connector 1p) и получить маркер доступа с заданным областью для приложения ServiceNow для приложения идентификатора записи.

Действия по созданию подключения OAuth идентификатора Microsoft Entra с помощью сертификата

Шаг 1. Регистрация приложения A в идентификаторе Microsoft Entra для интеграции OIDC с ServiceNow. Это приложение Идентификатора участника ServiceNow.

  • Перейдите к регистрации > приложений, чтобы создать регистрацию нового приложения

    • Имя: любое имя выбора

    • URI перенаправления: не требуется

  • aud Добавьте emailи upn к утверждениям в разделе "Необязательные утверждения"

Создание регистрации приложений

Настройка необязательных утверждений

Шаг 2. Регистрация того же идентификатора, что и поставщик OIDC в ServiceNow

  • Перейдите к System OAuth > Application Registry > New > Configure an OIDC provider проверке маркеров идентификатора

    • Имя: любое имя выбора
    • Идентификатор клиента: приложение A, client ID созданное на шаге 1
    • Секрет клиента: это не будет использоваться, любое значение можно задать.

  • В форме регистрации поставщика OIDC добавьте новую конфигурацию поставщика OIDC. Щелкните значок поиска в поле конфигурации поставщика OAuth OIDC , чтобы открыть записи конфигураций OIDC, нажмите кнопку "Создать".

    • Поставщик OIDC: идентификатор Microsoft Entra
    • URL-адрес метаданных OIDC: URL-адрес должен находиться в форме https://login.microsoftonline.com/<tenantID>/.well-known/openid-configuration, заменить tenantID на Directory (tenant) ID
    • Срок жизни кэша конфигурации OIDC: 120
    • Приложение: глобальный
    • Утверждение пользователя: oid
    • Поле пользователя: идентификатор пользователя
    • Включение проверки утверждений JTI: отключено

  • Выберите "Отправить" и обновите форму сущности OAuth OIDC

Настройка поставщика OIDC

Шаг 3. Регистрация приложения B в идентификаторе Microsoft Entra для использования соединителя. Это приложение, которое играет роль пользователя с повышенными разрешениями в экземпляре ServiceNow

  • Перейдите к созданию Регистрация приложений > New registration нового приложения

    • Имя: любое имя выбора
    • В сертификатах и секретах отправьте файл .cer сертификата в случае сертификата SNI, просто добавьте trustedCertificateSubjects в манифест приложения с соответствующим authorityId и subjectName

Шаг 4. Создание системного пользователя в ServiceNow. Это приложение B в качестве пользователя в экземпляре ServiceNow

  • Перейдите к созданию User Administration > Users нового пользователя

    • Идентификатор пользователя: идентификатор объекта субъекта-службы приложения B, созданного на шаге 3.
    • Проверьте Web service access only

Шаг 5. Подключение с помощью соединителя — Copilot Studio — конфигурация соединителя

  • Настройте соединитель со следующими сведениями и подключитесь:

    • Имя экземпляра: имя экземпляра ServiceNow
    • Идентификатор клиента: идентификатор клиента Microsoft Entra
    • Идентификатор клиента: идентификатор клиента "Application B", созданный на шаге 3.
    • URI ресурса: идентификатор клиента "Application A", созданный на шаге 1 (а не URI приложения)
    • Секрет сертификата клиента: PFX-файл сертификата, созданный на шаге 3.
    • Пароль сертификата: пароль PFX-файла

Действия по созданию имени входа пользователя OAuth в Microsoft Entra ID

Чтобы настроить подключение для входа пользователя OAuth в microsoft entra ID, выполните шаг 1 и шаг 2, как описано в разделе проверки подлинности сертификата выше.

Шаг 1 остается неизменным. На шаге 2 обновите утверждение пользователя до имени участника-пользователя или пользовательского свойства утверждения из маркера (для сторонних поставщиков удостоверений, отличных от Entra) в ServiceNow. Поле пользователя должно соответствовать полю таблицы пользователей системы ServiceNow, содержащей имя участника-пользователя или идентификатор пользователя.

Настройка входа OAuth

Шаги 3 и 4 из приведенного выше раздела проверки подлинности сертификата не требуются. Вместо этого "Application B" в этом случае является приложением 1p, которое создается для соединителя ServiceNow. Приведенное ниже приложение должно быть предоставлено разрешения в приложении A.

Идентификатор приложения B: c26b24aa-7874-4e06-ad55-7d06b1f79b63

Это важно

В этом сценарии "Application B" должен использовать идентификатор c26b24aa-7874-4e06-ad55-7d06b1f79b63 , который является предварительно существующим приложением 1p, принадлежащим корпорации Майкрософт, а не созданному пользователем приложению (как это необходимо для создания подключения OAuth от OAuth microsoft Entra ID с помощью сертификата).

Предоставление разрешений приложений

При создании подключения для соединителя ServiceNow пользователь должен выбрать "Имя пользователя идентификатора Записи Майкрософт" в качестве типа проверки подлинности и указать только имя экземпляра ServiceNow и идентификатор ресурса (который будет идентификатором приложения A). После этого кнопка входа будет принимать пользователя через имя входа Записи с помощью собственной учетной записи.

Тип проверки подлинности для входа

Использование поставщика удостоверений стороннего поставщика удостоверений или несоответствия данных между пользователем в идентификаторе Записи и таблицей пользователей ServiceNow

  • Если существует несоответствие между свойством идентификатора пользователя в маркере идентификатора Записи и значением идентификатора пользователя, которое находится в таблице ServiceNow
    • Например, маркер содержит полный upn (вместе с доменом) abc@contoso.comи таблицу пользователей ServiceNow только содержит идентификатор пользователя (abc). Рекомендуется добавить пользовательский атрибут в маркер, содержащий значение, которое соответствует идентификатору пользователя в идентификаторе ServiceNow, применяя формулу, а затем использовать это новое свойство для сопоставления утверждений на шаге 2.
    • Документация Microsoft Learn, описывающая процесс добавления нового свойства утверждения: https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token

Настройка подключения ServiceNow Power Platform, использующего идентификатор Microsoft Entra ID.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
Обычная проверка подлинности Вход с помощью базовой проверки подлинности Все регионы Недоступен для совместного использования
Идентификатор Microsoft Entra ID OAuth с помощью сертификата OAuth с идентификатором Microsoft Entra с помощью сертификата PFX. Только POWERPLATFORM Доступный для общего пользования
Имя пользователя идентификатора записи Майкрософт Вход с помощью учетных данных идентификатора Microsoft Entra Все регионы Недоступен для совместного использования
Использование Oauth2 Вход с помощью Oauth2 Все регионы Недоступен для совместного использования
По умолчанию [не рекомендуется] Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. Все регионы Недоступен для совместного использования

Обычная проверка подлинности

Идентификатор проверки подлинности: basicAuthentication

Применимо: все регионы

Вход с помощью базовой проверки подлинности

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Экземпляр струна Имя экземпляра для service-now.com или пользовательского URL-адреса для перенесенной учетной записи True
Имя пользователя струна Имя пользователя для этого экземпляра True
Пароль securestring Пароль для этой учетной записи True

Microsoft Entra идентификатор OAuth с помощью сертификата

Идентификатор проверки подлинности: aadOAuthCert

Применимо: только POWERPLATFORM

OAuth с идентификатором Microsoft Entra с помощью сертификата PFX.

Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт

Имя Тип Description Обязательно
Имя экземпляра струна Имя экземпляра, используемое для идентификации URl сайта ServiceNow True
Идентификатор арендатора струна True
Идентификатор клиента струна True
Универсальный код ресурса (URI) струна True
Секрет сертификата клиента клиентский сертификат Секрет сертификата клиента, разрешенный этим приложением True

Имя пользователя идентификатора записи Майкрософт

Идентификатор проверки подлинности: entraIDUserLogin

Применимо: все регионы

Вход с помощью учетных данных идентификатора Microsoft Entra

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Универсальный код ресурса (URI) струна True
Имя экземпляра струна Имя экземпляра, используемое для идентификации URL-адреса сайта ServiceNow True

Использование Oauth2

Идентификатор проверки подлинности: oauth2ServiceNow

Применимо: все регионы

Вход с помощью Oauth2

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Имя экземпляра струна Имя экземпляра, используемое для идентификации URl сайта ServiceNow True
Идентификатор клиента струна Идентификатор, используемый для идентификации этого приложения с поставщиком услуг True
Секрет клиента securestring Общий секрет, используемый для проверки подлинности этого приложения с помощью поставщика услуг True

По умолчанию [не рекомендуется]

Применимо: все регионы

Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Экземпляр струна Имя экземпляра для service-now.com или пользовательского URL-адреса для перенесенной учетной записи True
Имя пользователя струна Имя пользователя для этого экземпляра True
Пароль securestring Пароль для этой учетной записи True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 600 60 секунд

Действия

Обновление записи

Обновляет запись для типа объекта ServiceNow, например "Инциденты"
Отправка двоичного файла в виде вложения

Отправляет двоичный файл в виде вложения в указанную запись.
Отправка многопартийного вложения файла

Отправка вложения из многопартийной формы
Получение записи

Возвращает запись для типа объекта ServiceNow, например "Инциденты"
Получение каталогов

Извлекает список каталогов
Получение категорий каталога

Извлекает список категорий для определенного каталога
Получение метаданных вложений

Получение метаданных для вложений
Получение метаданных вложения

Получение метаданных вложения
Получение содержимого вложения

Получение содержимого вложения
Получение статей знаний

Возвращает список статей базы знаний (КБ), которые можно искать и фильтровать.
Получение статьи о знании

Возвращает полное содержимое одной статьи базы знаний (КБ), включая содержимое раздела шаблона илиKnowledge-Block, которое не возвращается конечной точкой поиска "Статьи знаний".
Получение типов записей

Список доступных типов записей
Получение элемента каталога

Получение определенного элемента каталога.
Получение элементов каталога

Извлекает список элементов каталога на основе указанных параметров, таких как текст поиска или каталог.
Создание записи

Создайте запись в таблице ServiceNow.
Список записей

Возвращает записи определенного типа объекта ServiceNow, например "Инциденты"
Удаление вложения

Удаление вложения
Удаление записи

Удаляет запись для типа объекта ServiceNow, например "Инциденты"
Элемент заказа

Заказы или покупка определенного элемента каталога.

Обновление записи

Идентификатор операции:
UpdateRecord

Обновляет запись для типа объекта ServiceNow, например "Инциденты"

Параметры

Имя Ключ Обязательно Тип Описание
Тип записи
 tableType True string

Тип записи для списка
Идентификатор системы
 sysid True string

Системный идентификатор записи.
body
 body True dynamic
Отображение системных ссылок
 sysparm_display_value boolean

Определяет, следует ли включать системные ссылки
Отображение ссылок на систему ввода
 sysparm_input_display_value boolean

Определяет, обрабатываются ли входные значения как отображаемые значения (true) или необработанные или внутренние значения (false). Если значение true, API интерпретирует значения полей в тексте запроса в виде отображаемых значений (например, "Разрешено" для состояния) и сопоставляет их с внутренними значениями.
Исключение ссылок
 sysparm_exclude_reference_link boolean

Определяет, следует ли исключить ссылки
Fields
 sysparm_fields string

Разделенный запятыми список возвращаемых полей. Пример: имя,электронная почта,телефон

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Отправка двоичного файла в виде вложения

Идентификатор операции:
UploadAttachmentFile

Отправляет двоичный файл в виде вложения в указанную запись.

Параметры

Имя Ключ Обязательно Тип Описание
Имя таблицы
 table_name True string

Имя таблицы, к которой требуется присоединить файл
Идентификатор sys
 table_sys_id True string

Sys_id записи в указанной таблице, к которой требуется присоединить файл
Имя файла
 file_name True string

Имя для предоставления вложения
Файл
 file True binary

Двоичный файл для подключения к указанной записи

Возвращаемое значение

Тело
UploadAttachmentResponse

Отправка многопартийного вложения файла

Идентификатор операции:
UploadAttachment

Отправка вложения из многопартийной формы

Параметры

Имя Ключ Обязательно Тип Описание
Содержимое вложения
 attachment_content True file

Вложение для отправки
Имя таблицы
 table_name True string

Имя таблицы, к которой требуется присоединить файл.
Идентификатор таблицы
 table_sys_id True string

Sys_id записи в указанной таблице, к которой требуется присоединить файл

Возвращаемое значение

Тело
UploadAttachmentResponse

Получение записи

Идентификатор операции:
GetRecord

Возвращает запись для типа объекта ServiceNow, например "Инциденты"

Параметры

Имя Ключ Обязательно Тип Описание
Тип записи
 tableType True string

Тип записи для списка
Идентификатор системы
 sysid True string

Системный идентификатор записи.
Отображение системных ссылок
 sysparm_display_value boolean

Определяет, следует ли включать системные ссылки
Исключение ссылок
 sysparm_exclude_reference_link boolean

Определяет, следует ли исключить ссылки
Fields
 sysparm_fields string

Разделенный запятыми список возвращаемых полей. Пример: имя,электронная почта,телефон

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение каталогов

Идентификатор операции:
GetCatalogs

Извлекает список каталогов

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 sysparm_limit integer

Количество извлекаемых каталогов
Поиск текста
 sysparm_text string

Поиск текста для фильтрации каталогов по имени или описанию

Возвращаемое значение

Тело
GetCatalogsResponse

Получение категорий каталога

Идентификатор операции:
GetCatalogCategories

Извлекает список категорий для определенного каталога

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор каталога
 catalogId True string

Идентификатор каталога, для которого требуется получить категории
Лимит
 sysparm_limit integer

Количество категорий каталога для получения
Смещение
 sysparm_offset integer

Смещение для запроса

Возвращаемое значение

Тело
GetCatalogCategoriesResponse

Получение метаданных вложений

Идентификатор операции:
GetAttachmentMetdata

Получение метаданных для вложений

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 sysparm_limit string

Ограничение, применяемое к разбивке на страницы. Примечание. Необычно большие значения sysparm_limit могут повлиять на производительность системы. Значение по умолчанию: 1000
Смещение
 sysparm_offset string

Количество записей, которые следует исключить из запроса. Используйте этот параметр, чтобы получить больше записей, чем указано в sysparm_limit. Например, если для sysparm_limit задано значение 500, но есть дополнительные записи, которые требуется запросить, можно указать значение sysparm_offset 500, чтобы получить второй набор записей. По умолчанию: 0
Query
 sysparm_query string

Закодированный запрос. Запросы к API вложений относятся к таблице вложения [sys_attachment]. Например: (sysparm_query=file_name=attachment.doc)

Получение метаданных вложения

Идентификатор операции:
RetrieveAttachmentMetadata

Получение метаданных вложения

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 sys_id True string

Sys_id вложения для получения метаданных

Получение содержимого вложения

Идентификатор операции:
RetrieveAttachmentContent

Получение содержимого вложения

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор sys
 sys_id True string

Sys_id вложения для получения содержимого

Получение статей знаний

Идентификатор операции:
GetKnowledgeArticles

Возвращает список статей базы знаний (КБ), которые можно искать и фильтровать.

Параметры

Имя Ключ Обязательно Тип Описание
Fields
 fields string

Разделенный запятыми список полей из таблицы знаний.
Лимит
 limit integer

Максимальное количество возвращаемых записей.
Query
 query True string

Текст для поиска.
Filter
 filter string

Закодированный запрос, используемый для фильтрации результирующий набор.
Бз
 kb string

Разделенный запятыми список sys_ids базы знаний.

Возвращаемое значение

Тело
GetArticlesResponse

Получение статьи о знании

Идентификатор операции:
GetKnowledgeArticle

Возвращает полное содержимое одной статьи базы знаний (КБ), включая содержимое раздела шаблона илиKnowledge-Block, которое не возвращается конечной точкой поиска "Статьи знаний".

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор sys статьи
 articleSysId True string

Номер sys_id или базы знаний для получения.
Fields
 fields string

Разделенный запятыми список полей из таблицы знаний для возврата.
Language
 language string

Разделенный запятыми список языков статьи базы знаний для возврата.

Возвращаемое значение

Тело
GetArticleResponse

Получение типов записей

Идентификатор операции:
GetRecordTypes

Список доступных типов записей

Возвращаемое значение

Тело
GetTypesResponse

Получение элемента каталога

Идентификатор операции:
GetCatalogItem

Получение определенного элемента каталога.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор элемента
 sys_id True string

Sys_id элемента каталога для получения

Возвращаемое значение

Тело
GetCatalogItemResponse

Получение элементов каталога

Идентификатор операции:
GetCatalogItems

Извлекает список элементов каталога на основе указанных параметров, таких как текст поиска или каталог.

Параметры

Имя Ключ Обязательно Тип Описание
Категория
 sysparm_category string

Идентификатор категории для фильтрации элементов по. Если он не указан, возвращаются все элементы.
Лимит
 sysparm_limit True integer

Количество элементов каталога для извлечения
Поиск текста
 sysparm_text string

Поиск текста для фильтрации элементов по
Catalog
 sysparm_catalog string

Идентификатор каталога для фильтрации элементов. Если не указано, возвращаются элементы из всех каталогов.

Возвращаемое значение

Тело
GetCatalogItemsResponse

Создание записи

Идентификатор операции:
CreateRecord

Создайте запись в таблице ServiceNow.

Параметры

Имя Ключ Обязательно Тип Описание
Тип записи
 tableType True string

Тип записи для списка
body
 body True dynamic
Отображение системных ссылок
 sysparm_display_value boolean

Определяет, следует ли включать системные ссылки
Отображение ссылок на систему ввода
 sysparm_input_display_value boolean

Определяет, обрабатываются ли входные значения как отображаемые значения (true) или необработанные или внутренние значения (false). Если значение true, API интерпретирует значения полей в тексте запроса в виде отображаемых значений (например, "Разрешено" для состояния) и сопоставляет их с внутренними значениями.
Исключение ссылок
 sysparm_exclude_reference_link boolean

Определяет, следует ли исключить ссылки
Fields
 sysparm_fields string

Разделенный запятыми список возвращаемых полей. Пример: имя,электронная почта,телефон

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Список записей

Идентификатор операции:
GetRecords

Возвращает записи определенного типа объекта ServiceNow, например "Инциденты"

Параметры

Имя Ключ Обязательно Тип Описание
Тип записи
 tableType True string

Тип записи для списка
Отображение системных ссылок
 sysparm_display_value boolean

Определяет, следует ли включать системные ссылки
Исключение ссылок
 sysparm_exclude_reference_link boolean

Определяет, следует ли исключить ссылки
Query
 sysparm_query string

Закодированный запрос, используемый для фильтрации результирующий набор. Пример: active=true^ORDERBYnumber^ORDERBYDESCcategory
Лимит
 sysparm_limit integer

Ограничение, применяемое к разбивке на страницы. Значение по умолчанию — 10000.
Смещение
 sysparm_offset integer

Количество записей, которые следует исключить из запроса.
Fields
 sysparm_fields string

Разделенный запятыми список возвращаемых полей. Пример: имя,электронная почта,телефон

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Удаление вложения

Идентификатор операции:
DeleteAttachment

Удаление вложения

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор sys
 sys_id True string

Sys_id вложения для удаления

Удаление записи

Идентификатор операции:
DeleteRecord

Удаляет запись для типа объекта ServiceNow, например "Инциденты"

Параметры

Имя Ключ Обязательно Тип Описание
Тип записи
 tableType True string

Тип записи для списка
Идентификатор системы
 sysid True string

Системный идентификатор записи.

Элемент заказа

Идентификатор операции:
OrderItem

Заказы или покупка определенного элемента каталога.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор элемента
 sys_id True string

Sys_id элемента каталога для заказа
Текст элемента заказа
 body True dynamic

Текст запроса элемента заказа. Он содержит количество, запрашиваемый пользователем и любые дополнительные переменные, необходимые элементу каталога.

Возвращаемое значение

Тело
OrderItemResponse

Определения

GetArticleResponse

Имя Путь Тип Описание
Number
 result.number string

Номер базы знаний статьи.
Идентификатор sys
 result.sys_id string

Sys_id статьи.
Краткое описание
 result.short_description string

Краткое описание (название) статьи.
Текст
 result.text string

Текст стандартных статей о поле тела. Пусто для статей шаблона илиKnowledge-Block, текст которого возвращается в содержимом.
Template
 result.template boolean

Значение true, если статья является шаблоном илиKnowledge-Block статьей, текст которой возвращается в содержимом.
Таблица шаблонов
 result.template_table string

Таблица шаблонов, резервная копия статьи шаблона (например, kb_template_how_to).
Language
 result.language string

Язык возвращаемой статьи.
Content
 result.content array of object

Собранные разделы шаблонов для статей о шаблонах илиKnowledge-Block.
Этикетка
 result.content.label string

Отображаемая метка раздела шаблона.
Column
 result.content.column string

Столбец шаблона, который поддерживает раздел.
Тип
 result.content.type string

Тип контента раздела (например html).
Content
 result.content.content string

Текст раздела.

UploadAttachmentResponse

Имя Путь Тип Описание
average_image_color
 result.average_image_color string

Если вложение является изображением, сумма всех цветов.
сжатый
 result.compressed string

Флаг, указывающий, был ли сжатый файл вложения.
content_type
 result.content_type string

Тип содержимого связанного файла вложения, например image или jpeg или application/x-shockwave-flash.
created_by_name
 result.created_by_name string

Полное имя сущности, которая изначально создала файл вложения.
download_link
 result.download_link string

Скачайте URL-адрес вложения в экземпляре ServiceNow.
file_name
 result.file_name string

Имя файла вложения.
image_height
 result.image_height string

Если файл изображения, высота изображения. Единица: пиксели
image_width
 result.image_width string

Если файл изображения, ширина изображения. Единица: пиксели
size_bytes
 result.size_bytes string

Размер вложения. Единица: байты
size_compressed
 result.size_compressed string

Размер вложения. Единица: байты
sys_created_by
 result.sys_created_by string

Сущность, которая изначально создала файл вложения.
sys_created_on
 result.sys_created_on string

Дата и время первоначального сохранения файла вложения в экземпляре.
sys_id
 result.sys_id string

Sys_id файла вложения.
sys_mod_count
 result.sys_mod_count string

Количество изменений файла вложения (отправлено в экземпляр).
sys_tags
 result.sys_tags string

Любые системные теги, связанные с файлом вложения.
sys_updated_by
 result.sys_updated_by string

Любые системные теги, связанные с файлом вложения.
sys_updated_on
 result.sys_updated_on string

Дата и время последнего обновления файла вложения.
table_name
 result.table_name string

Имя таблицы, к которой связано вложение.
table_sys_id
 result.table_sys_id string

Sys_id таблицы, связанной с вложением.
updated_by_name
 result.updated_by_name string

Полное имя сущности, которая в последний раз обновила файл вложения.

GetTypesResponse

Имя Путь Тип Описание
результат
 result array of object

Результирующий набор всех типов записей для текущего экземпляра.
Показать имя
 result.label string

Отображаемое имя типа записи.
Ценность
 result.value string

Значение типа записи.

GetCatalogsResponse

Имя Путь Тип Описание
результат
 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
описание
 result.description string
desktop_image
 result.desktop_image string

GetCatalogCategoriesResponse

Имя Путь Тип Описание
результат
 result array of object
title
 result.title string
описание
 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
Подкатегории
 result.subcategories array of object
sys_id
 result.subcategories.sys_id string
title
 result.subcategories.title string
sys_id
 result.sys_id string

GetCatalogItemsResponse

Имя Путь Тип Описание
результат
 result array of object
short_description
 result.short_description string
kb_article
 result.kb_article string
icon
 result.icon string
описание
 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
цена
 result.price string
recurring_frequency
 result.recurring_frequency string
price_currency
 result.price_currency string
заказ
 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
картина
 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
активный
 result.catalogs.active boolean
title
 result.catalogs.title string
имя
 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

Имя Путь Тип Описание
short_description
 result.short_description string

short_description
kb_article
 result.kb_article string

kb_article
icon
 result.icon string

icon
описание
 result.description string

описание
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
заказ
 result.order integer

заказ
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
картина
 result.picture string

картина
URL-адрес
 result.url string

URL-адрес
catalogs
 result.catalogs array of object

catalogs
sys_id
 result.catalogs.sys_id string

sys_id
активный
 result.catalogs.active boolean

активный
title
 result.catalogs.title string

title
имя
 result.name string

имя
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
активный
 result.categories.active boolean

активный
sys_id
 result.categories.category.sys_id string

sys_id
активный
 result.categories.category.active boolean

активный
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
переменныеSchema
 result.variablesSchema object

OrderItemResponse

Имя Путь Тип Описание
sys_id
 result.sys_id string

sys_id
число/номер
 result.number string

число/номер
request_number
 result.request_number string

request_number
идентификатор запроса
 result.request_id string

идентификатор запроса
table
 result.table string

table

GetArticlesResponse

Имя Путь Тип Описание
Численность
 meta.count integer

Количество доступных статей базы знаний
Конец
 meta.end integer

Конечный индекс результирующий набор
Fields
 meta.fields string

Поля в статье
Filter
 meta.filter string

Фильтр, используемый для получения данных
Бз
 meta.kb string

Список статей базы знаний sys_ids
Language
 meta.language string

Список языков с разделиемыми запятыми статей базы знаний, запрошенных
Query
 meta.query string

Указанный запрос запроса
Start
 meta.start string

Начальный индекс результирующий набор
Состояние
 meta.status.code string

Состояние вызова
Бз
 meta.ts_query_id string

Список языков с разделиемыми запятыми статей базы знаний, запрошенных
articles
 articles array of object
Отображаемое значение
 articles.fields.display_value string

Отображаемое значение запрошенного поля
Этикетка
 articles.fields.label string

Метка, представляющая запрошенный поле
Имя
 articles.fields.name string

Имя запрошенного поля
Тип
 articles.fields.type string

Тип данных запрошенного поля
Ценность
 articles.fields.value string

Значение запрошенного поля
Link
 articles.Link string

Ссылка на статью
id
 articles.id string

Статья базы знаний sys_id из таблицы "Знания " [kb_knowledge]
Number
 articles.number string

Статья базы знаний sys_id из таблицы "Знания " [kb_knowledge]
Ранг
 articles.rank float

Ранг поиска статьи, относящемся к этому поиску
Балл
 articles.score float

Оценка Relevancy, результаты, отсортированные в порядке убывания по оценке
Обрезок
 articles.snippet string

Текст, показывающий небольшую часть статьи знаний
Название
 articles.title string

Краткое описание или название статьи знаний