Comparing features that execute multiple requests
The following table compares these features.
| Feature | Request inclusion | Batch requests | Composite requests |
|---|---|---|---|
|
Request architecture |
A parent request with one or more child requests | Sibling subrequests (with no parent request) | Sibling subrequests (with no parent request) |
| The endpoint to call | The endpoint that creates or modifies the parent object (though not all endpoints support request inclusion) | The relevant API's /batch endpoint |
The Composite API's /composite endpoint |
| Behavior when one subrequest that attempts to commit data fails | The entire request fails | Other subrequests may still be attempted | The entire request fails |
| Passing information between subrequests | Through the use of refids | Not possible | Through the use of variables |
| Allows GET subrequests? | No | Yes | Yes |
| Allows DELETE subrequests? | No | Yes | Yes |
Allows business action POST subrequests (such as
/assign)? |
No | Yes | Yes |
| Allows the creation or modification of two unrelated objects? | No | Yes | Yes |