次の方法で共有


ServiceNow

ServiceNow は、サービス レベルを向上させ、従業員を活性化させ、企業がライトスピードで作業できるようにします。 インシデント、質問、ユーザーなど、ServiceNow 内に格納されているレコードを作成、読み取り、更新します。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 21Vianet が運営する China Cloud
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 21Vianet が運営する China Cloud
Power Automate Premium 次を除くすべての Power Automate リージョン :
     - 21Vianet が運営する China Cloud
お問い合わせ
名前 Microsoft
URL https://learn.microsoft.com/connectors/service-now/
コネクタ メタデータ
Publisher Microsoft
Website https://www.servicenow.com/
プライバシー ポリシー https://www.servicenow.com/privacy-statement.html
カテゴリ Website

ナレッジ記事の取得操作は、 Knowledge API (sn_km_api) プラグインがアクティブ化されている場合にのみ使用できます。

既知の問題と制限事項

  1. [レコードの作成] アクションを使用する場合、レコードの完全な説明を指定することはできません。 Service-Now REST API の制限により、フィールド値は無視されます。

  2. レコードの取得アクションは、Power Apps で "無効なテーブル" またはその他のエラーを返す場合があります。 Power Apps の実装の場合、推奨される回避策は、Power Automate でレコードの取得アクションを利用し、データを Power Apps に渡すことです。

  3. コネクタは現在、"service-now.com" で終わるインスタンス URL のみをサポートしています。 "servicenowservices.com" などの代替ドメインを使用すると、接続エラーが発生する可能性があります。 このような場合 (特に GCC で新しい ServiceNow ドメインを使用する場合) は、基本認証を使用することをお勧めします。

  4. "Invalid redirect_uri" というポップアップ エラーが発生した場合は、ポップアップ ウィンドウから完全な URL をコピーし、redirect_uri パラメーター (例: redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect) を抽出します。 URL をデコードした後 (%3a を : に置き換え、%2f を /に置き換えた後、次の図に示すように、ServiceNow インスタンスの OAuth アプリ レジストリのリダイレクト URL フィールドを更新します。 次に、接続を再追加してみてください。

接続の作成に関する問題

Microsoft Entra ID を使用する ServiceNow Power Platform 接続を設定する方法

接続の種類は 2 つあります。

  1. 証明書を使用した Microsoft Entra ID OAuth: これは、Entra ID に登録されているアプリケーションを使用して ServiceNow の代表的な Entra ID アプリとして設定されたリソースを持つトークンを取得することで、ServiceNow にアクセスできるアプリ トークン ベースの認証の種類です。

  2. ユーザー ログインを使用した Microsoft Entra ID OAuth: これは、エンド ユーザーが Entra ID 1P アプリケーション (ServiceNow Connector 1p アプリ) にサインインし、ServiceNow の代表的な Entra ID アプリのスコープ が設定されたアクセス トークンを取得できる、ユーザー トークン ベースの認証の種類です。

証明書を使用して Microsoft Entra ID OAuth 接続を作成する手順

手順 1: OIDC と ServiceNow の統合のために、Microsoft Entra ID に "アプリケーション A" を登録します。 これは ServiceNow の代表的な Entra ID アプリケーションです。

  • [アプリの登録] > [新しい登録] に移動して、新しいアプリケーション登録を作成します

    • 名前: 任意の名前

    • リダイレクト URI: 必須ではありません

  • [省略可能な要求] の下の要求に audemailupn を追加する

アプリケーション登録の作成

省略可能な要求を構成する

手順 2: ServiceNow で OIDC プロバイダーと同じ ID を登録する

  • System OAuth > Application Registry > New > Configure an OIDC providerに移動して ID トークンを確認する

    • 名前: 任意の名前
    • クライアント ID: 手順 1 で作成した "アプリケーション A" のclient ID
    • クライアント シークレット: これは実際には使用されず、任意の値を設定できます
  • OIDC プロバイダー登録フォームで、新しい OIDC プロバイダー構成を追加します。 OAuth OIDC プロバイダー構成フィールドに対する検索アイコンを選択して OIDC 構成のレコードを開き、[新規] を選択します。

    • OIDC プロバイダー: Microsoft Entra ID
    • OIDC メタデータ URL: URL は、 形式である必要があります。 に置き換えます。
    • OIDC 構成キャッシュの有効期間: 120
    • アプリケーション: グローバル
    • ユーザー要求: oid
    • ユーザー フィールド: ユーザー ID
    • JTI 要求の検証を有効にする: 無効
  • [送信] を選択し、OAuth OIDC エンティティ フォームを更新します

OIDC プロバイダーの構成

手順 3: コネクタの使用状況に対して Microsoft Entra ID に "アプリケーション B" を登録する。 これは、ServiceNow インスタンスで昇格されたアクセス許可を持つユーザーの役割を果たすアプリケーションです

  • App registrations > New registrationに移動して新しいアプリを作成する

    • 名前: 任意の名前
    • [証明書とシークレット] で、証明書の.cer ファイルをアップロードします。SNI 証明書の場合は、該当するtrustedCertificateSubjectsを使用してアプリケーションのマニフェストにauthorityIdを追加します。subjectName

手順 4: ServiceNow でシステム ユーザーを作成する。 これは、ServiceNow インスタンスのユーザーとしての "アプリケーション B" です

  • User Administration > Usersに移動して新しいユーザーを作成する

    • ユーザー ID: 手順 3 で作成した "アプリケーション B" のサービス プリンシパルのオブジェクト ID
    • Web service access only を確認する

手順 5: コネクタを使用して接続する – Copilot Studio – コネクタの構成

  • 次の情報を使用してコネクタを構成し、接続します。

    • インスタンス名: ServiceNow のインスタンス名
    • テナント ID: Microsoft Entra テナントのテナント ID
    • クライアント ID: 手順 3 で作成した "アプリケーション B" のクライアント ID
    • リソース URI: 手順 1 で作成した "アプリケーション A" のクライアント ID (アプリケーション URI ではありません )
    • クライアント証明書シークレット: 手順 3 で作成した証明書の .pfx ファイル
    • 証明書パスワード: .pfx ファイルのパスワード

Microsoft Entra ID OAuth ユーザー ログインを作成する手順

Microsoft Entra ID OAuth ユーザー ログイン接続を構成するには、上記の証明書認証セクションで説明されているように、手順 1 と手順 2 を完了してください。

手順 1 は同じです。 手順 2 で、ServiceNow のトークン (Entra 以外のサード パーティの ID プロバイダーの場合) から Upn またはカスタム要求プロパティにユーザー要求を更新します。 ユーザー フィールドは、upn またはユーザー ID を含む ServiceNow システム ユーザー テーブル フィールドと一致する必要があります。

OAuth ログインの構成

上記の証明書認証セクションの手順 3 と 4 は必要ありません。 代わりに、この場合の "アプリケーション B" は、ServiceNow コネクタ用に作成された 1p アプリです。 以下のアプリには、"アプリケーション A" のアクセス許可が付与されている必要があります。

"アプリケーション B" ID: c26b24aa-7874-4e06-ad55-7d06b1f79b63

Important

このシナリオでは、"アプリケーション B" は、ユーザーが作成したアプリではなく、Microsoft が所有する既存の 1p アプリである ID c26b24aa-7874-4e06-ad55-7d06b1f79b63 を使用する必要があります (証明書を使用して Microsoft Entra ID OAuth 接続を作成するために必要)。

アプリケーションのアクセス許可を付与する

ServiceNow コネクタの接続を作成するときに、ユーザーは認証の種類として "Microsoft Entra ID User Login" を選択する必要があり、ServiceNow インスタンス名とリソース ID ("アプリケーション A" の識別子) のみを指定する必要があります。 その後、サインイン ボタンは、ユーザー自身のアカウントを使用して Entra ID ログインを通じてユーザーを取得します。

ログイン認証の種類

サード パーティの ID プロバイダーの使用、または Entra ID のユーザーと ServiceNow ユーザー テーブルの間に存在するデータの不一致

  • Entra ID トークンのユーザー識別子プロパティと ServiceNow テーブル内のユーザー識別子の値が一致しない場合
    • たとえば、トークンには完全な upn (およびドメイン - abc@contoso.com) が含まれ、ServiceNow users テーブルにはユーザー識別子 (abc) のみが含まれます。 ServiceNow 識別子のユーザー識別子と一致する値を含むカスタム属性をトークンに追加するには、数式を適用し、その新しいプロパティを利用して手順 2 で要求マッピングを実行することをお勧めします。
    • 新しい要求プロパティを追加するプロセスについて説明する Microsoft Learn ドキュメント: https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token

"Microsoft Entra ID を使用する ServiceNow Power Platform 接続を設定する方法" のリファレンス:

接続を作成する

コネクタでは、次の認証の種類がサポートされています。

基本認証 基本認証を使用してサインインする すべてのリージョン 共有不可
証明書を使用した Microsoft Entra ID OAuth PFX 証明書を使用した Microsoft Entra ID を使用した OAuth。 POWERPLATFORM のみ 共有可能
Microsoft Entra ID ユーザー ログイン Microsoft Entra ID 資格情報を使用してログインする すべてのリージョン 共有不可
Oauth2 を使用する Oauth2 でサインインする すべてのリージョン 共有不可
既定 [非推奨] このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。 すべてのリージョン 共有不可

基本認証

認証 ID: basicAuthentication

適用対象: すべてのリージョン

基本認証を使用してサインインする

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
事例 文字列 移行されたアカウントの service-now.com またはカスタム URL のインスタンスの名前 正しい
ユーザー名 文字列 このインスタンスのユーザー名 正しい
パスワード securestring このアカウントのパスワード 正しい

証明書を使用した OAuth のMicrosoft Entra ID

認証 ID: aadOAuthCert

適用: POWERPLATFORM のみ

PFX 証明書を使用した Microsoft Entra ID を使用した OAuth。

これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、 キャンバス アプリのコネクタの概要 - Power Apps |Microsoft Docs

名前 タイプ Description 必須
インスタンス名 文字列 ServiceNow Site URl の識別に使用されるインスタンス名 正しい
テナント ID 文字列 正しい
クライアントID 文字列 正しい
リソース URI 文字列 正しい
クライアント証明書シークレット クライアント証明書 このアプリケーションで許可されるクライアント証明書シークレット 正しい

Microsoft Entra ID ユーザー ログイン

認証 ID: entraIDUserLogin

適用対象: すべてのリージョン

Microsoft Entra ID 資格情報を使用してログインする

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
リソース URI 文字列 正しい
インスタンス名 文字列 ServiceNow サイトの URL を識別するために使用されるインスタンス名 正しい

Oauth2 を使用する

認証 ID: oauth2ServiceNow

適用対象: すべてのリージョン

Oauth2 でサインインする

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
インスタンス名 文字列 ServiceNow Site URl の識別に使用されるインスタンス名 正しい
クライアント ID 文字列 サービス プロバイダーでこのアプリケーションを識別するために使用される ID 正しい
クライアント シークレット securestring サービス プロバイダーでこのアプリケーションを認証するために使用される共有シークレット 正しい

既定 [非推奨]

適用対象: すべてのリージョン

このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
事例 文字列 移行されたアカウントの service-now.com またはカスタム URL のインスタンスの名前 正しい
ユーザー名 文字列 このインスタンスのユーザー名 正しい
パスワード securestring このアカウントのパスワード 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 600 60 秒

アクション

カタログ アイテムを取得する

特定のカタログ アイテムを取得します。

カタログ アイテムを取得する

検索テキストやカタログなど、指定したパラメーターに基づいてカタログ アイテムの一覧を取得します。

カタログ カテゴリを取得する

特定のカタログのカテゴリの一覧を取得します

カタログを取得する

カタログの一覧を取得します。

ナレッジ記事を取得する

検索およびフィルター処理できるナレッジ ベース (KB) 記事の一覧を返します。

バイナリ ファイルを添付ファイルとしてアップロードする (プレビュー)

指定したレコードに添付ファイルとしてバイナリ ファイルをアップロードします

マルチパートファイル添付ファイルをアップロードする (プレビュー)

マルチパート フォームから添付ファイルをアップロードする

レコードの一覧表示

"Incidents" などの特定の ServiceNow オブジェクトの種類のレコードを取得します

レコードの作成

ServiceNow テーブルにレコードを作成します。

レコードの削除

"Incidents" のような ServiceNow オブジェクトの種類のレコードを削除します。

レコードの取得

"Incidents" のような ServiceNow オブジェクトの種類のレコードを取得します。

レコードの更新

"Incidents" などの ServiceNow オブジェクトの種類のレコードを更新します

レコードの種類を取得する

使用可能なレコードの種類を一覧表示します

注文アイテム

特定のカタログ アイテムを注文または購入します。

添付ファイルのコンテンツを取得する (プレビュー)

添付ファイルのコンテンツを取得する

添付ファイルのメタデータを取得する (プレビュー)

添付ファイルのメタデータを取得する

添付ファイルを削除する (プレビュー)

添付ファイルを削除する

添付ファイルメタデータの取得 (プレビュー)

添付ファイルのメタデータを取得する

カタログ アイテムを取得する

特定のカタログ アイテムを取得します。

パラメーター

名前 キー 必須 説明
アイテム ID
sys_id True string

取得するカタログ 項目のsys_id

戻り値

カタログ アイテムを取得する

検索テキストやカタログなど、指定したパラメーターに基づいてカタログ アイテムの一覧を取得します。

パラメーター

名前 キー 必須 説明
カテゴリ
sysparm_category string

項目をフィルター処理するカテゴリ ID。 指定しない場合は、すべての項目が返されます。

極限
sysparm_limit True integer

取得するカタログ アイテムの数

テキストの検索
sysparm_text string

アイテムをフィルター処理するテキストを検索する

Catalog
sysparm_catalog string

アイテムをフィルター処理するカタログ ID。 指定しない場合は、すべてのカタログの項目が返されます

戻り値

カタログ カテゴリを取得する

特定のカタログのカテゴリの一覧を取得します

パラメーター

名前 キー 必須 説明
カタログ ID
catalogId True string

カテゴリを取得するカタログの ID

極限
sysparm_limit integer

取得するカタログ カテゴリの数

オフセット
sysparm_offset integer

クエリのオフセット

戻り値

カタログを取得する

カタログの一覧を取得します。

パラメーター

名前 キー 必須 説明
極限
sysparm_limit integer

取得するカタログの数

テキストの検索
sysparm_text string

名前または説明でカタログをフィルター処理する検索テキスト

戻り値

ナレッジ記事を取得する

検索およびフィルター処理できるナレッジ ベース (KB) 記事の一覧を返します。

パラメーター

名前 キー 必須 説明
Fields
fields string

ナレッジ テーブルのフィールドのコンマ区切りの一覧。

極限
limit integer

返されるレコードの最大数。

Query
query True string

検索するテキスト。

Filter
filter string

結果セットのフィルター処理に使用するエンコードされたクエリ。

Kb
kb string

ナレッジ ベース sys_idsのコンマ区切りの一覧。

戻り値

バイナリ ファイルを添付ファイルとしてアップロードする (プレビュー)

指定したレコードに添付ファイルとしてバイナリ ファイルをアップロードします

パラメーター

名前 キー 必須 説明
テーブル名
table_name True string

ファイルを添付するテーブルの名前

Sys ID
table_sys_id True string

ファイルを添付する指定したテーブルのレコードのSys_id

ファイル名
file_name True string

添付ファイルに付ける名前

File
file True binary

指定したレコードに添付するバイナリ ファイル

戻り値

マルチパートファイル添付ファイルをアップロードする (プレビュー)

マルチパート フォームから添付ファイルをアップロードする

パラメーター

名前 キー 必須 説明
添付ファイルのコンテンツ
attachment_content True file

アップロードする添付ファイル

テーブル名
table_name True string

ファイルを添付するテーブルの名前。

テーブル ID
table_sys_id True string

ファイルを添付する指定したテーブルのレコードのSys_id

戻り値

レコードの一覧表示

"Incidents" などの特定の 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

返されるフィールドのコンマ区切りのリスト。 例: 名前、電子メール、電話

戻り値

この操作の出力は状況に応じて変わります。

レコードの作成

ServiceNow テーブルにレコードを作成します。

パラメーター

名前 キー 必須 説明
レコードの種類
tableType True string

リストするレコードの種類

body
body True dynamic
システム参照の表示
sysparm_display_value boolean

システム参照を含める必要があるかどうかを判断します

参照リンクを除外する
sysparm_exclude_reference_link boolean

参照リンクを除外するかどうかを決定します

Fields
sysparm_fields string

返されるフィールドのコンマ区切りのリスト。 例: 名前、電子メール、電話

戻り値

この操作の出力は状況に応じて変わります。

レコードの削除

"Incidents" のような ServiceNow オブジェクトの種類のレコードを削除します。

パラメーター

名前 キー 必須 説明
レコードの種類
tableType True string

リストするレコードの種類

システム ID
sysid True string

レコードのシステム ID。

レコードの取得

"Incidents" のような ServiceNow オブジェクトの種類のレコードを取得します。

パラメーター

名前 キー 必須 説明
レコードの種類
tableType True string

リストするレコードの種類

システム ID
sysid True string

レコードのシステム ID。

システム参照の表示
sysparm_display_value boolean

システム参照を含める必要があるかどうかを判断します

参照リンクを除外する
sysparm_exclude_reference_link boolean

参照リンクを除外するかどうかを決定します

Fields
sysparm_fields string

返されるフィールドのコンマ区切りのリスト。 例: 名前、電子メール、電話

戻り値

この操作の出力は状況に応じて変わります。

レコードの更新

"Incidents" などの ServiceNow オブジェクトの種類のレコードを更新します

パラメーター

名前 キー 必須 説明
レコードの種類
tableType True string

リストするレコードの種類

システム ID
sysid True string

レコードのシステム ID。

body
body True dynamic
システム参照の表示
sysparm_display_value boolean

システム参照を含める必要があるかどうかを判断します

参照リンクを除外する
sysparm_exclude_reference_link boolean

参照リンクを除外するかどうかを決定します

Fields
sysparm_fields string

返されるフィールドのコンマ区切りのリスト。 例: 名前、電子メール、電話

戻り値

この操作の出力は状況に応じて変わります。

レコードの種類を取得する

使用可能なレコードの種類を一覧表示します

戻り値

注文アイテム

特定のカタログ アイテムを注文または購入します。

パラメーター

名前 キー 必須 説明
アイテム ID
sys_id True string

注文するカタログアイテムのsys_id

注文アイテムの本文
body True dynamic

注文品目要求の本文。 これには、数量、要求されたユーザー、およびカタログアイテムに必要な追加変数が含まれます。

戻り値

添付ファイルのコンテンツを取得する (プレビュー)

添付ファイルのコンテンツを取得する

パラメーター

名前 キー 必須 説明
Sys ID
sys_id True string

コンテンツを取得する添付ファイルのSys_id

添付ファイルのメタデータを取得する (プレビュー)

添付ファイルのメタデータを取得する

パラメーター

名前 キー 必須 説明
ID
sys_id True string

メタデータを取得する添付ファイルのSys_id

添付ファイルを削除する (プレビュー)

添付ファイルを削除する

パラメーター

名前 キー 必須 説明
Sys ID
sys_id True string

削除する添付ファイルのSys_id

添付ファイルメタデータの取得 (プレビュー)

添付ファイルのメタデータを取得する

パラメーター

名前 キー 必須 説明
極限
sysparm_limit string

改ページ位置に適用される制限。 注: 異常に大きいsysparm_limit値は、システムのパフォーマンスに影響を与える可能性があります。 既定値: 1000

オフセット
sysparm_offset string

クエリから除外するレコードの数。 このパラメーターを使用して、sysparm_limitで指定された数を超えるレコードを取得します。 たとえば、sysparm_limitが 500 に設定されていても、クエリを実行するレコードが追加されている場合は、sysparm_offset値 500 を指定して、2 番目のレコード セットを取得できます。 既定値は0

Query
sysparm_query string

エンコードされたクエリ。 Attachment API のクエリは、Attachments [sys_attachment] テーブルに対する相対クエリです。 例: (sysparm_query=file_name=attachment.doc)

定義

UploadAttachmentResponse

名前 パス 説明
average_image_color
result.average_image_color string

添付ファイルが画像の場合、すべての色の合計。

圧縮
result.compressed string

添付ファイルが圧縮されているかどうかを示すフラグ。

content_type
result.content_type string

関連する添付ファイルのコンテンツ タイプ (画像、jpeg、application/x-shockwave-flash など)。

created_by_name
result.created_by_name string

最初に添付ファイルを作成したエンティティのフル ネーム。

download_link
result.download_link string

ServiceNow インスタンスの添付ファイルの URL をダウンロードします。

ファイル名
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
可用性
result.availability string
mandatory_attachment
result.mandatory_attachment boolean
request_method
result.request_method string
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
所有者
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

説明

可用性
result.availability string

可用性

mandatory_attachment
result.mandatory_attachment boolean

mandatory_attachment

request_method
result.request_method string

request_method

result.type string

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

所有者
result.owner string

所有者

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

variablesSchema
result.variablesSchema object

OrderItemResponse

名前 パス 説明
sys_id
result.sys_id string

sys_id

数値
result.number string

数値

request_number
result.request_number string

request_number

リクエストID
result.request_id string

リクエストID

テーブル
result.table string

テーブル

GetArticlesResponse

名前 パス 説明
数える
meta.count integer

利用可能な KB 記事の数

End
meta.end integer

結果セットの終了インデックス

Fields
meta.fields string

記事のフィールド

Filter
meta.filter string

データの取得に使用されるフィルター

Kb
meta.kb string

ナレッジ ベース記事の一覧 sys_ids

Language
meta.language string

要求された KB 記事のコンマ区切り言語の一覧

Query
meta.query string

指定された要求クエリ

[開始]
meta.start string

結果セットの開始インデックス

ステータス
meta.status.code string

通話の状態

Kb
meta.ts_query_id string

要求された KB 記事のコンマ区切り言語の一覧

記事
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

ナレッジ [kb_knowledge] テーブルからsys_idナレッジ記事

Number
articles.number string

ナレッジ [kb_knowledge] テーブルからsys_idナレッジ記事

順位
articles.rank float

この検索に固有の記事の検索ランク

Score
articles.score float

関連性スコア、スコア別に降順に並べ替えられた結果

抜粋
articles.snippet string

ナレッジ記事のごく一部を示すテキスト

Title
articles.title string

ナレッジ記事の簡単な説明またはタイトル