Get Linear Relationship Candidates (GET)

Retrieve eligible related line items and applicable Relies On rules for a source line item.

Resource

1/connect/comms-sales/linear-relationships/lineItemId/candidates

Resource Example

1https://yourInstance.salesforce.com/services/data/68.0/connect/comms-sales/linear-relationships/801xx0000012AbcAAE/candidates?linkStatus=unlinked&offset=0&pageSize=25

Available Version

68.0

HTTP Methods

GET

Request Parameters for GET

Parameter Name Type Description Required or Optional Available Version
lineItemId String Source line item ID for which candidates are retrieved. Required 68.0
linkStatus String Filter by candidate status, such as linked or unlinked. Optional 68.0
offset Integer Offset for paginated candidate results. Optional 68.0
pageSize Integer Maximum number of candidate items returned in one response page. Optional 68.0