Document Identifier: DSP0266 Date: 2021-01-18 Version: 1.11.2 Redfish Specification Document Class: Normative Document Status: Published Document Language: en-US Redfish Specification DSP0266 Copyright Notice Copyright © 2020-2021 DMTF. All rights reserved. DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. Members and non-members may reproduce DMTF specifications and documents, provided that correct attribution is given. As DMTF specifications may be revised from time to time, the particular version and release date should always be noted. Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, disclose, or identify any such third party patent rights, or for such party's reliance on the standard or incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any party implementing such standard, whether such implementation is foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held harmless by any party implementing the standard from any and all claims of infringement by a patent owner for such implementations. For information about patents held by third-parties which have notified the DMTF that, in their opinion, such patent may relate to or impact implementations of DMTF standards, visit http://www.dmtf.org/about/ policies/disclosures.php. This document's normative language is English. Translation into other languages is permitted. 2 Published Version 1.11.2 DSP0266 Redfish Specification CONTENTS 1. Acknowledgments .................................................................................................................................. 10 2. Scope ..................................................................................................................................................... 20 3. Goals ...................................................................................................................................................... 20 4. Design tenets ......................................................................................................................................... 21 5. Limitations .............................................................................................................................................. 22 6. Additional design background and rationale .......................................................................................... 22 6.1. REST-based interface........................................................................................................... 22 6.2. Data-oriented ........................................................................................................................ 23 6.3. Separation of protocol from data model................................................................................ 23 6.4. Hypermedia API Service Root .............................................................................................. 23 6.5. OpenAPI v3.0 support........................................................................................................... 23 6.6. OData conventions ............................................................................................................... 23 7. Service elements.................................................................................................................................... 24 7.1. Synchronous and asynchronous operation support.............................................................. 24 7.2. Eventing mechanism............................................................................................................. 24 7.3. Actions .................................................................................................................................. 24 7.4. Service discovery.................................................................................................................. 25 7.5. Remote access support ........................................................................................................ 25 8. Security .................................................................................................................................................. 25 9. Universal Resource Identifiers ............................................................................................................... 26 10. HTTP methods ..................................................................................................................................... 28 11. HTTP redirect ....................................................................................................................................... 29 12. Media types .......................................................................................................................................... 29 13. ETags ................................................................................................................................................... 30 14. Protocol version.................................................................................................................................... 31 15. Redfish-defined URIs and relative reference rules............................................................................... 32 16. Request headers .................................................................................................................................. 34 17. GET (read requests)............................................................................................................................. 39 17.1. Resource collection requests.............................................................................................. 40 17.2. Service Root request .......................................................................................................... 40 17.3. OData service and metadata document requests............................................................... 40 18. Query parameters ................................................................................................................................ 41 18.1. The $expand query parameter............................................................................................ 44 18.2. The $select query parameter .............................................................................................. 47 18.3. The $filter query parameter................................................................................................. 47 19. HEAD ................................................................................................................................................... 49 19.1. Data modification requests ................................................................................................. 49 19.2. Modification success responses ......................................................................................... 50 19.3. Modification error responses............................................................................................... 50 20. PATCH (update) ................................................................................................................................... 50 21. PATCH on array properties................................................................................................................... 52 Version 1.11.2 Published 3 Redfish Specification DSP0266 22. PUT (replace) ....................................................................................................................................... 53 23. POST (create) ...................................................................................................................................... 54 24. DELETE (delete) .................................................................................................................................. 55 25. POST (Action) ...................................................................................................................................... 55 26. Operation apply time ............................................................................................................................ 58 27. Deep operations ................................................................................................................................... 61 28. Response headers ............................................................................................................................... 67 29. Link header........................................................................................................................................... 70 30. Status codes........................................................................................................................................