1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Assets
  4. Asset Opportunities

Get all opportunities

get

/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetOpportunities

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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:

    • MyOpportunitiesFinder: Finds an opportunity using the opportunity name.
      Finder Variables:
      • ClosePeriod; string; The close period within which the opportunities are to be searched.
      • ContactPartyId; integer; The unique identifier of the contact for the opportunity.
      • EffectiveBeginDate; string; The date when the opportunity becomes active.
      • EffectiveEndDate; string; The date when the opportunity becomes inactive.
      • LeadNumber; string; The lead number of the lead associated with the opportunity.
      • LookupCategory; string; The status category of the opportunity status.
      • Name; string; The name of the opportunity.
      • OpportunityContactName; string; The name of the opportunity contact.
      • OptyStatusCode; string; The status of the opportunity.
      • Partner; string; The name of the opportunity partner.
      • PartnerPartyId; integer; The party ID of the partner associated with the opportunity.
      • Product; string; The product name of the opportunity revenue line.
      • ProductGroup; string; The product group name of the opportunity revenue line.
      • RecordSet; string; The search results displayed under the selected record set.
      • ReferenceName; string; The name of the opportunity reference.
      • ResourcePartyId; string; The party ID of the resource in the opportunity team.
      • TeamMember; string; The name of the resource in the opportunity team.
    • OptyNumberRowFinder: Finds an opportunity using the opportunity number.
      Finder Variables:
      • OptyNumber; string; The number of the opportunity which is the unique public identifier of the opportunity.
    • PrimaryKey: Finds an opportunity by the primary key opportunity ID.
      Finder Variables:
      • OptyId; integer; The unique identifier of the opportunity.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AccountPartyNumber; string; The party number of the sales account that owns the opportunity.
    • AssetNumber; string; The asset number of the asset of the opportunity.
    • AssetSerialNumber; string; The associated asset's serial number.
    • BudgetedFlag; boolean; Indicates if the opportunity sales account has its budget approved for the potential purchase.
    • ClosePeriod; string; The names of the filter on which opportunities can be filtered based on effective date range.
    • ConflictId; integer; This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (such as mobile databases or the server).
    • CreationDate; string; The date and time when the opportunity was created.
    • CrmConversionRate; number; This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.
    • CurrencyCode; string; The currency the opportunity amount is based on.
    • CustPartyType; string; The party type of the account associated to the opportunity. The possible values are Organization, Household and Contact.
    • EffectiveDate; string; The estimated close date for the opportunity.
    • ForecastCategory; string; Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.
    • IBAssetNumber; string; The asset number of the installed base asset of the opportunity.
    • IBAssetSerialNumber; string; The associated installed base asset's serial number.
    • KeyContactId; integer; The unique identifier of the primary contact.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LineOfBusinessCode; string; The line of business that is responsible for the opportunity.
    • LookupCategory; string; The status category of the opportunity.
    • Name; string; The name of the opportunity associated with the asset.
    • OpportunityOrigin; string; The value for the origin of the opportunity.
    • OptyCreationDate; string; The date when the opportunity was created.
    • OptyId; integer; The unique identifier of the opportunity.
    • OptyLastUpdateDate; string; The date when the opportunity was last updated.
    • OptyLastUpdatedBy; string; The user who last updated the opportunity.
    • OptyNumber; string; The alternate unique identifier of the opportunity associated with the asset.
    • OwnerPartyNumber; string; The party number of a valid employee resource who owns and manages the opportunity.
    • OwnerResourcePartyId; integer; The unique identifier of the opportunity owner.
    • PartyName1; string; The name of the opportunity owner.
    • PartyUniqueName1; string; The unique name of the primary opportunity competitor.
    • PredWinProb; number; The AI predicted win probability percent.
    • PrimaryCampaignId; integer; The unique identifier of the primary campaign of the opportunity. It is a reference key to campaign object.
    • PrimaryCampaignName; string; The name of the primary campaign of the opportunity.
    • PrimaryCampaignNumber; string; The alternate identifier for primary campaign of the opportunity.
    • PrimaryCompetitorId; integer; The unique identifier of the primary competitor of this opportunity.
    • PrimaryCompetitorPartyNumber; string; The alternate key identifier of the opportunity's primary competitor party.
    • PrimaryContactPartyName; string; The name of the primary contact.
    • PrimaryContactPartyNumber; string; The alternate key identifier of the opportunity's primary contact party.
    • PrimaryPartnerCompanyNumber; string; The alternate key identifier of the opportunity's primary partner company.
    • PrimaryPartnerId; integer; The party ID of the primary partner.
    • QuotedFlag; boolean; Indicates that a quote has been created for this opportunity.
    • ReasonWonLostCode; string; The win or loss reason of the opportunity. Valid values from the MOO_SETID_WIN_LOSS_REASON lookup type.
    • RecommendedAction; string; The AI recommended action.
    • RecordSet; string; The name of the predefined opportunity search filters.
    • SalesChannelCd; string; Indicates the sales channel for the opportunity.
    • SalesMethod; string; The sales method of the opportunity.
    • SalesMethodId; integer; The unique identifier of the sales method for this opportunity. This indicates the sales process used.
    • SalesStageId; integer; The unique identifier of the sales stage of the opportunity.
    • SetupRefCode; string; The public unique identifier for the CPQ configuration setup.
    • StatusCode; string; The status of the opportunity. Valid values from the MOO_OPTY_STATUS lookup type.
    • TargetPartyId; integer; The unique identifier of the opportunity sales account.
    • WinProb; integer; The opportunity win probability.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : assets-assetOpportunities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : assets-assetOpportunities-item-response
Type: object
Show Source
Links
assignOpportunity
Parameters:
  • AssetId: $request.path.AssetId
This method lets you assign a matched opportunity.
copyOpportunity
Parameters:
  • AssetId: $request.path.AssetId
This method lets you copy a matched opportunity.
copyOpportunityAndGetId
Parameters:
  • AssetId: $request.path.AssetId
This method lets you copy an opportunity record to a new opportunity, where the identifiers of the newly created opportunity record is returned.
createQuote
Parameters:
  • AssetId: $request.path.AssetId
This method lets you invoke a create quote process in an active Oracle CPQ Cloud integration.
Back to Top