The partialSet request option provides explicit control over whether the resultset in a successful response should be interpreted as a partial set of related records. Currently, this option only applies to requests for related records.
Example usage: A request is made to a custom relationship url and you want the records returned to be added to the relationship, rather than to replace all existing members of that relationship.
If this property is not set, then data will be implicitly treated as a partial set of related records if:
a filter option is present in the request
a page option is present in the request
a prev or next link is present in the response document's top-level links object.
The
partialSetrequest option provides explicit control over whether the resultset in a successful response should be interpreted as a partial set of related records. Currently, this option only applies to requests for related records.Example usage: A request is made to a custom relationship
urland you want the records returned to be added to the relationship, rather than to replace all existing members of that relationship.If this property is not set, then
datawill be implicitly treated as a partial set of related records if:filteroption is present in the requestpageoption is present in the requestprevornextlink is present in the response document's top-levellinksobject.