メタデータ API 開発者ガイド
jExternalServiceRegistration
ファイルのサフィックスおよびディレクトリの場所
ExternalServiceRegistration コンポーネントのサフィックスは .externalServiceRegistration で、externalServiceRegistrations フォルダに保存されます。
バージョン
ExternalServiceRegistration コンポーネントは、API バージョン 39.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| 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 | 必須。パスは、「/」で開始し、指定ログイン情報のエンドポイントへの相対パスである必要があります。 |
| 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 "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>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。