POST への応答
POST の操作に成功するたびに、応答ペイロードを含む応答オブジェクトが生成されます。このペイロードには値が含まれる場合がありますが、リソース作成時に ClaimCenter で生成された値であり、呼び出し元アプリケーションで必要となります。次に例を示します。
- リソースのパブリック ID（システム API の
id値でもある） - 人間が読み取れる生成 ID 値（クレーム番号など）
- 以下のような、ビジネスフローによって生成された値
- リソースがアサインされたユーザーとグループ
- リソースを処理するために生成されたアクティビティ
要求スキーマと同様に、応答スキーマも、特定のパターンに従って、データエンベロープを使用してリソーススキーマをラップします。多数のインスタンスで、要求スキーマと応答スキーマが一致します。
Null 値を含むフィールドの省略
GET と同様に、POST の応答ペイロードにも、Null 以外の値を持つフィールドのみが含まれます。Null 値を含むフィールドは、応答ペイロードから省略されます。
あるフィールドが応答ペイロードにあると期待されているのに欠落している場合、その理由はたいてい、その値が Null だったためです。
POST とクエリパラメータ
POST で fields クエリパラメータを使用して、応答ペイロードに表示されるフィールドを制御できます。例えば、以下では要求ペイロードに基づいて、アクティビティ xc:20 の備考・経緯を作成します。応答ペイロードにはデフォルトのフィールドがあります。
POST /activities/xc:20/notes
以下もまた、要求ペイロードに基づいて、アクティビティ xc:20 の備考・経緯を作成します。ただし、応答ペイロードには id フィールドのみが含まれます。
POST /activities/xc:20/notes?fields=id