この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

ExternalServiceRegistration

組織の外部サービス設定を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

ExternalServiceRegistration コンポーネントのサフィックスは .externalServiceRegistration で、externalServiceRegistrations フォルダに保存されます。

バージョン

ExternalServiceRegistration コンポーネントは、API バージョン 39.0 以降で使用できます。

API バージョン 47.0 以前では、外部サービスで Interagent および OpenAPI 2.0 の一部のサブセットがサポートされていました。API バージョン 48.0 以降、外部サービスでは OpenAPI 2.0 ��サポートされますが、InteragentHyperSchema はサポートされません。Salesforce ヘルプの「拡張外部サービスに関する考慮事項」を参照してください。

メモ

項目

項目名	項目の型	説明
description	string	必須。サービスの作成時に定義された外部サービスの説明です。
label	string	外部サービスウィザードに表示されるサービス名。
namedCredential	string	必須。サービスに使用される名前による参照。
schema	string	必須。OpenAPI 2.0 形式での JSON スキーマのコンテンツ。Nillable。
schemaType	string	スキーマの形式。Open API 2.0 の場合は OpenAPI、API バージョン 47.0 以前の場合は、InteragentHyperSchema。指定しない場合、スキーマ種別はスキーマのコンテンツに基づいて派生が行われます。Nillable。
schemaUrl	string	必須。パスは、「/」で開始し、指定ログイン情報のエンドポイントへの相対パスである必要があります。
serviceBinding	string	この外部サービス登録用の未許可 MIME タイプを許可 MIME タイプに対応付けるために使用されます。Nillable。API バージョン 53.0 以降で利用できます。
status	string	サービス登録が完了し、有効で、使用可能になっているか (完了)、否か (未完了) を示します。

宣言的なメタデータの定義のサンプル

外部信用度サービスを参照する ExternalServiceRegistration コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalServiceRegistration xmlns="http://soap.sforce.com/2006/04/metadata">
3  <label>BankService</label>
4  <namedCredential>Bank</namedCredential>
5  <schema>{
6  &quot;swagger&quot;: &quot;2.0&quot;,
7  &quot;basePath&quot;: &quot;/&quot;,
8  &quot;info&quot;: {
9    &quot;version&quot;: &quot;1.0&quot;,
10    &quot;title&quot;: &quot;External Service for demo bank&quot;,
11    &quot;description&quot;: &quot;### External Service for demo bank&quot;,
12    &quot;x-vcap-service-name&quot;: &quot;DemoBankRestServices&quot;
13  },
14  ...
15  &quot;paths&quot;: {
16  &quot;/accounts/{accountName}&quot;: {
17      ...
18    }
19  },
20  &quot;definitions&quot;: {
21    &quot;accountDetails&quot;: {
22      ...
23    },
24    &quot;errorModel&quot;: {
25      ...
26    }
27  }
28}</schema>
29  <schemaType>OpenApi</schemaType>
30  <schemaUrl>/accounts/schema</schemaUrl>
31  <status>Complete</status>
32</ExternalServiceRegistration>

serviceBinding

次の JSON 符号化された文字列では、外部サービスのリクエストおよびレスポンスボディを逐次化するための許可 MIME タイプと未許可 MIME タイプの対応付けが定義されます。

1{"compatibleMediaTypes":{
2    "application/x-acme-json":"application/json"
3}}

未許可 MIME タイプ application/x-acme-json は、この外部サービス登録用の許可 MIME タイプ application/json に対応付けられます。外部サービスランタイムでは、リクエストおよびレスポンスヘッダーを処理するための未許可メディアタイプが考慮され、対応付けられた許可 MIME タイプによってリクエストおよびレスポンスコンテンツが逐次化されます。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド