Table of Contents Table of Contents Title and Copyright Information Preface Audience Documentation Accessibility Diversity and Inclusion Related Resources Conventions Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects Use Cases and Examples About the Resource Samples in This Guide Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API 2 Working with the Resource Catalog About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe Describing a Resource Collection Describing a Nested Resource 3 Working with REST API Framework Versions About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version Part II Tasks 4 CRUD Tasks Retrieving Business Objects Fetching a Business Object Fetching a Business Object with a Subset of Items Fetching a Business Object Item Paging a Business Object Sorting a Business Object Fetching a Child Business Object Fetching Data Only for a Business Object Filtering a Business Object with a Query Parameter Creating Business Object Items Creating a Business Object Item Creating an Item of a Child Business Object Updating a Business Object Item Deleting a Business Object Item 5 Data Consistency Tasks About Data Consistency Checking for Data Consistency When Updating Business Object Items Checking for Data Consistency When Retrieving Business Object Items 6 Advanced Tasks Returning the Estimated Count of Business Object Items Making Batch Requests Working with Error Responses Understanding the Exception Payload Error Response Obtaining an Exception Payload Error Response Obtaining the Standard Error Message Response Enable Polling for Endpoint Requests Reference A Links and Relations Describe links Object Structure rel Attribute Values href Attribute Value cardinality Attribute Values B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints POST Method Endpoints PATCH Method Endpoints DELETE Method Endpoints