レコードの更新
パスで指定されたエンティティのレコードに対し、リクエストボディの内容で更新する
📬 リクエスト
Section titled “📬 リクエスト”PATCH {resource_api_url}/records/{entity_name}/{id}
リクエストヘッダ
Section titled “リクエストヘッダ”| キー | 値 |
|---|---|
| Authorization | Bearer {アクセストークン} |
| Content-Type | application/json |
パスパラメータ
Section titled “パスパラメータ”| パラメータ | 形式 | 必須 | 説明 | 値の例 |
|---|---|---|---|---|
| entity_name | 文字列 | YES | 更新対象レコードのエンティティ名 | account |
| id | 文字列 | YES | 更新対象のレコードID | account-00000001 |
リクエストボディ
Section titled “リクエストボディ”レコードの作成 - リクエストボディと同内容のJSONオブジェクト
✨ 成功レスポンス
Section titled “✨ 成功レスポンス”ステータスコード
Section titled “ステータスコード”200 : OK
レスポンスヘッダ
Section titled “レスポンスヘッダ”| キー | 値 |
|---|---|
| Content-Type | application/json |
レスポンスボディ
Section titled “レスポンスボディ”| フィールド | 形式 | 必須 | 説明 | 値の例 |
|---|---|---|---|---|
| entity_name | 文字列 | YES | 更新したレコードのエンティティ名 | account |
| id | 文字列 | YES | 更新したレコードのID | account-00000001 |
レスポンスボディのサンプル
Section titled “レスポンスボディのサンプル”💬 具体的な要求事項
Section titled “💬 具体的な要求事項”- 指定されたエンティティ名・レコードIDとフィールドの値を元にレコードを更新してください
- 更新対象のレコードが存在しない場合は、「
404: Not Found」エラーを返却してください
その他(補足等)
Section titled “その他(補足等)”- UPWARDから送信されるリクエストボディには、「is_updatable」フィールドが
trueの項目のみ含まれます(falseの項目についてはサポートする必要はありません) - 必要に応じて、貴社が定める仕様に基づいてリクエストボディのバリデーションを行ってください
📚 参考資料
Section titled “📚 参考資料”なし