Jump to

• Request
• Response
• Examples

Get all opportunities

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadOpportunity

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 list of opportunities created by converting the lead with the specified LeadNumber.
    Finder Variables:
    • LeadNumber; string; Shows the Lead Number.
• 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:
  

  • Account; string; The account associated with the lead.
  • Currency; string; The currency associated with the opportunity revenue amount.
  • ExpectedAmount; integer; The win probability percentage of the revenue amount.
  • LeadName; string; The lead name used for identifying the lead.
  • LeadNumber; string; The lead number of the lead from which the opportunity originated.
  • OptyCloseDate; string; The date when the opportunity closes.
  • OptyId; integer; The unique identifier of the opportunity associated with the lead.
  • OptyName; string; The name of the opportunity associated with the lead.
  • OptyNumber; string; The alternate key identifier of the opportunity associated with the lead.
  • OptyStatus; string; The status of the opportunity associated with the lead.
  • RevenueAmount; integer; The revenue amount of the opportunity associated with the lead.
  • SalesStageId; integer; The unique identifier of the sales stage of the opportunity associated with the lead.
  • SalesStageName; string; The name of the sales stage of the opportunity associated with the lead.
  • WinProbability; integer; The win probability of the opportunity associated with the lead.
• 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 Top

Response

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.

Body ()

Root Schema : leads-LeadOpportunity

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadOpportunity-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object leads-LeadOpportunity-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadOpportunity-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-LeadOpportunity-item-response

Type: object

Show Source

• Account: string
  Title: Customer Name

  Read Only: true

  The account associated with the lead.
• Currency: string
  Title: Currency

  Read Only: true

  The currency associated with the opportunity revenue amount.
• ExpectedAmount: integer
  Title: Expected Revenue

  Read Only: true

  The win probability percentage of the revenue amount.
• LeadName: string
  Title: Lead Name

  Read Only: true

  The lead name used for identifying the lead.
• LeadNumber: string
  Title: Lead Number

  Read Only: true

  The lead number of the lead from which the opportunity originated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyCloseDate: string (date-time)
  Title: Close Date

  Read Only: true

  The date when the opportunity closes.
• OptyId: integer
  Title: Opportunity ID

  Read Only: true

  The unique identifier of the opportunity associated with the lead.
• OptyName: string
  Title: Opportunity

  Read Only: true

  The name of the opportunity associated with the lead.
• OptyNumber: string
  Title: Opportunity Number

  Read Only: true

  The alternate key identifier of the opportunity associated with the lead.
• OptyStatus: string
  Title: Status

  Read Only: true

  The status of the opportunity associated with the lead.
• RevenueAmount: integer
  Title: Line Revenue

  Read Only: true

  The revenue amount of the opportunity associated with the lead.
• SalesStageId: integer
  Title: Sales Stage ID

  Read Only: true

  The unique identifier of the sales stage of the opportunity associated with the lead.
• SalesStageName: string
  Title: Name

  Read Only: true

  The name of the sales stage of the opportunity associated with the lead.
• WinProbability: integer
  Title: Win Probability

  Read Only: true

  The win probability of the opportunity associated with the lead.

{
    "type":"object",
    "properties":{
        "Account":{
            "title":"Customer Name",
            "type":"string",
            "description":"The account associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedAmount":{
            "title":"Expected Revenue",
            "type":"integer",
            "description":"The win probability percentage of the revenue amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyName":{
            "title":"Opportunity",
            "type":"string",
            "description":"The name of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyCloseDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the opportunity closes.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"The lead number of the lead from which the opportunity originated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesStageId":{
            "title":"Sales Stage ID",
            "type":"integer",
            "description":"The unique identifier of the sales stage of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevenueAmount":{
            "title":"Line Revenue",
            "type":"integer",
            "description":"The revenue amount of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the lead.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "RecentItemEntityName":"opportunities"
            },
            "x-queryable":true
        },
        "WinProbability":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The win probability of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "type":"string",
            "description":"The currency associated with the opportunity revenue amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesStageName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the sales stage of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadName":{
            "title":"Lead Name",
            "type":"string",
            "description":"The lead name used for identifying the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"The alternate key identifier of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

cURL Command

The following example shows how to get all opportunities 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/LeadOpportunity

Example of Response Body

The following example shows the contents of the response body in JSON format.

{ 
 "items" : [ {
    "LeadName" : "nov7aj1",
    "LeadNumber" : "CDRM_235875",
    "Account" : null,
    "OptyId" : 300100092363928,
    "OptyName" : "Advantage Corp (COLUMBUS, US) CDRM_47006",
    "OptyNumber" : "CDRM_335580",
    "OptyStatus" : "OPEN",
    "OptyCloseDate" : "2016-11-07T00:00:00-08:00",
    "SalesStageId" : 100000012430007,
    "SalesStageName" : "01 - Qualification",
    "WinProbability" : 0,
    "RevenueAmount" : 0,
    "Currency" : "USD",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/LeadOpportunity/CDRM_235875",
      "name" : "LeadOpportunity",
      "kind" : "item"
    }, .......
 .........
 ]
  }, {
    "LeadName" : "nov7aj1",
    "LeadNumber" : "CDRM_235875",
    "Account" : null,
    "OptyId" : 300100092516644,
    "OptyName" : "Apple Corporation",
    "OptyNumber" : "CDRM_344583",
    "OptyStatus" : "OPEN",
    "OptyCloseDate" : "2016-11-23T00:00:00-08:00",
    "SalesStageId" : 100000012430007,
    "SalesStageName" : "01 - Qualification",
    "WinProbability" : 50,
    "RevenueAmount" : 0,
    "Currency" : "USD",
    "links" : [ ....
    } ]
.........
  } ],
  "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/LeadOpportunity",
    "name" : "LeadOpportunity",
    "kind" : "Collection"
  } ]
}

Back to Top