Get all sales lead products
get
/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1
Request
Path Parameters
-
leadsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the Lead Product by the specified LeadProduct identifier.
Finder Variables:- LeadProductId; integer; The unique identifier of the Lead Product.
- ProdAssocNumberRF: Finds the lead products with the specified lead product number.
Finder Variables:- LeadProductNumber; string.
- ProductGroupRF: Finds the lead products with the specified lead number and product group id
Finder Variables:- LeadNumber; string; The parameter used to query the resource.
- ProductGroupId; string; The unique identifier of the product group.
- ProductRF: Finds the lead products with the specified lead number, inventory item id, and organization id.
Finder Variables:- InventoryItemId; string; The unique identifier of the inventory item.
- LeadNumber; string; The parameter used to query the resource.
- OrganizationId; string; The unique identifier of the organization.
- PrimaryKey: Finds the Lead Product by the specified LeadProduct identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Amount; number; The amount associated with the sales lead product.
- AverageTimeToClose; number; The average time to close for this sales lead product.
- ConflictId; integer; The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
- CreatedBy; string; The user who created this sales lead product.
- CreationDate; string; The date and time when this sales lead product is created.
- CurrencyCode; string; The currency code associated with the lead product line amount. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
- Description; string; The product description where the product is associated with the lead.
- EstimatedUnitPrice; number; The estimated unit price for this lead product.
- InventoryItemId; integer; The unique inventory item identifier associated with the lead product.
- ItemNumber; string; The alternate key for referenced inventory item.
- LastUpdateDate; string; The date and time of the last update of the sales lead product.
- LastUpdateLogin; string; The login of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the sales lead product.
- LeadId; integer; The unique identifier of the sales lead for this sales lead product.
- LeadNumber; string; The alternate unique identifier of the lead.
- LeadProductId; integer; The unique identifier of the current sales lead product.
- LeadProductNumber; string; The alternate key of the lead product.
- LongDescription; string; A detailed description of the sales lead product.
- OrganizationId; integer; The unique inventory organization identifier associated with this lead product.
- PrimaryFlag; boolean; Indicates whether this product is a primary product for this lead.
- ProductGroupDescription; string; A brief description of the product group.
- ProductGroupId; integer; The unique identifier of the product group.
- ProductGroupName; string; The name of the product group associated with the sales lead product resource.
- ProductGroupReferenceNumber; string; The alternate key for referenced product group.
- Quantity; number; The product quantity identified for this product on the lead.
- UOMCode; string; The unit of measure associated with this sales lead product line.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : leads-MklProdAssoc1
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-MklProdAssoc1-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount associated with the sales lead product. -
AverageTimeToClose: number
Title:
Average Time to Close
The average time to close for this sales lead product. -
ConflictId: integer
Title:
Conflict Identifier
Default Value:0
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this sales lead product. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this sales lead product is created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the lead product line amount. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Description: string
Title:
Item Description
Maximum Length:240
The product description where the product is associated with the lead. -
EstimatedUnitPrice: number
Title:
Estimated Unit Price
The estimated unit price for this lead product. -
InventoryItemId: integer
(int64)
Title:
Inventory Number
The unique inventory item identifier associated with the lead product. -
ItemNumber: string
Title:
Inventory Item Number
Read Only:true
Maximum Length:300
The alternate key for referenced inventory item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time of the last update of the sales lead product. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sales lead product. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the sales lead for this sales lead product. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate unique identifier of the lead. -
LeadProductId: integer
(int64)
Title:
Lead Product ID
The unique identifier of the current sales lead product. -
LeadProductNumber: string
Title:
Lead Product Number
Maximum Length:30
The alternate key of the lead product. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
A detailed description of the sales lead product. -
OrganizationId: integer
(int64)
Title:
Organization
The unique inventory organization identifier associated with this lead product. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether this product is a primary product for this lead. -
ProductGroupDescription: string
Title:
Product Group Description
Read Only:true
Maximum Length:1000
A brief description of the product group. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group. -
ProductGroupName: string
Title:
Product Group Name
Maximum Length:250
The name of the product group associated with the sales lead product resource. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
Maximum Length:50
The alternate key for referenced product group. -
ProductType: string
Title:
Product Type
The type of the product, such as item or product group. -
Quantity: number
Title:
Quantity
The product quantity identified for this product on the lead. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure associated with this sales lead product line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
cURL Command
The following example shows how to get all sales lead products by submitting a GET request on the REST resource using cURL.
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklProdAssoc1
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "LeadProductId": 300100092582201, "LeadId": 300100092582093, "OrganizationId": null, "CurrencyCode": "USD", "EstimatedUnitPrice": null, "InventoryItemId": null, "PrimaryFlag": true, "ProductGroupId": 999997826071175, "Quantity": null, "UOMCode": null, "Description": null, "CreatedBy": "MHoope", "CreationDate": "2016-11-07T04:24:54-08:00", "LastUpdatedBy": "MHoope", "LastUpdateDate": "2016-11-07T04:25:06-08:00", "AverageTimeToClose": null, "ProductGroupName": " Activity Hub B2C", "ProductGroupDescription": "License/Applications/CRM Applications/Siebel CRM Applications/Master Data Management - Customer Hub for B2C/ Activity Hub B2C", "LongDescription": null, "Amount": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklProdAssoc1/300100092582201", "name": "MklProdAssoc1", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, ......... ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklProdAssoc1", "name": "MklProdAssoc1", "kind": "Collection" } ] }