ExternalServiceRegistration

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

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

バージョン

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

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

メモ

項目

項目名	項目の型	説明
description	string	サービスの作成時に定義された外部サービスの説明です。
label	string	必須。外部サービスウィザードに表示されるサービス名。
namedCredential	string	サービスに使用される名前による参照。
NamedCredentialReferenceId	reference	指定ログイン情報に使用される ID による参照。この項目が使用されている場合、`namedCredential` よりも優先されます。API バージョン 57.0 以降で利用できます。
operations	ExternalServiceOperation[]	この操作に対して定義された項目。
registrationProviderType	ExternalServiceRegistrationProviderType (string 型の列挙)	外部サービスウィザードで登録された API 仕様のソースを示します。使用できる値は次のとおりです。 `Custom` - API 仕様は手動で設定されました。 `Mulesoft` - API 仕様は Mulesoft から選択されました。 `SchemaInferred` - API 仕様は、HTTP コールアウトの設定時にプロバイダーから提供されました。API バージョン 57.0 以降で利用できます。
schema	string	OpenAPI 2.0 形式での JSON スキーマのコンテンツ。Nillable。
schemaAbsoluteUrl	string	スキーマへの完全な絶対 URL。ユーザーが [絶対 URL] を選択したときに入力されます。
schemaType	string	スキーマの形式。Open API 2.0 の場合は OpenAPI、API バージョン 47.0 以前の場合は、InteragentHyperSchema。指定しない場合、スキーマ種別はスキーマのコンテンツに基づいて派生が行われます。Nillable。
schemaUploadFileExtension	string	ファイルの拡張子。ユーザーが [ローカルからアップロード] を選択したときに入力されます。
schemaUploadFileName	string	ファイル拡張子を除いたファイル名。ユーザーが [ローカルからアップロード] を選択したときに入力されます。
schemaUrl	string	パスは、「/」で開始し、指定ログイン情報のエンドポイントへの相対パスである必要があります。
serviceBinding	string	この外部サービス登録でサポートされていないメディアタイプを、サポートされているメディアタイプに対応付けるために使用します。Nillable。API バージョン 53.0 以降で利用できます。
status	string	必須。サービス登録状況を示します。使用できる値は次のとおりです。 `complete` - API 仕様が有効であり、登録の使用準備が整っています。 `incomplete` - サービス登録が完了していません。
systemVersion	int	API 仕様を登録するために使用される外部サービスの内部バージョン。API バージョン 55.0 以降で利用できます。 `1` - 廃止された従来の外部サービス。 `2` - オブジェクトおよび操作名の長さに制限がある外部サービス。 `3` - 現在のバージョン。自動的に派生される開発者名が 80 文字に収まる外部サービス。

ExternalServiceOperation

項目名	項目の型	説明
active	boolean	必須。操作が有効か (`true`)、無効か (`false`) を示します。
name	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  "swagger": "2.0",
7  "basePath": "/",
8  "info": {
9    "version": "1.0",
10    "title": "External Service for demo bank",
11    "description": "### External Service for demo bank",
12    "x-vcap-service-name": "DemoBankRestServices"
13  },
14  ...
15  "paths": {
16  "/accounts/{accountName}": {
17      ...
18    }
19  },
20  "definitions": {
21    "accountDetails": {
22      ...
23    },
24    "errorModel": {
25      ...
26    }
27  }
28}</schema>
29  <schemaType>OpenApi</schemaType>
30  <schemaUrl>/accounts/schema</schemaUrl>
31  <status>Complete</status>
32</ExternalServiceRegistration>

serviceBinding

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

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

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

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

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

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