PUT: インスタンスを更新する
インスタンスを更新するには、個々のエンティティでPUTを実行し、変更するフィールドを含むJSON文字列を渡します。
インスタンスの更新方法
-
フィールドメタデータリソースを使用して、エンティティ/リソースで使用可能なフィールドを取得します。
注: エンティティに対して返されるデータには、POSTまたはPUTできない計算フィールドが含まれている場合があります。
-
変更するフィールドを含むJSON文字列を作成します。
JSON入力は、エンティティのGET操作から返されるデータと同じ形式である必要があります。
クライアントデータの正確性を検証し、偶発的なオーバーライドを回避するには、JSON文字列で、すべての更新リクエストでclient_lock_stampフィールドを送信します。詳細については、エンティティのロックを参照してください。
-
データをリソースに配置します。
-
成功すると、HTTPの戻り値は200になります。返される文字列は、更新されたエンティティの完全なデータです。
例
-
リクエスト: 更新されたフィールドを持つエンティティオブジェクト。
-
応答: 更新が成功した場合はエンティティオブジェクト、エラーが発生した場合はエラーオブジェクト。
*** Request ***
PUT .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects/1019
{ "description": "This is my new description after PUTting", "name": "This is my new name after PUTting" }
*** Response ***
{ "type": "defect", "id": "1019" }
-
リクエスト: ランクが更新された作業項目オブジェクト。
-
応答: 更新が成功した場合はエンティティオブジェクト、エラーが発生した場合はエラーオブジェクト。
作業項目のランクを設定するには、注文フィーチャーを使用して、現在の作業項目を移動する前後の作業項目のIDを指定します。
フィールド | 説明 |
---|---|
ordering | JSONオブジェクトの配列である順序付けフィーチャー。現在、配列は1つの配列値のみを持つことができます。 |
aspect | 値は常にrankです。現在、注文フィーチャーはランキングでのみ利用できます。 |
anchor | 現在の作業項目がランク付けされる前または後の相対作業項目のID。 |
position | 項目をアンカーの前または後にランク付けする必要があるかどうか。位置には、前と後の値を含めることができます。 |
制限事項: 作業項目のランク付けは、PUTリクエストを使用してサポートされます。GETリクエストでの作業項目のランクの取得はサポートされておらず、nullが返されます。
この例は、ストーリー1019をユーザーストーリー1408の後にランク付けする方法と、ストーリー1019の名前と説明を変更する方法を示しています。
*** Request ***
PUT .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/stories/1019
{ "description": "This is my new description after PUTting",
"name": "This is my new name after PUTting",
"ordering": [ { "aspect": "rank", "anchor": { "id": "1408" }, "position": "after" } ] }
*** Response: 200 OK ***
{
"type": "story",
"id": "1019"
}
この例は、スペース管理者がスペースコンテキストでPUT要求を使用して、特定のワークスペース1234の名前を変更する方法を示しています。
PUT .../api/shared_spaces/1001/workspaces/1234
{"data":[ { "name":"NewName" } ] }
参照情報: