REST API Developer Guide

Introduction to REST API
Quick Start
Examples
Getting Information About My Organization
Working with Object Metadata
Working with Records
Delete Lightning Experience Event Series
Working with Searches and Queries
Get an Image from a Rich Text Area Field
Insert or Update Blob Data
Get Blob Data
Working with Recently Viewed Information
Managing User Passwords
Working with Approval Processes and Process Rules
Using Event Monitoring
Using Composite Resources
Execute Dependent Requests in a Single API Call
Update an Account, Create a Contact, and Link Them with a Junction Object
Update a Record and Get Its Field Values in a Single Request
Upsert an Account and Create a Contact
Create Nested Records
Create Multiple Records
Using Composite Graphs
Using a Composite Graph
allOrNone Parameters in Composite and Collections Requests
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Using a Composite Graph

This example shows how to use a composite graph. It also demonstrates how one request can use more than one composite graph.

  • Regular composite requests allow you to execute a series of REST API requests in a single call. And you can use the output of one request as the input to a subsequent request.

  • Composite graphs extend regular composite requests by allowing you to assemble a more complicated and complete series of related objects and records.

  • Composite graphs also enable you to ensure that the steps in a given set of requests are either all completed or all not completed. If you use this option, you don’t have to check which requests were successful.

  • Regular composite requests have a limit of 25 subrequests. Composite graphs increase this limit to 500.

Create a request:

where the file data.json contains the definition of the graphs. The general format for the request body is:

where compositeSubrequest is a composite subrequest result.

For example, two composite graph requests each create an Account and then create related records:

The response is:

For more information, see Using Composite Graphs.