RFC 6902 - JavaScript Object Notation (JSON) Patch

Contents

• 1. Introduction
• 2. Conventions
• 3. Document Structure
• 4. Operations
  • 4.1. add
  • 4.2. remove
  • 4.3. replace
  • 4.4. move
  • 4.5. copy
  • 4.6. test
• 5. Error Handling
• 6. IANA Considerations
• 7. Security Considerations
• 8. Acknowledgements
• 9. References
  • 9.1. Normative References
  • 9.2. Informative References
• Appendix A. Examples
  • A.1. Adding an Object Member
  • A.2. Adding an Array Element
  • A.3. Removing an Object Member
  • A.4. Removing an Array Element
  • A.5. Replacing a Value
  • A.6. Moving a Value
  • A.7. Moving an Array Element
  • A.8. Testing a Value: Success
  • A.9. Testing a Value: Error
  • A.10. Adding a Nested Member Object
  • A.11. Ignoring Unrecognized Elements
  • A.12. Adding to a Nonexistent Target
  • A.13. Invalid JSON Patch Document
  • A.14. ~ Escape Ordering
  • A.15. Comparing Strings and Numbers
  • A.16. Adding an Array Value

Abstract

JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The "application/json-patch+json" media type is used to identify such patch documents.

Status of This Memo

This is an Internet Standards Track document.

This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 5741.

Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc6902.

Copyright Notice

Copyright (c) 2013 IETF Trust and the persons identified as the document authors. All rights reserved.

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.

Authors' Addresses

Paul C. Bryan (editor)
Salesforce.com

Mark Nottingham (editor)
Akamai

---

Publication Date: April 2013
Category: Standards Track
ISSN: 2070-1721