Get all opportunity leads
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead
Request
Path Parameters
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
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:- OpportunityLeadAltKeyFinder: Finds an opportunity lead based on lead or opportunity unique public identifier.
Finder Variables:- LeadNumber; string; The unique public identifier of a lead.
- OptyNumber; string; The unique public identifier of an opportunity.
- OptyLeadUserKey: Finds an opportunity lead based on lead unique public identifier or opportunity primary key.
Finder Variables:- LeadNumber; string; The unique public identifier of a lead.
- OptyId; integer; The primary key of an opportunity.
- PrimaryKey: Finds opportunity leads by the primary key.
Finder Variables:- OptyLeadId; integer; The unique identifier of the opportunity???s lead.
- OpportunityLeadAltKeyFinder: Finds an opportunity lead based on lead or opportunity unique public 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:- ConflictId; integer; The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
- CreatedByModule; string; The module through which the record was created.
- LeadId; integer; The unique identifier of the lead for the opportunity.
- LeadNumber; string; The alternate key identifier of the lead.
- OptyLeadId; integer; The unique identifier of the lead for the opportunity.
- OptyNumber; string; The number of the opportunity which is the unique public identifier of the opportunity.
-
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 : opportunities-OpportunityLead
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 : opportunities-OpportunityLead-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
ContactName: string
Title:
Contact
Read Only:true
Maximum Length:450
The name of the primary lead contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Module
Read Only:true
Maximum Length:30
The module through which the record was created. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CustomerId: integer
(int64)
Title:
Customer Identifier
Read Only:true
The unique identifier of the customer record in the TCA schema. -
CustomerName: string
Title:
Customer
Read Only:true
Maximum Length:360
The name of the customer. -
DealEstimatedCloseDate: string
(date)
Title:
Deal Registration Estimated Close Date
The date when the deal registration for the opportunity is estimated to be closed. -
DealExpirationDate: string
(date)
Title:
Deal Expiration Date
The date when the lead registration will expire. -
DealPartProgramId: integer
(int64)
Title:
Partner Program ID
The unique identifier of the partner program associated with the lead registration. -
DealSize: number
Title:
Deal Size
Read Only:true
The deal size of the deal associated with the opportunity. -
DealType: string
Title:
Lead Registration Type
Maximum Length:30
The deal or lead registration type for the opportunity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the record. -
LeadAging: integer
Title:
Age in Days
Read Only:true
The number of days elapsed since the lead was created. -
LeadId: integer
(int64)
Title:
Lead Identifier
Read Only:true
The unique identifier of the lead for the opportunity. -
LeadName: string
Title:
Lead Name
Read Only:true
Maximum Length:250
The name of the lead associated with the opportunity. -
LeadNumber: string
Title:
Lead Number
Maximum Length:64
The alternate key identifier of the lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectUsage: string
Title:
Object Usage
Maximum Length:30
Indicates whether the current record represents a lead or a deal. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyLeadId: integer
(int64)
Title:
Opportunity Lead ID
The unique identifier of the lead for the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The number of the opportunity which is the unique public identifier of the opportunity. -
PartnerTypeCd: string
Title:
Partner Type
Maximum Length:250
The code indicating the type of the partner for the lead registration. -
PrDealPartOrgPartyId: integer
(int64)
Title:
Partner Organization Party ID
The unique identifier for the partner on the lead registration. -
PrDealPartResourcePartyId: integer
(int64)
Title:
Primary Partner Resource ID
The unique identifier for the primary partner resource on the lead registration. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact Identifier
Read Only:true
The unique identifier of the sales lead contact marked as a primary lead contact. -
Rank: string
Title:
Rank
Read Only:true
Maximum Length:30
The rank of the lead associated with the opportunity. -
RankMeaning: string
Title:
Rank
Read Only:true
The meaning of the rank code for the associated lead. -
RegistrationNumber: string
Title:
Registration Number
Maximum Length:120
The unique registration number of the lead for the opportunity. -
StatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
The code indicating the status of the opportunity lead. -
StatusCodeMeaning: string
Title:
Status
Read Only:true
The meaning of the status code for the associated lead. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the opportunity lead was last updated from mobile.
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
The following example shows how to get all opportunity leads by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X @example_request_payload.json
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_332708/child/OpportunityLead/
Example of Response Body
The following shows an example of the response body in JSON format.
{ items: [1] 0: { OptyLeadId: 300100111705721 OptyId: 300100111705686 LeadNumber: "102" } }