Cloud API の API のリスト
Cloud API for ClaimCenter は、以下の API で構成されています。
| API 名 | 説明 | パス |
|---|---|---|
| Admin | ユーザーやグループなどの管理オブジェクト用の API | /admin/v1 |
| API List | 使用可能な API をリストするための API | /apis |
| Async | 非同期に処理された呼び出しに対する応答を取得するための API | /async/v1 |
| Claim | クレームおよびクレーム固有オブジェクトの API | /claim/v1 |
| Common | アクティビティや備考・経緯などの一般的な InsuranceSuite プラットフォームオブジェクトの API | /common/v1 |
| Composite | コンポジット要求のための API | /composite/v1 |
| システムツール | バッチ処理およびデータベース整合性チェックの API | /systemtools/v1 |
| Test Util |
開発中におけるテスト用の API （有効化されている場合のみ使用可能） |
/test-util/v1 |
/apis エンドポイントは、ClaimCenter のすべての REST API を返します。これには、/system/v0/database や /system/v0/maintenance など、Cloud API の一部ではない API もいくつか含まれています。前に示した表には、Cloud API の一部である API のみをリストしています。それらの API のみが、要求包含や認証などの Cloud API 機能にアクセスできます。Cloud API for ContactManager は、以下の API で構成されています。
| API 名 | 説明 | パス |
|---|---|---|
| Admin | ユーザーやグループなどの管理オブジェクト用の API | /admin/v1 |
| API List | 使用可能な API をリストするための API | /apis |
| Async | 非同期に処理された呼び出しに対する応答を取得するための API | /async/v1 |
| Common | アクティビティや備考・経緯などの一般的な InsuranceSuite プラットフォームオブジェクトの API | /common/v1 |
| Contact | 連絡先のための API | /contact/v1 |
/apis エンドポイントは、ContactManager のすべての REST API を返します。これには、/system/v0/database や /system/v0/maintenance など、Cloud API の一部ではない API もいくつか含まれています。前に示した表には、Cloud API の一部である API のみをリストしています。それらの API のみが、要求包含や認証などの Cloud API 機能にアクセスできます。API パスを使用すると、API に関するメタデータを表示できます。これは、次のセクションで詳しく説明します。
メジャーリリースとマイナーリリース
次のセクションでは、マイナーリリースとは何かについて定義します。マイナーリリースでは、「互換性の低下を招く変更」があると想定されていません。「互換性の低下を招く変更」の定義に該当する変更と該当しない変更の種類については、「Schema Backwards Compatibility Contract（スキーマの下位互換性の契約）」に記載しています。この契約のコピーにアクセスするには、Guidewire の担当者にお問い合わせください。
バージョン番号
Cloud API のすべてのバージョンに、バージョン番号があります。例えば、ある年の 1 月、4 月、7 月、および 10 月で 4 つの Cloud API リリースがあるとします。各リリースには、以下のバージョン番号が付与される場合があります。
- 1 月：1.0.0
- 4 月：1.1.0
- 7 月：1.2.0
- 10 月：2.0.0
マイナーリリースとメジャーリリース
将来のリリースでは、Cloud API 機能の変更が予想されます。これらの変更を定義および管理するために、Cloud API では、マイナーバージョンとメジャーバージョンを利用しています。
- マイナーバージョンは、前の Cloud API リリースと同一機能または付加機能を持つバージョンです。
- メジャーバージョンは、前の Cloud API リリースから変更された機能を持つバージョンです。
特定リリースの Cloud API には複数のバージョンの API が存在する場合があります。その場合、そのいくつかはマイナーバージョンで、いくつかはメジャーバージョンです。
メジャーバージョンには、API エンドポイントパスに「エンドポイントパス番号」が付いています。これは、/v の後の数字です（例えば、/common/v1/activities ではエンドポイントパス番号は 1 です）。Guidewire が「純粋に付加的」ではない変更を API に行った場合、変更された API はメジャーリリースと見なされます。そのエンドポイント番号は、1 つ増加します。
Cloud API のリリースに新しいメジャーリリースが含まれている場合、前のマイナーリリースも含まれています。マイナーリリースが前のリリースと同一である場合も、付加的変更が存在する場合もあります。
例えば、前の例のリリースでは以下のように仮定します。
- 1 月のリリースの Cloud API では、メジャーバージョンが 1 である。
- 4 月のリリースの Cloud API は、同一または付加的である。
- 7 月のリリースの Cloud API は、同一または付加的である。
- 10 月のリリースの Cloud API には、既存の機能に対する変更が含まれている。
この場合、1 月、4 月、および 7 月のリリースにはすべて、単一バージョンの API が含まれ、エンドポイントには /v1 が含まれます。10 月のリリースには、/v1 の API セットと新しい /v2 の API セットが含まれます。これを以下の表に要約します。
| リリース月 | バージョン番号 | 前のリリースと比べたこのリリースの機能 | このリリースのメジャーバージョン |
| 1 月 | 1.0.0 | 同一または付加的 | /common/v1 |
| 4 月 | 1.0.1 | 同一または付加的 | /common/v1 |
| 7 月 | 1.0.2 | 同一または付加的 | /common/v1 |
| 10 月 | 2.0.0 | 既存の機能に対する変更あり |
/common/v1（7 月のリリースに同一または付加的）および /common/v2（変更された機能を含む） |