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/LINE_ITEM_ID/candidates

Where, LINE_ITEM_ID is a variable.

Resource Example 

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

Where, YOUR_INSTANCE is a variable.

Available Version 

68.0

HTTP Methods 

GET

Request Parameters for GET 
Parameter NameTypeDescriptionRequired or OptionalAvailable Version
lineItemIdStringSource line item ID for which candidates are retrieved.Required68.0
linkStatusStringFilter by candidate status, such as linked or unlinked.Optional68.0
offsetIntegerOffset for paginated candidate results.Optional68.0
pageSizeIntegerMaximum number of candidate items returned in one response page.Optional68.0

Response Body for GET 

Linear Relationship Candidates Response

Get Started with CME Developer Resources
Fields on Standard Objects
Standard Objects
Associated Objects
Platform Event Objects
REST Reference
Resources
Retrieve Multiple Product Details (POST)
Initiate Asset Amend (POST)
Get Linear Relationship Candidates (GET)
Manage Links (POST)
Manage Product Relationship Rules (POST)
Create Sales Transaction (POST)
Search Product Relationship Rules (GET)
Manage Product Configuration (POST)
Retrieve Product Details (POST)
Get Redeemed Coupons (GET)
Retrieve Products List (POST)
Create Order (POST)
Recipient Group
Split Quote Line Item
Request Bodies
Response Bodies
Invocable Actions
Previous Versions