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

Get all opportunities

get

/crmRestApi/resources/11.13.18.05/opportunities

Request

Query Parameters
  • 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 alternate key identifier of the asset associated with the opportunity.
    • AssetSerialNumber; string; The asset serial number associated with the opportunity.
    • BudgetedFlag; boolean; Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
    • ClosePeriod; string; The names of the filter on which opportunities can be filtered based on effective date range.
    • 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.
    • CreationDate; string; The date and time when the record 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 code associated with the opportunity. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
    • CustPartyType; string; The party type of the account associated to the opportunity. The possible values are Organization, Household and Contact.
    • EffectiveDate; string; The date when the opportunity is expected to close.
    • 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 of the opportunity.
    • LastUpdateDate; string; The date when the record was last updated.
    • LineOfBusinessCode; string; The line of business that owns the opportunity.
    • LookupCategory; string; The status category of the opportunity status.
    • Name; string; The name of the opportunity.
    • 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 record was last updated.
    • OptyLastUpdatedBy; string; The user who last updated the opportunity record.
    • OptyNumber; string; The unique alternate identifier for the opportunity.
    • OwnerPartyNumber; string; The party number of a valid employee resource who owns and manages the opportunity.
    • OwnerResourcePartyId; integer; The unique identifier of a valid employee resource who owns and manages the opportunity.
    • PartyName1; string; The name of the opportunity owner.
    • PartyUniqueName1; string; The unique name of the primary competitor for the opportunity.
    • 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 for this opportunity.
    • PrimaryCompetitorPartyNumber; string; The alternate key identifier of the opportunity's primary competitor party.
    • PrimaryContactPartyName; string; The name of the opportunity's 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 unique identifier of the primary partner associated with the opportunity.
    • QuotedFlag; boolean; Indicates whether a quote has been created for this Opportunity.
    • ReasonWonLostCode; string; The code indicating the reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
    • RecommendedAction; string; The AI recommended action.
    • RecordSet; string; The name of the predefined opportunity search filters.
    • SalesChannelCd; string; The code indicating the sales channel for the opportunity. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
    • SalesMethod; string; The name of the sales method associated with the opportunity.
    • SalesMethodId; integer; The unique identifier of the sales method for this opportunity.
    • SalesStageId; integer; The unique identifier for the sales stage of the opportunity.
    • SetupRefCode; string; The public unique identifier for the CPQ configuration setup.
    • StatusCode; string; The code indicating the status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
    • TargetPartyId; integer; The unique identifier of the sales account that owns the opportunity.
    • WinProb; integer; The estimated probability of winning the opportunity.
  • 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 : opportunities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : opportunities-item-response
Type: object
Show Source
  • Title: Account Number
    Read Only: true
    Maximum Length: 30
    The party number of the sales account that owns the opportunity.
  • Object Hints
    Title: Object Hints
    The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.
  • Assessments
    Title: Assessments
    The assessments resource is used to view, create, update, and delete the assessment of an opportunity.
  • The unique identifier of the asset associated with the opportunity.
  • Title: Asset Number
    Maximum Length: 100
    The alternate key identifier of the asset associated with the opportunity.
  • Title: Asset
    The name of the asset product associated with the opportunity.
  • Title: Asset Serial Number
    Read Only: true
    Maximum Length: 100
    The asset serial number associated with the opportunity.
  • Title: Assignment Mode
    Maximum Length: 30
    Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.
  • Opportunity Attachments
    Title: Opportunity Attachments
    The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.
  • Title: Duration
    Read Only: true
    The average duration, in days, the opportunity remains in the current sales stage.
  • Title: Batch Tag
    Maximum Length: 30
    This is used for tagging opportunities for inclusion in a batch job such as batch assignment of opportunities.
  • Title: Budget Amount
    The budget amount from the sales account.
  • Title: Budget Amount Currency
    Maximum Length: 15
    The currency code for budget amount from the sales account.
  • Title: Date Budget Available
    The date when the budget will be available.
  • Title: Budgeted
    Maximum Length: 1
    Default Value: false
    Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
  • Title: Key Internal Sponsor
    Maximum Length: 1
    Default Value: false
    Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.
  • Revenue Items
    Title: Revenue Items
    The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.
  • Title: Close Period
    Read Only: true
    The names of the filter on which opportunities can be filtered based on effective date range.
  • Title: Comments
    Maximum Length: 2000
    The user-provided comments for the opportunity.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the opportunity record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Conversion Rate
    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.
  • Title: CRM Common Currency
    Read Only: true
    Maximum Length: 15
    The CRM common currency code.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the opportunity. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Billing Account
    The unique identifier of the customer account associated with the opportunity.
  • Title: Customer Type
    Maximum Length: 30
    The party type of the account associated to the opportunity. The possible values are Organization, Household and Contact.
  • Title: Estimated Deal Duration
    Maximum Length: 30
    The code indicating the estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Decision Level
    Maximum Length: 30
    The code indicating the job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Deleted
    Read Only: true
    Indicates whether the opportunity can be deleted. The default value is true.
  • Title: Sales Objective
    Maximum Length: 2000
    The description of the opportunity including the sales objective. The description is added by the Sales Representative.
  • Title: Description
    Read Only: true
    Maximum Length: 255
    The description of the sales objective of the opportunity.
  • Title: Worst Case
    Default Value: 0
    The minimum amount of revenue for the opportunity.
  • Title: Close Date
    The date when the opportunity is expected to close.
  • Title: Owner Email
    Read Only: true
    Maximum Length: 320
    The e-mail address of the employee resource that owns the opportunity.
  • Title: Expected Revenue
    Default Value: 0
    The expected revenue from the opportunity.
  • Title: Forecast Category
    Maximum Length: 30
    Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.
  • Title: Include in Forecast
    Maximum Length: 30
    Indicates whether the summary revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
  • Title: Hint Code
    Read Only: true
    Maximum Length: 10
    The AI hint code.
  • Title: Installed Base Asset
    The unique identifier of the installed base asset of the opportunity.
  • Title: Installed Base Asset Number
    Read Only: true
    Maximum Length: 80
    The asset number of the installed base asset of the opportunity.
  • Title: Installed Base Asset Serial Number
    Read Only: true
    Maximum Length: 80
    The associated installed base asset's serial number.
  • Interviews
    Title: Interviews
    The interviews resource is used to view the list of interviews related to the opportunities.
  • Title: Primary Contact
    The unique identifier of the primary contact of the opportunity.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the opportunity record.
  • Title: Last Update Login
    Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Title: Line of Business
    Maximum Length: 30
    The line of business that owns the opportunity.
  • Links
  • Title: Status Category
    Read Only: true
    Maximum Length: 30
    The status category of the opportunity status.
  • Title: Manage General Profile Data
    Read Only: true
    Indicates you can manage general opportunity information such as competitors, lead, source, contacts, references, interactions and assessments.
  • Title: Manage Restricted Profile Data
    Read Only: true
    Indicates you can manage restricted opportunity information such as sales method, sales stage, sales account, primary contact and partners.
  • Title: Manage Revenue Data
    Read Only: true
    Indicates you can manage revenue data, such as products and recurring revenue information.
  • Title: Manage Team Data
    Read Only: true
    Indicates you can manage opportunity sales team data.
  • Title: Stalled Deal Limit
    Read Only: true
    The maximum duration, in days, that an opportunity can be in sales stage before it is considered stalled.
  • Title: Name
    Maximum Length: 275
    The name of the opportunity.
  • Notes
    Title: Notes
    The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.
  • Opportunity Campaigns
    Title: Opportunity Campaigns
    The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.
  • Opportunity Competitors
    Title: Opportunity Competitors
    The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.
  • Opportunity Contacts
    Title: Opportunity Contacts
    The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.
  • Opportunity Deals
    Title: Opportunity Deals
    The opportunity deals resource is used to view the deals associated with an opportunity.
  • Opportunity Leads
    Title: Opportunity Leads
    The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.
  • Title: Opportunity Origin
    Maximum Length: 30
    Default Value: SALES_OPTY
    The value for the origin of the opportunity.
  • Opportunity Team Members
    Title: Opportunity Team Members
    The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.
  • Opportunity Rollups
    Title: Opportunity Rollups
    The opportunity rollups resource is used to view an opportunity rollup.
  • Opportunity Sources
    Title: Opportunity Sources
    The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.
  • Opportunity Stage Snapshots
    Title: Opportunity Stage Snapshots
    The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.
  • Opportunity Subscriptions
    Title: Opportunity Subscriptions
    The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.
  • Opportunity Teams
    Title: Opportunity Teams
    The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.
  • Title: Opportunity Type
    Maximum Length: 30
    Display the different types of opportunity such as new, renewal, and expansion.
  • Title: Opportunity Created By
    Maximum Length: 64
    The user who created the opportunity record.
  • Title: Opportunity Creation Date
    The date when the opportunity was created.
  • Title: Opportunity ID
    The unique identifier of the opportunity.
  • Title: Opportunity Last Updated Date
    The date when the record was last updated.
  • Title: Opportunity Last Updated By
    Maximum Length: 64
    The user who last updated the opportunity record.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity.
  • Orchestration Associations
    Title: Orchestration Associations
    The orchestrations associations resource is used to view, create, update, and delete an orchestration association.
  • Title: Owner Number
    Read Only: true
    Maximum Length: 30
    The party number of a valid employee resource who owns and manages the opportunity.
  • Title: Owner
    The unique identifier of a valid employee resource who owns and manages the opportunity.
  • Title: Owner
    Read Only: true
    Maximum Length: 360
    The name of the opportunity owner.
  • Title: Primary Competitor
    Read Only: true
    Maximum Length: 900
    The unique name of the primary competitor for the opportunity.
  • Title: Phase
    Read Only: true
    Maximum Length: 30
    Default Value: "B - Working the Deal"
    The current phase of the opportunity sales stage.
  • Title: Predicted Win Probability
    Read Only: true
    The AI predicted win probability percent.
  • Title: Primary Campaign ID
    The unique identifier of the primary campaign of the opportunity. It is a reference key to campaign object.
  • Title: Primary Campaign
    The name of the primary campaign of the opportunity.
  • Title: Primary Campaign Number
    Maximum Length: 30
    The alternate identifier for primary campaign of the opportunity.
  • Title: Primary Competitor
    The unique identifier of the primary competitor for this opportunity.
  • Title: Primary Competitor Party Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the opportunity's primary competitor party.
  • Title: Primary Contact Email
    Read Only: true
    Maximum Length: 320
    The e-mail address of the primary contact for the opportunity. You cannot use e-mail address to query opportunities.
  • Title: Primary Contact Email Preference
    Read Only: true
    Maximum Length: 255
    Indicates if the primary contact has an email preference of do not email, ok to email, or no value.
  • Title: Primary Contact Phone
    Read Only: true
    The formatted phone number of the primary contact for the opportunity.
  • Title: Primary Contact
    Read Only: true
    Maximum Length: 360
    The name of the opportunity's primary contact.
  • Title: Primary Contact Party Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the opportunity's primary contact party.
  • Title: Primary Contact Phone Preference
    Read Only: true
    Maximum Length: 255
    Indicates if the primary contact has a phone preference of do not call, ok to call, or no value.
  • Title: Business Unit ID
    The unique identifier of the business unit to which this opportunity belongs.
  • Title: Primary Partner Number
    Maximum Length: 30
    The alternate key identifier of the opportunity's primary partner company.
  • Title: Primary Partner
    The unique identifier of the primary partner associated with the opportunity.
  • Title: Primary Partner
    Maximum Length: 360
    The name of the primary partner associated with the opportunity.
  • Title: Summary Revenue Line ID
    The unique identifier of the summary revenue line for the opportunity. The summary revenue line stores the total revenue amount of the opportunity.
  • Title: Primary Subscription Id
    The unique identifier of the primary subscription of the opportunity.
  • Title: Subscription Number
    Read Only: true
    Maximum Length: 120
    The alternate identifier of primary subscription of the opportunity.
  • Title: Primary Source Number
    Maximum Length: 100
    The alternate key identifier of the primary marketing source or campaign that generated this opportunity.
  • Title: Quota Factor
    Read Only: true
    The quota factor of the opportunity sales stage.
  • Title: Quoted
    Maximum Length: 1
    Default Value: false
    Indicates whether a quote has been created for this Opportunity.
  • Title: Win Probability
    Read Only: true
    Default Value: 0
    The recommended probability of winning the opportunity in the sales stage.
  • Title: Win/Loss Reason
    Maximum Length: 30
    The code indicating the reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Recommended Action
    Read Only: true
    Maximum Length: 180
    The AI recommended action.
  • Read Only: true
    The name of the predefined opportunity search filters.
  • Title: Registered
    Maximum Length: 30
    Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No. The default value is No.
  • Title: Registration Status
    Maximum Length: 30
    The registration status of the opportunity or deal created by a partner.
  • Title: Registration Type
    Maximum Length: 30
    The registration type used by the partner to create the opportunity or deal.
  • Title: Renewal Process
    Maximum Length: 30
    The renewal process can be manual, do not renew, or automatic.
  • Title: Amount
    Default Value: 0
    The estimated revenue amount from the opportunity.
  • Opportunity Partners
    Title: Opportunity Partners
    The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.
  • Title: Level of Risk
    Maximum Length: 30
    The code indicating the risk level of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Customer Account
    Read Only: true
    Maximum Length: 900
    The unique name of the sales account that owns the opportunity.
  • Title: Sales Channel
    Maximum Length: 50
    The code indicating the sales channel for the opportunity. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
  • Title: Sales Method
    Read Only: true
    Maximum Length: 50
    The name of the sales method associated with the opportunity.
  • Title: Sales Method
    The unique identifier of the sales method for this opportunity.
  • Title: Sales Stage
    Read Only: true
    Maximum Length: 50
    The current sales stage of the opportunity.
  • Title: Sales Stage
    The unique identifier for the sales stage of the opportunity.
  • This is used during mass update scenarios from UI.
  • Title: Setup Reference Code
    Maximum Length: 80
    The public unique identifier for the CPQ configuration setup.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Source Type
    Read Only: true
    The type of the source object such as Opportunities or Partners as defined in the object metadata.
  • Title: Status
    Read Only: true
    Maximum Length: 30
    Default Value: "Open"
    The code indicating the default status for the opportunity's sales stage.
  • Title: Status
    Maximum Length: 30
    The code indicating the status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Order
    Read Only: true
    The order of the opportunity's sales stage in the sales method.
  • Title: Strategic Value
    Maximum Length: 30
    The code indicating the strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Account
    The unique identifier of the sales account that owns the opportunity.
  • Title: Account
    Read Only: true
    Maximum Length: 360
    The name of the sales account that owns the opportunity.
  • Title: Account Country
    Read Only: true
    Maximum Length: 2
    The country of the primary account's primary address.
  • Title: Updated
    Read Only: true
    Indicates whether the opportunity can be updated. The default value is true.
  • Title: Best Case
    Default Value: 0
    The maximum amount of revenue for the opportunity.
  • Title: Win Probability
    The estimated probability of winning the opportunity.
  • Win Probability Details
    Title: Win Probability Details
    The win probability details resource is used to view the details of the winning probability of an opportunity.
Nested Schema : Object Hints
Type: array
Title: Object Hints
The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.
Show Source
Nested Schema : Assessments
Type: array
Title: Assessments
The assessments resource is used to view, create, update, and delete the assessment of an opportunity.
Show Source
Nested Schema : Opportunity Attachments
Type: array
Title: Opportunity Attachments
The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.
Show Source
Nested Schema : Revenue Items
Type: array
Title: Revenue Items
The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.
Show Source
Nested Schema : Interviews
Type: array
Title: Interviews
The interviews resource is used to view the list of interviews related to the opportunities.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.
Show Source
Nested Schema : Opportunity Campaigns
Type: array
Title: Opportunity Campaigns
The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.
Show Source
Nested Schema : Opportunity Competitors
Type: array
Title: Opportunity Competitors
The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.
Show Source
Nested Schema : Opportunity Contacts
Type: array
Title: Opportunity Contacts
The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.
Show Source
Nested Schema : Opportunity Deals
Type: array
Title: Opportunity Deals
The opportunity deals resource is used to view the deals associated with an opportunity.
Show Source
Nested Schema : Opportunity Leads
Type: array
Title: Opportunity Leads
The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.
Show Source
Nested Schema : Opportunity Team Members
Type: array
Title: Opportunity Team Members
The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.
Show Source
Nested Schema : Opportunity Rollups
Type: array
Title: Opportunity Rollups
The opportunity rollups resource is used to view an opportunity rollup.
Show Source
Nested Schema : Opportunity Sources
Type: array
Title: Opportunity Sources
The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.
Show Source
Nested Schema : Opportunity Stage Snapshots
Type: array
Title: Opportunity Stage Snapshots
The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.
Show Source
Nested Schema : Opportunity Subscriptions
Type: array
Title: Opportunity Subscriptions
The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.
Show Source
Nested Schema : Opportunity Teams
Type: array
Title: Opportunity Teams
The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.
Show Source
Nested Schema : Orchestration Associations
Type: array
Title: Orchestration Associations
The orchestrations associations resource is used to view, create, update, and delete an orchestration association.
Show Source
Nested Schema : Opportunity Partners
Type: array
Title: Opportunity Partners
The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Win Probability Details
Type: array
Title: Win Probability Details
The win probability details resource is used to view the details of the winning probability of an opportunity.
Show Source
Nested Schema : opportunities-AiObjectHints-item-response
Type: object
Show Source
Nested Schema : opportunities-Assessments-item-response
Type: object
Show Source
Nested Schema : Assessment Answer Groups
Type: array
Title: Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment.
Show Source
Nested Schema : opportunities-Assessments-AssessAnswerGroups-item-response
Type: object
Show Source
Nested Schema : Assessment Answers
Type: array
Title: Assessment Answers
The assessment answers resource is used to view and update a response to a question in the question group.
Show Source
Nested Schema : opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response
Type: object
Show Source
Nested Schema : opportunities-Attachment-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-item-response
Type: object
Show Source
  • Title: Actual Close Date
    The date when the revenue line was closed.
  • Title: Divide Amount by Transactions
    Maximum Length: 1
    The amounts are divided by the number of transactions based on the set schedule.
  • Title: Asset
    Identifier of the asset associated to the Revenue Line.
  • Title: Business Unit
    The unique identifier of the Business Unit that owns the opportunity.
  • Title: Revenue in Corporate Currency
    Read Only: true
    The calculated revenue amount in corporate currency.
  • Child Split Revenues
    Title: Child Split Revenues
    The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
  • Title: Win/Loss Reason
    Maximum Length: 30
    The code indicating the reason for winning or losing the revenue. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON.
  • Title: Line Comments
    Maximum Length: 250
    The user-provided comments for the revenue line.
  • Title: Forecast
    Maximum Length: 1
    Indicates if the revenue line should be used for forecasting. If the value is true, then the revenue line should be used for forecasting. The default value is False.
  • Title: Competitor Party Name
    Read Only: true
    Maximum Length: 360
    The party name of the primary competitor of this child revenue.
  • 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.
  • Title: Contract End Date
    The end date of the contract for the quote.
  • Title: Contract Start Date
    The start date of the contract for the quote.
  • Title: Conversion Rate
    The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.
  • Title: Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
  • Title: Cost
    Default Value: 0
    The cost amount for the opportunity.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the child revenue record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Credit Recipient Partner
    The unique identifier of the credit recipient partner organization party.
  • Title: CRM Conversion Rate
    The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.
  • Title: CRM Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
  • Title: Currency
    Maximum Length: 15
    The common CRM currency code.
  • Title: Sales Stage
    Read Only: true
    The sales stage identifier of this revenue line.
  • Title: Revenue Customer Account ID
    The unique identifier of the customer account that owns the opportunity.
  • Title: Account Registry ID
    Read Only: true
    Maximum Length: 30
    The name of the opportunity account registry ID.
  • Read Only: true
    Indicates whether the opportunity revenue can be deleted. The default value is true.
  • Title: Product
    Maximum Length: 240
    The user-provided description of the product associated with the revenue.
  • Title: Discount
    The discount percent.
  • Title: Worst Case
    Default Value: 0
    The minimum amount of revenue for the opportunity.
  • Title: Close Date
    The date when the child revenue closes. The default value is the opportunity's close date.
  • Read Only: true
    The end date for the territory owner.
  • Read Only: true
    The start date for the territory owner.
  • Title: Expected Revenue
    Default Value: 0
    The maximum amount of revenue for the opportunity.
  • Title: Expected Delivery Date
    The date when the product in the opportunity is expected to be delivered. This is used only for opportunities that include products.
  • Title: External Asset Key
    Maximum Length: 255
    The asset key from an external system.
  • Title: External Parent Asset Key
    Maximum Length: 255
    The root asset key of the parent from an external system.
  • Title: External Root Asset Key
    Maximum Length: 255
    The root asset key obtained from an external system.
  • Title: Forecast Category
    Maximum Length: 30
    Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.
  • Title: Include in Forecast
    Maximum Length: 30
    The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
  • Title: Product
    The unique identifier of the product in the inventory.
  • Title: Product
    The unique identifier of the organization in the inventory.
  • Title: Item Number
    Read Only: true
    Maximum Length: 300
    The alternate key identifier of the product that is associated with the revenue.
  • Title: Item Number Internal
    Maximum Length: 300
    The unique internal identifier of the product that is associated with the revenue.
  • Title: Update Date
    Read Only: true
    The date when the record was last updated.
  • Title: Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Margin
    Default Value: 0
    The margin amount for the opportunity.
  • Title: Monthly Recurring Revenue
    The monthly recurring revenue on the revenue line.
  • Title: Monthly Usage Revenue
    The monthly usage revenue on the revenue line.
  • Title: Forecast Territory
    Read Only: true
    Maximum Length: 60
    The name of the territory.
  • Title: Nonrecurring Revenue
    The non recurring revenue amount associated with the revenue line.
  • Title: Allocation Style
    Maximum Length: 30
    The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.
  • Title: Opportunity Creation Date
    Read Only: true
    The date and time when the opportunity was created.
  • Title: Opportunity Currency
    Read Only: true
    Maximum Length: 15
    The currency code associated with the opportunity. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Opportunity Owner
    Read Only: true
    Maximum Length: 360
    The name of the opportunity owner.
  • Title: Owner
    Read Only: true
    The unique identifier of a valid employee resource who owns and manages the opportunity.
  • Title: Primary Source
    Read Only: true
    Maximum Length: 100
    The alternate key identifier of the primary marketing source or campaign that generated this opportunity.
  • Title: Opportunity Close Date
    Read Only: true
    The date when the opportunity is expected to close.
  • Title: Revenue Opportunity ID
    The unique identified of the opportunity.
  • Title: Opportunity Last Update Date
    Read Only: true
    The date when the opportunity record was last updated.
  • Title: Opportunity Lead
    The unique Identifier of the lead associated with opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity associated to child revenue.
  • Title: Organization
    The unique identifier of the organization to which the product belongs.
  • Title: Effective End Date
    The date when the owner deal expires.
  • Title: Effective Start Date
    The date when the owner deal starts.
  • Title: Lock Credit Owner
    Maximum Length: 1
    Default Value: false
    Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked. The default value is N.
  • Title: Owner Number
    Read Only: true
    Maximum Length: 30
    The party number for the owner of child revenue.
  • Title: Parent Revenue ID
    The unique identifier of the parent revenue line, used for Lineset functionality.
  • Title: Lead Registration Type
    Maximum Length: 100
    The code indicating the type of partner engagement.
  • Title: Partner Organization Party ID
    Read Only: true
    The unique identifier of the primary revenue partner party.
  • Title: Partner
    Read Only: true
    Maximum Length: 360
    The name of the primary partner associated with the child revenue.
  • Title: Sales Credit Recipient
    Read Only: true
    Maximum Length: 360
    The name of this sales credit recipient.
  • Title: Competitor
    The unique identifier of the primary competitor of this child revenue.
  • Title: Price Type
    Maximum Length: 30
    The code indicating the type of pricing associated with the revenue line. The list of valid values are Mixed, Usage, Recurring, and One Time.
  • Title: Primary Competitor Party Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the primary competitor of this child revenue.
  • Title: Primary Contact Party ID
    Read Only: true
    The unique identifier of the primary contact of this child revenue.
  • Title: Primary Contact
    Read Only: true
    Maximum Length: 360
    The name of the primary contact of this child revenue.
  • Title: Primary
    Maximum Length: 1
    Indicates if the revenue is the primary revenue. If the value is true, then the revenue is the primary revenue among all the child revenues. The default value is False.
  • Read Only: true
    The name of the business unit to which this revenue line belongs.
  • Title: Primary Partner Number
    Maximum Length: 30
    The alternate key identifier of the revenue's primary partner company.
  • Title: Product Group
    The unique identifier of the product group.
  • Title: Product Group Model Attributes
    Read Only: true
    Maximum Length: 4000
    The model configuration attributes associated with the product group in revenue line.
  • Title: Product Group Model Family
    Read Only: true
    Maximum Length: 1000
    The model family associated with the product group.
  • Title: Product Group Model Line
    Read Only: true
    Maximum Length: 1000
    The model line associated with the product group.
  • Title: Product Group Model
    Read Only: true
    Maximum Length: 1000
    The model name associated with the product group in revenue line.
  • Title: Product Group
    Maximum Length: 250
    The name of the product group associated with the revenue.
  • Title: Quotable
    Read Only: true
    Maximum Length: 1
    Indicates whether a product group is quotable.
  • Title: Configurable Product
    Read Only: true
    Maximum Length: 1
    Indicates whether a product allows configuration.
  • Title: Product Group Reference Number
    Maximum Length: 50
    The reference number of the product group.
  • Product Groups
    Title: Product Groups
    The product group resource is used to view the product groups associated with an opportunity. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
  • Title: Product Model Attributes
    Read Only: true
    Maximum Length: 4000
    The model configuration attributes associated with the product in revenue line.
  • Title: Product Model Family
    Read Only: true
    Maximum Length: 1000
    The model family associated with the product.
  • Title: Product Model Line
    Read Only: true
    Maximum Length: 1000
    The model line associated with the product.
  • Title: Product Model
    Read Only: true
    Maximum Length: 1000
    The model name associated with the product in revenue line.
  • Products
    Title: Products
    The products resource is used to view the products associated with an opportunity.
  • Title: Product Type
    The type of product on the revenue line, such as item or product group.
  • Title: Partner
    The unique identifier of the primary revenue partner organization party.
  • Title: Forecast Territory
    The unique identifier of the primary territory for this revenue item.
  • Title: Manually Assigned Territory Version ID
    The version ID of a territory that is to be manually assigned to the revenue record.
  • Title: Quantity
    The quantity of product for this opportunity.
  • Title: Record Set
    Read Only: true
    The name of the predefined opportunity search filters.
  • Title: Recurring Worst Case
    The minimum revenue amount from the recurrence.
  • Title: End By
    The date when the child revenue recurrence ends.
  • Title: Frequency
    Maximum Length: 30
    The code that indicates the frequency of recurrence for the child revenue. A list of valid values is defined in the lookup MOO_RECURRING_FREQUENCY.
  • Title: End After
    The number of times the child revenue should recur.
  • Title: Recurring Revenue Parent ID
    The unique identifier for the parent revenue of the recurring revenue lines.
  • Title: Recurrence Period or End Date Code
    Default Value: EndAfter
    The code that indicates if a date or the number of recurrences are specified to end the recurrences.
  • Title: Recurring Quantity
    The quantity of the child revenue recurrence.
  • Title: Recurring Revenue
    The recurring revenue amount on the revenue line.
  • Title: Scheduled Revenue Amount
    The amount of revenue from the child revenue recurrence.
  • Recurring Revenues
    Title: Recurring Revenues
    The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
  • Title: Start Date
    The date when the recurrence starts.
  • Title: Recurrence Type Code
    Maximum Length: 30
    The code indicating if the line is a standard revenue line or a recurring revenue line. A list of valid values is defined in the lookup MOO_REVN_RECUR_TYPE.
  • Title: Recurring Estimated Price
    The price of each child revenue recurrence.
  • Title: Recurring Best Case
    The maximum revenue amount from the recurrence.
  • Title: Owner
    The unique identifier of the revenue owner.
  • Opportunity Revenue Territories
    Title: Opportunity Revenue Territories
    The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
  • Title: Revenue Type Category
    Maximum Length: 30
    The revenue category type on the opportunity revenue line.
  • Title: Amount
    Default Value: 0
    The amount of revenue that is earned from this opportunity.
  • Title: Line Currency
    Maximum Length: 15
    The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
  • Title: Revenue Category
    Maximum Length: 30
    The code indicating the revenue category used in Revenue Line Set functionality. A list of valid values is defined in the lookup MOO_REVN_CATEGORY.
  • Title: Creation Date
    The date when the revenue item was created.
  • Title: Revenue ID
    The unique identifier of the revenue for the opportunity.
  • Title: Update Date
    The date and time when the revenue record was last updated.
  • Title: Revenue Line Type Code
    Maximum Length: 30
    The code indicating the type of revenue line, such as Opportunity Summary Revenue, Standard Revenue, and so on. A list of valid values is defined in the lookup MOO_REVN_LINE_TYPE.
  • Title: Revenue Number
    Maximum Length: 30
    The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
  • Title: Line Set
    The revenue sequence number.
  • Title: Account
    The unique identifier of the opportunity sales account.
  • Title: Sales Channel
    Maximum Length: 50
    The code indicating the sales channel for the child revenue. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
  • Title: Sales Credit Type
    Maximum Length: 30
    Default Value: QUOTA
    The code indicating the type of the sales credit, such as quota or non-quota. A list of valid values is defined in the lookup MOO_SALES_CREDIT_TYPE.
  • Title: Sales Method
    Read Only: true
    The unique identifier of the sales method for this revenue line.
  • Title: Schedule Action
    The transient attribute. Web services need to pass a value to indicate the action to be taken on recurring schedule such as create, delete, extend, and replace.
  • Title: Nonrecurring Amount for Schedule
    The non recurring amount based on the set schedule.
  • Title: Recurring Amount for Schedule
    The recurring amount based on the set schedule.
  • Title: Usage Amount for Schedule
    The usage amount based on the set schedule.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Split Parent Revenue ID
    The unique identifier of the split parent revenue.
  • Title: Sales Credit
    The percentage of split revenue.
  • Title: Split Type Code
    Maximum Length: 30
    The code indicating the Split type of the Revenue, such as ParentSplit or ChildSplit. A list of valid values is defined in the lookup MOO_REVN_SPLIT_TYPE.
  • Title: Opportunity Status
    Read Only: true
    Maximum Length: 30
    The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Status
    Maximum Length: 30
    The unique code indicating the status of the child revenue. A list of valid values is defined in the lookup OPTY_STATUS.
  • Title: Subscription Id
    The unique identifier of the subscription.
  • Title: Subscription Line Id
    The unique identifier of the subscription line within a subscription.
  • Title: Opportunity Revenue
    Read Only: true
    Default Value: 0
    The revenue amount associated with the summary revenue line.
  • Title: Opportunity Summary Revenue in Corporate Currency
    Read Only: true
    The calculated opportunity amount in corporate currency.
  • Title: Opportunity Worst Case
    Read Only: true
    Default Value: 0
    The minimum amount of the summary revenue line for the opportunity.
  • Title: Opportunity Best Case
    Read Only: true
    Default Value: 0
    The maximum amount of the summary revenue line for the opportunity.
  • Title: Account Party ID
    The unique identifier of the sales account that owns the opportunity.
  • Read Only: true
    The unique identifier of the organization the territory owner of this revenue line belongs to.
  • Title: Forecast Territory Owner
    Read Only: true
    Maximum Length: 360
    The party name for the territory owner of this revenue line.
  • Title: Resource ID
    Read Only: true
    The unique identifier for the territory owner of this revenue line.
  • Title: Close Period
    Read Only: true
    The names of the filter on which opportunities can be filtered based on effective date range.
  • Title: Revenue Type
    Maximum Length: 30
    The code indicating the type of revenue earned from this opportunity. A list of valid values is defined in the lookup MOO_SETID_REVENUE_TYPE.
  • Title: Estimated Price
    The estimated unit price for the product.
  • Title: UOM
    Maximum Length: 3
    The unit of measure code for the product.
  • Read Only: true
    Indicates whether the revenue line can be updated. If the value is Y, then the note can be updated. The default value is Y.
  • Title: Best Case
    Default Value: 0
    The maximum amount of revenue for the opportunity.
  • Title: Usage Revenue
    The usage revenue amount on the revenue line.
  • Title: Win Probability
    The estimated probability of winning the opportunity.
Nested Schema : Child Split Revenues
Type: array
Title: Child Split Revenues
The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
Show Source
Nested Schema : Product Groups
Type: array
Title: Product Groups
The product group resource is used to view the product groups associated with an opportunity. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
Show Source
Nested Schema : Products
Type: array
Title: Products
The products resource is used to view the products associated with an opportunity.
Show Source
Nested Schema : Recurring Revenues
Type: array
Title: Recurring Revenues
The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
Show Source
Nested Schema : Opportunity Revenue Territories
Type: array
Title: Opportunity Revenue Territories
The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-ChildRevenue-ChildSplitRevenue-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-productGroups-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-products-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-RecurringRevenue-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-RevenueTerritory-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-ChildRevenue-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-ChildRevenue-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-ChildRevenue-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-Interviews-item-response
Type: object
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-Interviews-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-Interviews-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-Interviews-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-Interviews-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-Note-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship that is populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the note record.
  • Title: Creation Date
    Read Only: true
    The date and time when the note record was created.
  • Title: Creator Party ID
    The unique party identifier for the note creator.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Delete Indicator
    Read Only: true
    Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.
  • Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Read Only: true
    The formatted address of the user who created the note.
  • Read Only: true
    The formatted phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    The date when the note data was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Note ID
    Read Only: true
    The unique identifier of a note for the opportunity.
  • Maximum Length: 30
    The system generated number. It can be generated from external system also (user key).
  • Title: Title
    Maximum Length: 500
    The user provided title for the note.
  • Title: Note
    The column which stores the actual note text.
  • Title: Type
    Maximum Length: 30
    The code used to classify a note, as asset or adjustment.
  • Title: Parent Note ID
    The identifier for the parent note.
  • Read Only: true
    The unique Identifier of the party to which the note is associated.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    The name of party associated with the opportunity.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Related Object Type
    Maximum Length: 30
    The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
  • Title: Related Object
    Maximum Length: 64
    The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, and so on.
  • Title: Source System
    Maximum Length: 30
    This is the source object code for the source object as defined in OBJECTS Metadata.
  • Title: Update Indicator
    Read Only: true
    Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal or external.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-Note-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-Note-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-Note-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-Note-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-OpportunityCampaigns-item-response
Type: object
Show Source
  • Title: End Date
    Read Only: true
    The date when marketing integration campaign ends.
  • Title: Campaign ID
    The unique identifier of the campaign.
  • Title: Campaign Name
    Read Only: true
    Maximum Length: 100
    The campaign to which the current opportunity belongs.
  • Title: Campaign Number
    Maximum Length: 30
    The opportunity campaign number public surrogate key for OPTY_CAMPAIGN_NUMBER table.
  • Title: Start Date
    Read Only: true
    The date when marketing integration campaign starts.
  • Title: Status
    Read Only: true
    Maximum Length: 30
    Default Value: ORA_DRAFT
    The status of marketing integration campaign.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    The type of marketing integration campaign.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the opportunity campaign record.
  • Title: Creation Date
    Read Only: true
    The date and time when this record is created.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the opportunity campaign data was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date and time when this record is created.
  • Links
  • Title: Opportunity Campaign ID
    The unique identifier of the opportunity campaign.
  • Title: Opportunity Campaign Number
    Maximum Length: 30
    The unique alternate identifier for the Opportunity Campaign.
  • Title: Opportunity ID
    The unique identifier of the opportunity. It is the reference key to opportunity header.
  • Title: Opportunity Number
    Maximum Length: 30
    The alternate identifier for current opportunity.
  • Title: Primary
    Indicates whether the campaign is primary for the opportunity.
  • Title: Revenue Percentage
    To store the percentage value of the opportunity's revenue shared by one or more campaigns.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityCampaigns-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityCampaigns-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-OpportunityCampaigns-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-OpportunityCampaigns-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-OpportunityCompetitor2-item-response
Type: object
Show Source
  • Title: Party ID
    The unique identifier for the competitor party.
  • Title: Comments
    Maximum Length: 2000
    The user-provided comments about the opportunity's competitor.
  • Title: Competitor Party Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the competitor party.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the contact record was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Links
  • Title: Opportunity Name
    Read Only: true
    Maximum Length: 275
    The name of the opportunity.
  • Title: Opportunity Competitor ID
    The unique identifier for the competitor of the opportunity.
  • Title: Opportunity ID
    The unique identifier for the opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The number of the opportunity which is the unique public identifier of the opportunity.
  • Title: Competitor
    Maximum Length: 360
    The name of the party.
  • Title: Primary
    Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Threat Level
    Maximum Length: 30
    The code indicating the level of threat or risk from the competitor. The list of valid values are Low, Medium, and High. A list of accepted values is defined in the lookup Competitor Threat Level. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityCompetitor2-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityCompetitor2-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-OpportunityCompetitor2-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-OpportunityCompetitor2-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-OpportunityContact-item-response
Type: object
Show Source
  • Title: Affinity Level
    Maximum Length: 30
    The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Comments
    Maximum Length: 255
    The textual comments about the contact on the current opportunity.
  • 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.
  • Title: Contacted
    Maximum Length: 1
    Default Value: N
    Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.
  • Title: Opportunity Contact First Name
    Read Only: true
    Maximum Length: 150
    The first name of the contact for the opportunity.
  • Title: Opportunity Contact Last Name
    Read Only: true
    Maximum Length: 150
    The last name of the contact for the opportunity.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the opportunity contact party.
  • The unique identifier of the contact point for an opportunity contact.
  • Read Only: true
    Maximum Length: 64
    The user who created the opportunity contact record.
  • Read Only: true
    The date and time when the contact record was created.
  • Title: Do Not Contact
    Read Only: true
    Maximum Length: 1
    Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False.
  • Title: Email
    Read Only: true
    The e-mail address of the contact.
  • Title: Email Preference
    Read Only: true
    Maximum Length: 255
    Indicates if the opportunity contact has an email preference of do not email, ok to email, or no value.
  • Title: Address
    Read Only: true
    Maximum Length: 255
    The formatted address of the contact.
  • Title: Phone
    Read Only: true
    The formatted phone number of the contact.
  • Title: Influence Level
    Maximum Length: 30
    The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Title
    Read Only: true
    Maximum Length: 100
    The free form text for job title of the opportunity contact.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Links
  • Title: Contact ID
    The unique identifier of the contact associated with the opportunity.
  • Title: Opportunity
    The unique identifier of the opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity.
  • Read Only: true
    The unique identifier of the contact's organization.
  • Title: Organization
    Read Only: true
    Maximum Length: 360
    The name of the contact's organization.
  • Read Only: true
    The unique identifier of the organization contact for the opportunity.
  • Title: Opportunity Contact Name
    Read Only: true
    Maximum Length: 360
    The name of the contact for the opportunity.
  • Title: Related Account
    Read Only: true
    Maximum Length: 900
    The unique contact name displayed on party related screens. The default value for Contacts is the concatenation of attributes ContactName and UniqueNameSuffix. The default value for Organizations is the concatenation of the unique name alias and UniqueNameSuffix.
  • Title: Opportunity Contact
    The party identifier of the opportunity contact.
  • Title: Job Title
    Read Only: true
    Maximum Length: 100
    The job title of the contact person.
  • Title: Phone Preference
    Read Only: true
    Maximum Length: 255
    Indicates if the opportunity contact has a phone preference of do not call, ok to call, or no value.
  • Title: Preferred Contact Method
    Read Only: true
    Maximum Length: 30
    The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
  • Title: Primary
    Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.
  • Title: Relationship Code
    Read Only: true
    Maximum Length: 30
    The code indicating whether it's a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.
  • The identifier of the relationship for the opportunity contact.
  • Title: Function
    Maximum Length: 30
    The code identifying the roles played by a contact in the opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Affinity
    Read Only: true
    Maximum Length: 30
    The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Buying Role
    Read Only: true
    Maximum Length: 30
    The code identifying the roles played by a contact in the buying process. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Influence Level
    Read Only: true
    Maximum Length: 30
    The code indicating the influence the opportunity contact has on the buying process of the current opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityContact-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityContact-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-OpportunityContact-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-OpportunityContact-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-OpportunityDeal-item-response
Type: object
Show Source
  • Title: Approved Date
    Read Only: true
    The date and time when deal was approved.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the opportunity deal record.
  • Title: Creation Date
    Read Only: true
    The date and time when the opportunity deal record was created.
  • Title: Expiration Date
    Read Only: true
    The date and time when the deal is set to expire.
  • Title: Deal ID
    The unique identifier of the deal.
  • Title: Deal Name
    Read Only: true
    Maximum Length: 250
    The name of the opportunity deal.
  • Title: Registration Number
    Maximum Length: 30
    The alternate key identifier of the deal registration.
  • Title: Deal Size
    Read Only: true
    The size of the deal associated with the opportunity.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the opportunity deal record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the opportunity deal record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated with the user who last updated the opportunity deal record.
  • Links
  • Title: Opportunity Deal ID
    Read Only: true
    The unique identifier of the opportunity deal.
  • Title: Opportunity ID
    The unique identifier of the opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity.
  • Title: Partner ID
    Read Only: true
    The unique identifier of the partner tracked in the deal.
  • Title: Partner
    Read Only: true
    Maximum Length: 360
    The name of the partner.
  • Title: Status
    Read Only: true
    Maximum Length: 30
    The code indicating the status of the opportunity deal. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.
Nested Schema : opportunities-OpportunityLead-item-response
Type: object
Show Source
  • 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.
  • Title: Contact
    Read Only: true
    Maximum Length: 450
    The name of the primary lead contact.
  • Title: Converted by Party Identifier
    The user party identifier who converted the lead to opportunity record.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Created by Module
    Read Only: true
    Maximum Length: 30
    The module through which the record was created.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Customer Identifier
    Read Only: true
    The unique identifier of the customer record in the TCA schema.
  • Title: Customer
    Read Only: true
    Maximum Length: 360
    The name of the customer.
  • Title: Deal Registration Estimated Close Date
    The date when the deal registration for the opportunity is estimated to be closed.
  • Title: Deal Expiration Date
    The date when the lead registration will expire.
  • Title: Partner Program ID
    The unique identifier of the partner program associated with the lead registration.
  • Title: Deal Size
    Read Only: true
    The deal size of the deal associated with the opportunity.
  • Title: Lead Registration Type
    Maximum Length: 30
    The deal or lead registration type for the opportunity.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Title: Age in Days
    Read Only: true
    The number of days elapsed since the lead was created.
  • Title: Lead Identifier
    Read Only: true
    The unique identifier of the lead for the opportunity.
  • Title: Lead Name
    Read Only: true
    Maximum Length: 250
    The name of the lead associated with the opportunity.
  • Title: Lead Number
    Maximum Length: 64
    The alternate key identifier of the lead.
  • Links
  • Title: Object Usage
    Maximum Length: 30
    Indicates whether the current record represents a lead or a deal.
  • Title: Opportunity ID
    The unique identifier of the opportunity.
  • Title: Opportunity Lead ID
    The unique identifier of the lead for the opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The number of the opportunity which is the unique public identifier of the opportunity.
  • Title: Partner Type
    Maximum Length: 250
    The code indicating the type of the partner for the lead registration.
  • Title: Partner Organization Party ID
    The unique identifier for the partner on the lead registration.
  • Title: Primary Partner Resource ID
    The unique identifier for the primary partner resource on the lead registration.
  • Title: Primary Contact Identifier
    Read Only: true
    The unique identifier of the sales lead contact marked as a primary lead contact.
  • Title: Rank
    Read Only: true
    Maximum Length: 30
    The rank of the lead associated with the opportunity.
  • Title: Rank
    Read Only: true
    The meaning of the rank code for the associated lead.
  • Title: Registration Number
    Maximum Length: 120
    The unique registration number of the lead for the opportunity.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Status
    Read Only: true
    Maximum Length: 30
    The code indicating the status of the opportunity lead.
  • Title: Status
    Read Only: true
    The meaning of the status code for the associated lead.
  • Title: User Last Update Date
    The date and time when the opportunity lead was last updated from mobile.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityLead-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityLead-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-OpportunityLead-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-OpportunityLead-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-OpportunityResource-item-response
Type: object
Show Source
  • Title: Access
    Maximum Length: 30
    The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Territory
    The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.
  • Title: Assignment Type
    Read Only: true
    The code indicating how the resource is assigned to the sales account team. A list of accepted values are defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • 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.
  • Read Only: true
    Maximum Length: 64
    The user who created the opportunity resource record.
  • Read Only: true
    The date and time when the resource record was created.
  • Title: Deal Protected to Date
    The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
  • Title: Deal Protected
    Read Only: true
    Indicates if the resource is under deal protection. If the value is True, then the resource is under deal protection. The default value is False.
  • Title: Deal Protected from Date
    The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The e-mail address of the opportunity team member.
  • Title: Phone
    Read Only: true
    The formatted phone number of the opportunity team member.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Links
  • Title: Lock Assignment
    Maximum Length: 1
    Default Value: true
    Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
  • Title: Function
    Maximum Length: 30
    The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Read Only: true
    The unique identifier of the resource team member's manager.
  • The unique Identifier of the opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity.
  • Title: Opportunity Resource ID
    The unique party identifier for the existing opportunity resource.
  • Title: Opportunity Resource Number
    Maximum Length: 30
    The alternate key identifier of the opportunity resource.
  • Title: Primary
    Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.
  • Title: Name
    The unique identifier of the partner organization.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the partner associated with the partner resource.
  • Title: Team Member
    Read Only: true
    Maximum Length: 360
    The name of the opportunity team member.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The first name of the opportunity team member.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The last name of the opportunity team member.
  • Title: Team Member
    The unique party identifier for the existing resource.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the opportunity resource party.
  • Title: Role
    Read Only: true
    Maximum Length: 60
    The role of the opportunity team member in the resource organization.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Territory
    Read Only: true
    Maximum Length: 60
    The name of the opportunity team member's territory.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityResource-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-OpportunityResource-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-OpportunityResource-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-OpportunityResource-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-OpportunityRollup-item-response
Type: object
Show Source
  • Title: Total Calls Made
    Read Only: true
    The total number of outbound calls made in context of the opportunity.
  • Title: Corporate Currency Code
    Read Only: true
    Maximum Length: 15
    The corporate currency code of the note associated with the rollup. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the row.
  • Title: Creation Date
    Read Only: true
    The date and time when the row was created.
  • Title: Total Emails Sent
    Read Only: true
    The total number of emails sent in context of the opportunity.
  • Title: Last Call Made
    Read Only: true
    The date when last outbound call was made in context of the opportunity.
  • Title: Last Completed Activity
    Read Only: true
    The date of last completed activity for an opportunity. Activity includes task, appointment, and call report.
  • Title: Last Email Sent
    Read Only: true
    The date when last email was sent in context of the opportunity.
  • Title: Last Touch Date
    Read Only: true
    The date of last touch in context of the opportunity. A touch refers to an outbound communication such as email sent or phone call made and so on.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the row was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Next Task Due
    Read Only: true
    The date when a task is due for an opportunity.
  • Title: Total Open Activities
    Read Only: true
    The total number of activities that are open for the opportunity.
  • Title: Total Touches
    Read Only: true
    The total number of touches in context of the opportunity. A touch refers to an outbound communication such as email sent or phone call made and so on.
  • Title: Opportunity Identifier
    Read Only: true
    The unique identifier of the opportunity.
  • Title: Total Completed Activities
    Read Only: true
    The total number of completed activities for an opportunity.
  • Title: Total Notes
    Read Only: true
    The total number of public notes associated with an opportunity.
  • Title: Total Quotes
    Read Only: true
    The total number of quotes for an opportunity.
Nested Schema : opportunities-OpportunitySource1-item-response
Type: object
Show Source
Nested Schema : opportunities-opportunityStageSnapshots-item-response
Type: object
Show Source
  • Title: Active
    Maximum Length: 1
    Indicates whether the opportunity stage snapshot is active.
  • Title: Conflict ID
    Default Value: 0
    This value is used to guarantee the uniqueness of the row when duplicates are created in different databases.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the opportunity stage snapshot.
  • Title: Creation Date
    Read Only: true
    The date when the opportunity stage snapshot was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the opportunity stage snapshot was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the opportunity stage snapshot.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the opportunity stage snapshot.
  • Links
  • Title: Sales Stage
    Read Only: true
    Maximum Length: 50
    The name of the opportunity stage snapshot.
  • Title: Opportunity ID
    The unique identifier of the opportunity.
  • Title: Opportunity Stage Snapshot ID
    The unique identifier of the opportunity stage snapshot.
  • Title: Sales Stage Phase
    Read Only: true
    Maximum Length: 30
    Default Value: "B - Working the Deal"
    The current phase of the opportunity sales stage.
  • Title: Sales Stage Quota Factor
    Read Only: true
    The quota factor of the opportunity sales stage.
  • Title: Sales Stage Status
    Read Only: true
    Maximum Length: 30
    Default Value: "Open"
    The code indicating the default status for the opportunity's sales stage.
  • Title: Sales Stage Enter Date
    The date when the opportunity entered a sales stage.
  • Title: Sales Stage Exit Date
    The date when the opportunity exited a sales stage.
  • Title: Sales Stage ID
    The unique identifier of the opportunity sales stage.
  • Title: Sales Stage Order
    Read Only: true
    The order of the opportunity's sales stage in the sales method.
Nested Schema : opportunities-OpportunitySubscription-item-response
Type: object
Show Source
Nested Schema : opportunities-OpportunityTeam-item-response
Type: object
Show Source
  • Title: Access
    Read Only: true
    Maximum Length: 30
    The access level granted to the opportunity team member, manager, and administrator of the organizations in the resource hierarchy.
  • Read Only: true
    Maximum Length: 1
    Indicates the territory is assigned using automatic territory-based assignment.
  • Title: Territory
    Read Only: true
    Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
  • Title: Assignment Type
    Read Only: true
    Indicates how the resource is added to the opportunity team, for example Ad-Hoc means resource is added manually or through rule-based assignment. Territory means resource is added through territory-based assignment.
  • Title: City
    Read Only: true
    Maximum Length: 60
    The city of the resource.
  • Read Only: true
    Default Value: 0
    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.
  • Title: Country
    Read Only: true
    Maximum Length: 2
    The country code of the resource.
  • Read Only: true
    Maximum Length: 64
    The user who created the opportunity resource record.
  • Read Only: true
    The date and time of the creation of the opportunity resource record.
  • Title: Deal Protected to Date
    Read Only: true
    The end date of the deal protection period of an opportunity team member. This date is set for members of territories that are removed from the opportunity because of territory realignment.
  • Title: Deal Protected from Date
    Read Only: true
    The start date of the deal protection period of an opportunity team member. This date is set for the members of territories that are removed from opportunity because of territory realignment.
  • Read Only: true
    Maximum Length: 320
    The e-mail address of the resource.
  • Title: Enable Forecasting
    Read Only: true
    Maximum Length: 30
    Default Value: REVENUE
    The forecast participation type of the territory.
  • Title: Primary Phone
    Read Only: true
    The formatted phone number for the opportunity team member.
  • Title: Function
    Read Only: true
    Maximum Length: 30
    The code of the function or role of the territory team member.
  • Read Only: true
    The date and time of the last update of the opportunity resource record.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the opportunity resource record.
  • Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the opportunity resource record.
  • Links
  • Title: Lock Assignment
    Read Only: true
    Maximum Length: 1
    Default Value: true
    Indicates whether an opportunity team member can be removed from the team by automatic assignment.
  • Title: Function
    Read Only: true
    Maximum Length: 30
    The role of the team member on the opportunity, such as Integrator, Executive Sponsor, Technical Account Manager.
  • The unique identifier of the opportunity.
  • Title: Opportunity Number
    Read Only: true
    Maximum Length: 30
    The alternate unique identifier of the opportunity associated with the opportunity team.
  • Title: Opportunity Resource ID
    Read Only: true
    The unique identifier of the opportunity resource.
  • Title: Opportunity Resource Number
    Read Only: true
    Maximum Length: 30
    The label displaying the association between an opportunity and a resource (typically an opportunity sales team member).
  • Read Only: true
    Maximum Length: 255
    The unique key to identify the opportunity team member.
  • Title: Primary
    Read Only: true
    Indicates whether the opportunity team member is the owner of the opportunity.
  • Read Only: true
    The unique party identifier of the partner organization that the partner resource belongs to.
  • Read Only: true
    Maximum Length: 360
    The name of the partner organization that the partner resource belongs to.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The full name of the opportunity team member.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The first name of the opportunity team member.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The last name of the opportunity team member.
  • Read Only: true
    Maximum Length: 40
    The primary formatted phone number for the resource.
  • The unique identifier of the resource.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The resource party number of the opportunity team member.
  • Read Only: true
    Maximum Length: 255
    The role of the resource.
  • Title: State
    Read Only: true
    Maximum Length: 60
    The state of the resource.
  • Title: Territory Function
    Read Only: true
    Maximum Length: 30
    The code of the business function of the territory.
  • Title: Territory Name
    Read Only: true
    Maximum Length: 60
    The name of the territory.
  • Read Only: true
    Indicates whether the opportunity team member is the territory owner.
  • The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Default Value: PRIME
    The code of the type of the territory.
Nested Schema : opportunities-OrchestrationAssociations-item-response
Type: object
Show Source
Nested Schema : Error Logs
Type: array
Title: Error Logs
The error logs resource is used to view error logs associated to the orchestration associations.
Show Source
Nested Schema : Stage Objectives
Type: array
Title: Stage Objectives
The stage objectives resource is used to view the stage objectives of the orchestration association.
Show Source
Nested Schema : Stages
Type: array
Title: Stages
The stages resource is used to view the stage of the orchestration association.
Show Source
Nested Schema : Steps
Type: array
Title: Steps
The steps resource is used to view the steps of the orchestration association.
Show Source
Nested Schema : Steps In Execution Path
Type: array
Title: Steps In Execution Path
The steps in execution path resource is used to view all the steps including future steps of the orchestration association.
Show Source
Nested Schema : Step Transitions
Type: array
Title: Step Transitions
The step transitions resource is used to view the step transitions of the orchestration association.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-ErrorLogs-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StageObjectives-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-Stages-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-Steps-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StepsInExecutionPath-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StepTransitions-item-response
Type: object
Show Source
Nested Schema : opportunities-RevenuePartnerPrimary-item-response
Type: object
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-RevenuePartnerPrimary-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-RevenuePartnerPrimary-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-RevenuePartnerPrimary-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-RevenuePartnerPrimary-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : opportunities-winProbabilityDetails-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    The data type associated with the value of the feature used for predictions from the AI models.
  • Read Only: true
    The name of the feature used for predictions from the AI models.
  • Read Only: true
    Maximum Length: 255
    The value of the feature used for predictions from the AI models.
  • Links
Links
assignOpportunity
Assigns a matched opportunity.
copyOpportunity
Copies a matched opportunity.
copyOpportunityAndGetId
This method lets you copy an opportunity record to a new opportunity, where the identifiers of the newly created opportunity record is returned.
createQuote
This method lets you invoke a create quote process in an active Oracle CPQ Cloud integration.
Back to Top

Examples

The following example shows how to get all opportunities by submitting a get request on the REST resource using cURL. For more information about cURL, see Use cURL.

By default, the method returns the list of all opportunities filtered by the following criteria:

  • The method returns only open opportunities (Status = OPEN).
  • The method returns opportunities only for the currently logged in user (MYOPTIES recordset filter is applied).
  • The current closed period is considered. This is stored in the profile value MOO_OPTY_SRCH_DFLT_CLS_PERIOD. The default value is the current fiscal quarter.

If you want to broaden the results, you must add the required parameters or recordsets to the method. For more information, see the Bind Parameters and Supported Record Sets sections.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities

Supported Finder and Bind Parameters

The opportunities resource defines a finder named MyOpportunitiesFinder, with the several bind parameters. You can use this finder to fetch all opportunities that match the criteria specified in the bind parameters.

Bind Parameters

The following table lists the supported bind parameters with their default values and curl command. If any bind parameter is not provided in the command, then its default value is used to fetch the matching records. If required, you can also use one or more bind parameters together. For example, you can use the curl command curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;Name=test,EffectiveBeginDate=2014-07-01,EffectiveEndDate=2014-07-10,RecordSet=MYOPTIES,OptyStatusCode=OPEN,ContactPartyId=300100017180117

Bind Parameter Description Default Value cURL Command
Name Lists the opportunities matching the name. N/A curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;Name=test
EffectiveBeginDate Lists the opportunities matching the effective begin date. Based on the profile option MOO_OPTY_SRCH_DFLT_CLS_PERIOD curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder; EffectiveBeginDate=2014-08-01
EffectiveEndDate Lists the opportunities matching the effective end date. Based on the profile option MOO_OPTY_SRCH_DFLT_CLS_PERIOD curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder; EffectiveEndDate=2014-08-10
OptyStatusCode Lists the opportunities matching the status code provided. OPEN curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder; OptyStatusCode=OPEN
ContactPartyId Lists the opportunities matching the contact party ID. N/A curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder; ContactPartyId =1001
RecordSet Recordset filter parameter MYOPTIES curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;RecordSet='MYOPTIES'

Supported Record Sets

The opportunity resource supports the following record sets.

Record set Description cURL command

MYOPTIES

Lists all the opportunities owned by the current user.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;RecordSet='MYOPTIES'

MYSALESTEAMOPTIES

Lists all the opportunities in the current user's sales account team.

 curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;RecordSet= 'MYSALESTEAMOPTIES'

MYASSGTERROPTIES

Lists all the opportunities in territories that are assigned to the current user's sales account.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;RecordSet= 'MYASSGTERROPTIES'

MYSUBORDINATESOPTIES

Lists all the opportunities owned by the current user who is part of the resource hierarchy and the subordinates of the current user.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;RecordSet= 'MYSUBORDINATESOPTIES'

MYSUBORDSSALESTEAMOPTIES

Lists all the opportunities in the current user's and a subordinate's sales account team.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;RecordSet= 'MYSUBORDSSALESTEAMOPTIES'

MYASSGDESCTERROPTIES

Lists all the opportunities in the territories and child territories of the current user's sales account.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;RecordSet= 'MYASSGDESCTERROPTIES'

ALLOPTIES

Lists all the opportunities visible to the current user.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.12.1.0/opportunities?finder=MyOpportunitiesFinder;RecordSet= 'ALLOPTIES'

MOO_OPTY_SRCH_RECORD_SET

Lists all the record sets in Opportunities.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups?finder=LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_RECORD_SET

MKL_LEAD_SRCH_GROUP

Lists all the record sets in Sales Lead.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType %3DMKL_LEAD_SRCH_GROUP

Example of Response Body

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

Content-Type: {
   "items" : [12]
   -0: {
    "PrimaryOrganizationId" : 204,
    "ChampionFlag" : false,
    "CreatedBy" : "UPGRADE:SEBL:1-KHL3",
    "CreationDate" : "2009-05-11T00:09:56-07:00",
    "CurrencyCode" : "USD",
    "SalesMethodId" : 100000012430009,
    "SalesStageId" : 100000012430010,
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateLogin" : null,
    "Name" : "Major  upgrade of legacy application",
    "OptyId" : 999997817606460,
    "OptyNumber" : "3-EBS-2285"
}


    -1:
{
...
}
 ...
}
Back to Top