メタデータ API 開発者ガイド
jExternalServiceRegistration
ファイルのサフィックスおよびディレクトリの場所
ExternalServiceRegistration コンポーネントのサフィックスは .externalServiceRegistration で、externalServiceRegistrations フォルダに保存されます。
バージョン
ExternalServiceRegistration コンポーネントは、API バージョン 39.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| description | string | サービスの作成時に定義された外部サービスの説明です。 |
| label | string | 必須。外部サービスウィザードに表示されるサービス名。 |
| namedCredential | string | サービスに使用される名前による参照。 |
| operations | ExternalServiceOperation[] | この操作に対して定義された項目。 |
| registrationProviderType | ExternalServiceRegistrationProviderType (string 型の列挙) | 外部サービスウィザードで登録された API 仕様のソースを示します。使用できる値は次のとおりです。
|
| schema | string | OpenAPI 2.0 形式での JSON スキーマのコンテンツ。Nillable。 |
| schemaType | string | スキーマの形式。Open API 2.0 の場合は OpenAPI、API バージョン 47.0 以前の場合は、InteragentHyperSchema。指定しない場合、スキーマ種別はスキーマのコンテンツに基づいて派生が行われます。Nillable。 |
| schemaUrl | string | パスは、「/」で開始し、指定ログイン情報のエンドポイントへの相対パスである必要があります。 |
| serviceBinding | string | この外部サービス登録でサポートされていないメディアタイプを、サポートされているメディアタイプに対応付けるために使用します。Nillable。API バージョン 53.0 以降で利用できます。 |
| status | string | 必須。サービス登録状況を示します。使用できる値は次のとおりです。
|
ExternalServiceOperation
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| active | boolean | 必須。操作が有効か (true)、無効か (false) を示します。 |
| name | string | 必須。操作の名前。 |
serviceBinding
次の JSON 符号化された文字列では、外部サービスのリクエストおよびレスポンスボディを逐次化するためのサポートされていないメディアタイプとサポートされているメディアタイプの対応付けが定義されます。
サポートされていないメディアタイプ application/x-acme-json は、この外部サービス登録でサポートされているメディアタイプ application/json に対応付けられます。外部サービスランタイムでは、リクエストおよびレスポンスヘッダーの処理でサポートされていないメディアタイプが考慮され、対応付けられたサポートされているメディアタイプによってリクエストおよびレスポンスコンテンツが逐次化されます。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。