Cloud API ビジネスフローと設定ガイド
Guidewire ClaimCenter Cloud API へようこそ
基本の REST 処理
クラウド API の概要
Cloud API の API のリスト
メジャーリリースとマイナーリリース
API 定義の表示
Swagger UI
Swagger UI を使用した API 定義の表示
Swagger UI での API 情報の構成
API 定義エンドポイントと Postman
Postman を使用して API 定義を表示する方法
API 定義エンドポイントの出力における情報の構成
Cloud API での REST API の基礎
InsuranceSuite Cloud API
リソース
エンドポイント
ルートリソース
子リソース
操作
パス
要求と応答
要求と応答のテスト
チュートリアル：Postman 環境のセットアップ
GET
GET の概要
標準のペイロード構造
スキーマの表示
Swagger UI での応答スキーマの表示
GET の送信
Postman を使用した GET の送信
チュートリアル：基本的な Postman 要求の送信
基本応答のペイロード構造
基本的な応答の構造
count プロパティ
data セクション
attributes セクション
checksum フィールド
links サブセクション（要素）
コレクションレベルの links セクション
包含リソースが含まれる応答のペイロード構造
チュートリアル：包含リソースが含まれる Postman 要求の送信
包含リソースが含まれる応答の構造
related セクション（リソース）
included セクション（応答）
コレクションまたは特定リソースの包含
包含可能なリソースの決定
クエリパラメータ
クエリパラメータの概要
クエリパラメータ定義の表示
クエリパラメータのエラーメッセージ
返されるリソースとフィールドの指定
GET のフィルタリング
デフォルトのフィルタがあるエンドポイント
チュートリアル：filter パラメータを含む GET の送信
GET を行うフィールドの指定
チュートリアル：fields パラメータを含む GET の送信
結果セットの並べ替え
チュートリアル：並べ替えのクエリパラメータを含む GET の送信
ページネーションの制御
ペイロードごとのリソース数の制限
コレクションでの単一リソースの選択
リソースのページ制御
リソースの合計数の取得
チュートリアル：pageSize および totalCount パラメータを含む GET の送信
包含リソースでのクエリパラメータの使用
包含リソースに適用するクエリパラメータの指定
包含リソースのクエリパラメータの概要
チュートリアル：包含リソースのクエリパラメータを含む GET の送信
POST
POST の概要
ペイロード構造の標準化
要求スキーマの表示
Swagger UI での要求スキーマの表示
要求ペイロードの設計
必須、オプション、および書き込み専用フィールドの判別
要求ペイロードの構造
要求ペイロードでのスカラー値の指定
要求ペイロードでのオブジェクトの指定
値とオブジェクトの Null 設定
POST の送信
Postman を使用した POST の送信
チュートリアル：必須フィールドのみを指定する新しい備考・経緯の作成
チュートリアル：オプションのフィールドを指定する新しい備考・経緯の作成
POST への応答
リダイレクトによる Postman の動作
ビジネスアクションの POST
POST のパフォーマンスの向上
PATCH
PATCH の概要
PATCH のペイロード構造
要求ペイロードの設計
PATCH と配列
PATCH の送信
Postman を使用した PATCH の送信
チュートリアル：アクティビティの PATCH
PATCH への応答
PATCH とロストアップデート
リダイレクトによる Postman の動作
DELETE
DELETE の概要
チュートリアル：備考・経緯の DELETE 操作
DELETE とロストアップデート
要求ヘッダー
HTTP ヘッダー
Cloud API ヘッダーの概要
Postman を使用した Cloud API ヘッダーを含む要求の送信
言語とロケール
クラスター化環境での関連呼び出しのルーティング
重複するデータベーストランザクションの回避
エンドポイントのウォームアップ
不明な要素を含む呼び出しの処理
その他の制約に対する応答ペイロードの検証
呼び出しの最適化
呼び出し数の削減
複数の要求を一度に実行する機能
複数の要求を実行する機能の比較
使用する機能の決定
コンポジット要求
コンポジット要求の構成
requests セクション
変数を使用してサブ要求間で情報を共有する方法
サブ要求に対する応答
selections セクション
コンポジット要求の制限事項
コンポジット要求の例
コンポジット要求の管理
エラー処理
ログへの記録
サブ要求の最大数のコンフィギュレーション
コンポジット要求の完全な構文
要求包含
単純な親／子関係の構文
名前付き関係の構文
要求包含のその他の動作
バッチ要求
バッチ要求の構文
オプションのサブ要求の属性
バッチ要求の例
単純なバッチ要求
クエリパラメータを含むバッチ要求
要求ペイロードを含むバッチ要求
異なる処理を含むバッチ要求
バッチ要求の管理
サブ要求ヘッダーの指定
onFail 動作の指定
サブ要求の最大数のコンフィギュレーション
ロストアップデートとチェックサム
ロストアップデート
チェックサム
PATCH およびビジネスアクション POST のチェックサム
チュートリアル：チェックサムを使用したアクティビティの PATCH
チュートリアル：チェックサムを使用したアクティビティのアサイン
DELETE のチェックサム
Postman を使用した要求ヘッダーでのチェックサムの送信
チュートリアル：チェックサムを使用した備考・経緯の DELETE
非同期呼び出し
非同期呼び出しの概要
呼び出しが処理された時期の判断
/requests/{asyncRequestId} を使用した応答の取得
/requests/{asyncRequestId}/response からの応答の取得
要求の非同期送信
チュートリアル：要求の非同期送信
元の要求に対する応答の取得
/requests 応答の応答情報
/response エンドポイントを使用する応答の情報
チュートリアル：非同期要求に関する情報の取得
応答の同期的待機
チュートリアル：待機時間が設定された非同期要求の送信
非同期要求の管理
ビジネスフロー：事故受付と査定
事故受付の実行
ClaimCenter の事故受付プロセス
ドラフトクレームと未了クレーム
検証済みおよび未検証の保険契約
Cloud API での事故受付プロセス
Cloud API の事故受付プロセス
保険契約状態別の事故受付ユースケース
クレームに関するコンポジット要求の制限事項
クレームのキャンセル
クレームのモード
Test Util API
Test Util API 情報の表示
Studio で ClaimCenter 環境を設定
Swagger UI で Test Util API を表示
テスト保険契約データの作成
チュートリアル：Test Util API を使用して保険契約を作成する方法
関連オブジェクトのテストデータの作成
最小限のドラフトクレームの POST
チュートリアル：個人用自動車向け最小限ドラフトクレームの POST
ドラフトクレームの PATCH
チュートリアル：個人用自動車のドラフトクレームの PATCH
通常のドラフトクレームの POST
チュートリアル：個人用自動車の通常のドラフトクレームの POST
未検証の保険契約があるクレームの作成
未検証の保険契約とクレームの最小条件
未検証の保険契約の連絡先
未検証の保険契約の所在地
未検証の保険契約のリスクユニット
未検証の保険契約の補償
未検証の保険契約の PATCH
未検証の保険契約に関する情報の取得
ドラフトのクレームの送信
未検証の保険契約があるクレームを送信するための最小条件
チュートリアル：ドラフトクレームの送信
ドラフトクレームのキャンセル
サンプルペイロードの補遺
サンプル保険契約ペイロード
サンプルのドラフトクレームのペイロード
サンプルのコンポジットクレームのペイロード
サンプルのコンポジット要求（「初回かつ最終」）
クレーム
自分に関連付けられたクレームの問い合わせ
クレーム ID によるクレームの問い合わせ
アクティブなクレームとアーカイブ済みクレームの検索
クレーム検索の要求ペイロード
クレーム検索の応答ペイロード
保険契約情報の取得
保険契約エンドポイントの概要
クレームのアサイン
クレームの検証
ClaimCenter の検証レベル
システム API 経由のクレームの検証
アーカイブからのクレームの取得
クレーム連絡先（ClaimContact）
ClaimCenter でのクレーム連絡先の概要
Cloud API でのクレーム連絡先の概要
クレーム連絡先の役割の変更
予約済みの役割の設定
未予約の役割の設定
クレーム連絡先の特定
新しいクレーム連絡先の作成とその役割の指定
クレームにすでに存在するクレーム連絡先の役割の指定
保険契約にある連絡先の役割の指定
クレーム連絡先（ClaimContact）の役割制約
インシデント
ClaimCenter でのインシデントの概要
Cloud API でのインシデントの概要
インシデントの作成
建物インシデント
固定資産インシデント
財物内容物インシデント
傷害事故
生活費補償インシデント
車両インシデント
その他の建造物インシデント
インシデントの種類の概要
エクスポージャー
ClaimCenter でのエクスポージャーの概要
エクスポージャーの作成
最小作成条件
エクスポージャーペイロードの構築
ステップ 1：補償の種類を識別する
ステップ 2：補償のサブタイプを識別する
ステップ 3：保険金請求者を作成または識別する
ステップ 4：インシデントを作成または識別する
ステップ 5：補償を識別する
エクスポージャーに対するクエリと変更
エクスポージャーのアサイン
追加のエクスポージャーのエンドポイント
ドラフトエクスポージャーの削除
エクスポージャーの検証
エクスポージャーのクローズ
サービス要求
ClaimCenter でのサービス要求の概要
サービス要求の種類
サービス要求のライフサイクル
サービス要求の請求書
Cloud API でのサービス要求の概要
サービス要求 API と業者ポータル
必須のサービス要求データモデル
サービス要求番号
各サービス要求の種類のサポート
サービス要求に関するコンポジット要求の制限事項
サービス要求の問い合わせ
サービス要求の作成
最小作成条件
既存のサービス要求の変更
サービス要求の PATCH
サービス要求のユーザーへのアサイン
ライフサイクルでのサービス要求の移行
サービス要求の送信、受理、および却下
サービス要求の完了とキャンセル
サービス要求見積
サービス要求請求書
請求書の問い合わせ
サービス要求の請求書の作成
サービス要求請求書の承認
請求書を支払済みとしてマーク
サービス要求請求書の取消
ビジネスフロー保険金支払
支払備金
ClaimCenter 内の支払備金の概要
支払備金の問い合わせ
支払備金の作成
支払備金の作成の例
支払備金への追加の例
支払備金トランザクションの確認
支払の作成
ClaimCenter での保険金支払の概要
支払
保険金支払
保険金支払セット
保険金支払セットと保険金支払の問い合わせ
保険金支払の POST
ClaimCenter での保険金支払作成
Cloud API を介した保険金支払作成
最小保険金支払セットの作成の例
反復的支払
ClaimCenter での反復的支払
Cloud API での反復的支払
保険金支払の定期送信（X か月間隔の特定日）
保険金支払の定期送信（X か月間隔の特定曜日）
保険金支払の定期送信（X 週間隔の特定曜日）
免責処理
ClaimCenter での免責処理
Cloud API での免責処理
免責金額の過少払いと過剰払い
保険金支払の PATCH
保険金支払の DELETE
保険金支払ライフサイクルの管理
送信前の保険金支払ライフサイクル
Cloud API による保険金支払送信の移行
送信後の保険金支払ライフサイクル
Cloud API による保険金支払送信より先の移行
支払トランザクションの確認
回収金と回収準備金
回収金と回収準備金の問い合わせ
回収金と回収準備金の作成
回収準備金の作成
回収準備金セットの作成
回収準備金の確認
回収金の作成
多通貨
多通貨の概要
ClaimCenter での多通貨
Cloud API での多通貨
多通貨情報の取得
多通貨支払備金
多通貨保険金支払
多通貨情報のポスト
複数の通貨を含む支払備金のポスト
カスタム為替レートを含む支払備金のポスト
複数の通貨を含む保険金支払セットのポスト
カスタム為替レートを含む保険金支払セットのポスト
多通貨明細項目の指定
追加の為替レートスキーマフィールド
ビジネスフロー：Framework API
アクティビティ
アクティビティに対する問い合わせ
アクティビティの作成
アクティビティのアサイン
アサインオプション
アサインの例
推奨担当者の取得
アクティビティのクローズ
追加のアクティビティ機能
ドキュメント
ドキュメントの概要
ドキュメント情報に対する問い合わせ
ドキュメントのメタデータに対する問い合わせ
ドキュメントの内容に対する問い合わせ
ドキュメントの送信（POST）
Postman を使用したドキュメントの送信（POST）
ドキュメントに対するパッチ適用（PATCH）
ドキュメントの削除（DELETE）
備考・経緯
備考・経緯のクエリ
クレーム備考・経緯の作成
その他の備考・経緯機能
ユーザーとグループ
ユーザー
ユーザーのクエリ
ユーザーの作成
ユーザーの更新
グループ
グループのクエリ
グループへのユーザーのアサイン
ユーザー役割
ユーザー役割のクエリ
ユーザー役割の作成
ユーザー役割の更新
権限制限プロファイル
権限制限プロファイルに関する情報の取得
権限制限プロファイルの作成
プロファイルへの制限の追加
権限制限プロファイルの更新
タイプリストメタデータ
/typelists エンドポイント
タイプキーフィルタを使用したクエリ
チュートリアル：タイプリストメタデータのクエリ
スキーマメタデータ
バッチ処理
バッチ処理の概要
バッチ処理情報のクエリ
バッチ処理の管理
バッチ処理の開始
引数によるバッチ処理の開始
バッチ処理の停止
データベース整合性チェック
データベース整合性チェック（DBCC）の概要
DBCC の実行
以前に実行された DBCC の実行
DBCC 実行情報のクエリ
スキーマのコンフィギュレーション
スキーマコンフィギュレーションの概要
コンフィギュレーションファイルの概要
スキーマコンフィギュレーションファイルのアーキテクチャ
スキーマコンフィギュレーションファイルを変更する理由
スキーマコンフィギュレーションファイルの構文
スキーマファイルの構文
マッピングファイル構文
アップデータファイルの構文
拡張ファイル
スキーマへの新しいプロパティの追加
swagger ファイルと apiconfig ファイル
swagger ファイル
Apiconfig ファイル
スカラーのコンフィギュレーション
スキーマコンフィギュレーションファイル内のスカラー
スキーマ拡張ファイル
マッピング拡張ファイル
アップデータ拡張ファイル
チュートリアル：スカラーを使用したスキーマコンフィギュレーション
複合データ型のコンフィギュレーション
スキーマコンフィギュレーションの概要
スキーマコンフィギュレーションファイル内の複合データ型
スキーマ拡張ファイル
マッピング拡張ファイル
アップデータ拡張ファイル
チュートリアル：複合データ型を使用したスキーマコンフィギュレーション
外部キーのコンフィギュレーション
外部キープロパティ
外部キーのコンフィギュレーション用ツール
SimpleReference スキーマ
ResourceReference マッパー
値リゾルバ
スキーマコンフィギュレーションファイル内の外部キー
スキーマ拡張ファイル
マッピング拡張ファイル
アップデータ拡張ファイル
アップデータケース 1：ルートと解決済みの値の先祖が異なる
ケース 1 の完全なコードの例
アップデータケース 2：ルートと解決済みの値の先祖が同じ
ケース 2 の完全なコードの例
アップデータケース 3：解決済みの値のアクセシビリティが条件付き
ケース 3 の完全なコードの例
アップデータケース 4：解決済みの値を ID だけで簡単に解決できない
1 対 1 のコンフィギュレーション
1 対 1 関係
インラインオブジェクト
1 対 1 の例
スキーマコンフィギュレーションファイル内の 1 対 1 関係
スキーマ拡張ファイル
マッピング拡張ファイル
アップデータ拡張ファイル
ID とチェックサムの予約
ID とチェックサムの動作のコンフィギュレーション
応答と要求内の 1 対 1
1 対 1 の完全なコードの例
追加のスキーマ動作
プロパティレベルの動作
読み取り専用プロパティ
データベースに必須のプロパティ
作成時にのみ書き込み可能なプロパティ
並べ替え可能なプロパティ
フィルタ可能なプロパティ
プロパティ用の追加のメタデータ
プロパティ属性のまとめ
コレクションレベル動作
コレクションの並べ替え
コレクションのフィルタ
応答データの難読化
応答データの無効化
応答データのマスク
ベースコンフィギュレーション taxID フィールドのマスク解除
スキーマのローカライズ
ローカライズされたテキストのアーキテクチャ
display key と API 要素の関連付け
ローカリゼーションキー接頭辞
schema.json ファイルの display key パターン
swagger.yaml ファイルの display key パターン
特定のロケール固有のコンテンツの提供
既存の API 要素用のローカライズされたテキストの追加
新しい API 要素用のローカライズされたテキストの追加
新しいロケールの追加
カスタムエンティティ用のエンドポイントの生成
REST エンドポイントジェネレータ
REST エンドポイントジェネレータの概要
カスタム CRUD エンドポイントのアーキテクチャ
REST エンドポイントジェネレータの制限事項
カスタムエンティティ用の CRUD エンドポイントの生成手順
特殊なユースケース
REST エンドポイントジェネレータの実行
ジェネレータを実行する前に考慮すべき問題
新しいエンドポイントの API
カスタムリソースの親
コレクションへの読み込み
その他の考慮事項
REST エンドポイントジェネレータの実行
Studio からの REST エンドポイントジェネレータの実行
REST エンドポイントジェネレータの実行コンフィギュレーションの作成
実行コンフィギュレーションを使用して REST エンドポイントジェネレータを実行する方法
コマンドプロンプトからの REST エンドポイントジェネレータの実行
REST エンドポイントジェネレータのプロンプト
スクリプトの完了
コンフィギュレーションの完了
リソース定義ファイルのコンフィギュレーション
リソース定義ファイル
生成エンドポイントのスキーマファイルのコンフィギュレーション
スキーマファイル構文の概要
スキーマファイルにおける変更
プロパティ型の構文
追加プロパティ
生成生成エンドポイントのマッピングファイルのコンフィギュレーション
マッピングファイル構文の概要
マッピングファイルにおける変更
プロパティパスのマッピング構文
生成エンドポイントのアップデータファイルのコンフィギュレーション
アップデータファイル構文の概要
アップデータファイルにおける変更
プロパティパスのアップデータ構文
生成エンドポイントの swagger ファイルのコンフィギュレーション
swagger ファイル構文の概要
swagger ファイルにおける変更
コンフィギュレーションの完了
生成されたエンドポイントのグルーおよび実装クラスのコンフィギュレーション
生成されたエンドポイントのグルーおよび実装クラス
apiconfig ファイルのコンフィギュレーション
要素リソースファイルのコンフィギュレーション
コレクションリソースファイルのコンフィギュレーション
コンフィギュレーションの完了
生成されたエンドポイントの権限のコンフィギュレーション
生成されたエンドポイントのエンドポイントアクセスのコンフィギュレーション
role.yaml ファイルで生成されるコード
role.yaml ファイルのコードのコンフィギュレーション
生成されたエンドポイントのリソースアクセスのコンフィギュレーション
access.yaml ファイルで生成されるコード
内部ユーザー向けの生成済みリソースアクセスコード
外部ユーザー向けの生成済みリソースアクセスコード
サービス向けの生成済みリソースアクセスコード
特殊なユースケース向けの生成済みリソースアクセスコード
生成されたリソースアクセスコードのコンフィギュレーション
コンフィギュレーションの完了
生成されたエンドポイントに関するその他の考慮事項
連携グラフ
グラフスキーマファイル
グラフマッパーファイル
apiconfig ファイル内のマッピング
スーパータイプエンティティ
共有処理
個別処理
保険契約グラフエンティティ
保険契約グラフエンドポイントの作成
カスタムリソースの親としての保険契約
保険契約エンドポイントの REST エンドポイントジェネレータの差異
保険契約エンドポイントのグルーおよび実装クラスの差異のコンフィギュレーション
apiconfig ファイルの差異のコンフィギュレーション
保険契約リソースファイルの差異のコンフィギュレーション
カスタムリスクユニットの作成
リスクユニット条件
カスタムリスクユニットの REST エンドポイントジェネレータの差異
リスクユニットのグルーおよび実装クラスの差異のコンフィギュレーション
リスクユニットリソースファイルの差異のコンフィギュレーション
インライン damageable
特定のユースケースのコンフィギュレーション
バッチ処理のコンフィギュレーション
Cloud API のコンフィギュレーションによるカスタムバッチ処理の引数のサポート
BatchProcessArguments スキーマのコンフィギュレーション
BatchProcessExtResource クラスのコンフィギュレーション
住所ロケールのコンフィギュレーション
Address スキーマ内のプロパティ
addresses.i18n.yaml ファイル内のプロパティ
コンフィギュレーションタスク