Linear Relationship Candidates Response

Inspect candidate related items, applicable rules, and request status for a source line item.

JSON Example

1{
2  "lineItemId": "801xx0000012AbcAAE",
3  "offset": 0,
4  "pageSize": 25,
5  "productName": "5G Plan",
6  "relatedItems": [],
7  "rules": [],
8  "status": {"code":"200","errors":[],"message":"OK"},
9  "totalCount": 0
10}

Properties

Property Name Type Description Required or Optional Available Version
lineItemId String Source line item ID used for candidate retrieval. Optional 68.0
offset Integer Response offset value applied to this page. Optional 68.0
pageSize Integer Page size used for this response. Optional 68.0
productName String Name of the source product associated with the line item. Optional 68.0
relatedItems Object[] Candidate related line items eligible to link with the source product. Optional 68.0
rules Object[] Applicable Relies On rule records and cardinality state for the source line item. Optional 68.0
status Object Status details with request code, message, and error list. Optional 68.0
totalCount Integer Total number of available candidate items before pagination. Optional 68.0