Get an opportunity
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}
Request
Path Parameters
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : opportunities-item-response
Type:
Show Source
object
-
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The party number of the sales account that owns the opportunity. -
AiObjectHints: array
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: array
Assessments
Title:
Assessments
The assessments resource is used to view, create, update, and delete the assessment of an opportunity. -
AssetId: integer
(int64)
The unique identifier of the asset associated with the opportunity.
-
AssetNumber: string
Title:
Asset Number
Maximum Length:100
The alternate key identifier of the asset associated with the opportunity. -
AssetProduct: string
Title:
Asset
The name of the asset product associated with the opportunity. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The asset serial number associated with the opportunity. -
AssignmentMode: string
Title:
Assignment Mode
Maximum Length:30
Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates. -
Attachment: array
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. -
AverageDaysAtStage: integer
(int64)
Title:
Duration
Read Only:true
The average duration, in days, the opportunity remains in the current sales stage. -
BatchTag: string
Title:
Batch Tag
Maximum Length:30
This is used for tagging opportunities for inclusion in a batch job such as batch assignment of opportunities. -
BdgtAmount: number
Title:
Budget Amount
The budget amount from the sales account. -
BdgtAmtCurcyCd: string
Title:
Budget Amount Currency
Maximum Length:15
The currency code for budget amount from the sales account. -
BudgetAvailableDate: string
(date)
Title:
Date Budget Available
The date when the budget will be available. -
BudgetedFlag: boolean
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. -
ChampionFlag: boolean
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. -
ChildRevenue: array
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. -
ClosePeriod: string
Title:
Close Period
Read Only:true
The names of the filter on which opportunities can be filtered based on effective date range. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the opportunity. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the opportunity record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CrmConversionRate: number
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. -
CrmCurrencyCode: string
Title:
CRM Common Currency
Read Only:true
Maximum Length:15
The CRM common currency code. -
CurrencyCode: string
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. -
CustomerAccountId: integer
(int64)
Title:
Billing Account
The unique identifier of the customer account associated with the opportunity. -
DealHorizonCode: string
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. -
DecisionLevelCode: string
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. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the opportunity can be deleted. The default value is true. -
Description: string
Title:
Sales Objective
Maximum Length:2000
The description of the opportunity including the sales objective. The description is added by the Sales Representative. -
DescriptionText: string
Title:
Description
Read Only:true
Maximum Length:255
The description of the sales objective of the opportunity. -
DownsideAmount: number
Title:
Worst Case
Default Value:0
The minimum amount of revenue for the opportunity. -
EffectiveDate: string
(date)
Title:
Close Date
The date when the opportunity is expected to close. -
EmailAddress: string
Title:
Owner Email
Read Only:true
Maximum Length:320
The e-mail address of the employee resource that owns the opportunity. -
ExpectAmount: number
Title:
Expected Revenue
Default Value:0
The expected revenue from the opportunity. -
ForecastCategory: string
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. -
ForecastOverrideCode: string
Title:
Include in Forecast
Maximum Length:30
Indicates whether the summary revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA. -
HintCode: string
Title:
Hint Code
Read Only:true
Maximum Length:10
The AI hint code. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset
The unique identifier of the installed base asset of the opportunity. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
The asset number of the installed base asset of the opportunity. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The associated installed base asset's serial number. -
Interviews: array
Interviews
Title:
Interviews
The interviews resource is used to view the list of interviews related to the opportunities. -
KeyContactId: integer
(int64)
Title:
Primary Contact
The unique identifier of the primary contact of the opportunity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the opportunity record. -
LastUpdateLogin: string
Title:
Last Update Login
Maximum Length:32
The session login associated to the user who last updated the record. -
LineOfBusinessCode: string
Title:
Line of Business
Maximum Length:30
The line of business that owns the opportunity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCategory: string
Title:
Status Category
Read Only:true
Maximum Length:30
The status category of the opportunity status. -
ManageGeneralProfileDataFlag: boolean
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. -
ManageRestrictedProfileDataFlag: boolean
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. -
ManageRevenueDataFlag: boolean
Title:
Manage Revenue Data
Read Only:true
Indicates you can manage revenue data, such as products and recurring revenue information. -
ManageTeamDataFlag: boolean
Title:
Manage Team Data
Read Only:true
Indicates you can manage opportunity sales team data. -
MaximumDaysInStage: integer
(int64)
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. -
Name: string
Title:
Name
Maximum Length:275
The name of the opportunity. -
Note: array
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. -
OpportunityCampaigns: array
Opportunity Campaigns
Title:
Opportunity Campaigns
The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity. -
OpportunityCompetitor2: array
Opportunity Competitors
Title:
Opportunity Competitors
The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity. -
OpportunityContact: array
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. -
OpportunityDeal: array
Opportunity Deals
Title:
Opportunity Deals
The opportunity deals resource is used to view the deals associated with an opportunity. -
OpportunityLead: array
Opportunity Leads
Title:
Opportunity Leads
The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity. -
OpportunityOrigin: string
Title:
Opportunity Origin
Maximum Length:30
Default Value:SALES_OPTY
The value for the origin of the opportunity. -
OpportunityResource: array
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. -
OpportunityRollup: array
Opportunity Rollups
Title:
Opportunity Rollups
The opportunity rollups resource is used to view an opportunity rollup. -
OpportunitySource1: array
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. -
opportunityStageSnapshots: array
Opportunity Stage Snapshots
Title:
Opportunity Stage Snapshots
The opportunity stage snapshots is used to view all the historical snapshots of the opportunity. -
OpportunitySubscription: array
Opportunity Subscriptions
Title:
Opportunity Subscriptions
The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level. -
OpportunityTeam: array
Opportunity Teams
Title:
Opportunity Teams
The opportunity teams resource is used to view the team members and territory team members associated with an opportunity. -
OpportunityTypeCode: string
Title:
Opportunity Type
Maximum Length:30
Display the different types of opportunity such as new, renewal, and expansion. -
OptyCreatedBy: string
Title:
Opportunity Created By
Maximum Length:64
The user who created the opportunity record. -
OptyCreationDate: string
(date-time)
Title:
Opportunity Creation Date
The date when the opportunity was created. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyLastUpdateDate: string
(date-time)
Title:
Opportunity Last Updated Date
The date when the record was last updated. -
OptyLastUpdatedBy: string
Title:
Opportunity Last Updated By
Maximum Length:64
The user who last updated the opportunity record. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The unique alternate identifier for the opportunity. -
OrchestrationAssociations: array
Orchestration Associations
Title:
Orchestration Associations
The orchestrations associations resource is used to view, create, update, and delete an orchestration association. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The party number of a valid employee resource who owns and manages the opportunity. -
OwnerResourcePartyId: integer
(int64)
Title:
Owner
The unique identifier of a valid employee resource who owns and manages the opportunity. -
PartyName1: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the opportunity owner. -
PartyUniqueName1: string
Title:
Primary Competitor
Read Only:true
Maximum Length:900
The unique name of the primary competitor for the opportunity. -
PhaseCd: string
Title:
Phase
Read Only:true
Maximum Length:30
Default Value:"B - Working the Deal"
The current phase of the opportunity sales stage. -
PredWinProb: number
Title:
Predicted Win Probability
Read Only:true
The AI predicted win probability percent. -
PrimaryCampaignId: integer
(int64)
Title:
Primary Campaign ID
The unique identifier of the primary campaign of the opportunity. It is a reference key to campaign object. -
PrimaryCampaignName: string
Title:
Primary Campaign
The name of the primary campaign of the opportunity. -
PrimaryCampaignNumber: string
Title:
Primary Campaign Number
Maximum Length:30
The alternate identifier for primary campaign of the opportunity. -
PrimaryCompetitorId: integer
(int64)
Title:
Primary Competitor
The unique identifier of the primary competitor for this opportunity. -
PrimaryCompetitorPartyNumber: string
Title:
Primary Competitor Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the opportunity's primary competitor party. -
PrimaryContactEmailAddress: string
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. -
PrimaryContactEmailPref: string
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. -
PrimaryContactFormattedPhoneNumber: string
Title:
Primary Contact Phone
Read Only:true
The formatted phone number of the primary contact for the opportunity. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the opportunity's primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the opportunity's primary contact party. -
PrimaryContactPhonePref: string
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. -
PrimaryOrganizationId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the business unit to which this opportunity belongs. -
PrimaryPartnerCompanyNumber: string
Title:
Primary Partner Number
Maximum Length:30
The alternate key identifier of the opportunity's primary partner company. -
PrimaryPartnerId: integer
(int64)
Title:
Primary Partner
The unique identifier of the primary partner associated with the opportunity. -
PrimaryPartnerOrgPartyName: string
Title:
Primary Partner
Maximum Length:360
The name of the primary partner associated with the opportunity. -
PrimaryRevenueId: integer
(int64)
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. -
PrimarySubscriptionId: integer
(int64)
Title:
Primary Subscription Id
The unique identifier of the primary subscription of the opportunity. -
PrimarySubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The alternate identifier of primary subscription of the opportunity. -
PrSrcNumber: string
Title:
Primary Source Number
Maximum Length:100
The alternate key identifier of the primary marketing source or campaign that generated this opportunity. -
QuotaFactor: number
Title:
Quota Factor
Read Only:true
The quota factor of the opportunity sales stage. -
QuotedFlag: boolean
Title:
Quoted
Maximum Length:1
Default Value:false
Indicates whether a quote has been created for this Opportunity. -
RcmndWinProb: number
Title:
Win Probability
Read Only:true
Default Value:0
The recommended probability of winning the opportunity in the sales stage. -
ReasonWonLostCode: string
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. -
RecommendedAction: string
Title:
Recommended Action
Read Only:true
Maximum Length:180
The AI recommended action. -
RecordSet: string
Read Only:
true
The name of the predefined opportunity search filters. -
Registered: string
Title:
Registered
Maximum Length:30
Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No. The default value is No. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:30
The registration status of the opportunity or deal created by a partner. -
RegistrationType: string
Title:
Registration Type
Maximum Length:30
The registration type used by the partner to create the opportunity or deal. -
RenewalProcess: string
Title:
Renewal Process
Maximum Length:30
The renewal process can be manual, do not renew, or automatic. -
Revenue: number
Title:
Amount
Default Value:0
The estimated revenue amount from the opportunity. -
RevenuePartnerPrimary: array
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. -
RiskLevelCode: string
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. -
SalesAccountUniqueName: string
Title:
Customer Account
Read Only:true
Maximum Length:900
The unique name of the sales account that owns the opportunity. -
SalesChannelCd: string
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. -
SalesMethod: string
Title:
Sales Method
Read Only:true
Maximum Length:50
The name of the sales method associated with the opportunity. -
SalesMethodId: integer
(int64)
Title:
Sales Method
The unique identifier of the sales method for this opportunity. -
SalesStage: string
Title:
Sales Stage
Read Only:true
Maximum Length:50
The current sales stage of the opportunity. -
SalesStageId: integer
(int64)
Title:
Sales Stage
The unique identifier for the sales stage of the opportunity. -
Selected: boolean
This is used during mass update scenarios from UI.
-
SetupRefCode: string
Maximum Length:
80
The public unique identifier for the CPQ configuration setup. -
smartActions: array
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. -
SourceType: string
Title:
Source Type
Read Only:true
The type of the source object such as Opportunities or Partners as defined in the object metadata. -
StageStatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:"Open"
The code indicating the default status for the opportunity's sales stage. -
StatusCode: string
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. -
StgOrder: number
Title:
Order
Read Only:true
The order of the opportunity's sales stage in the sales method. -
StrategicLevelCode: string
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. -
TargetPartyId: integer
(int64)
Title:
Account
The unique identifier of the sales account that owns the opportunity. -
TargetPartyName: string
Title:
Account
Read Only:true
Maximum Length:360
The name of the sales account that owns the opportunity. -
TargetPartyPrimaryAddressCountry: string
Title:
Account Country
Read Only:true
Maximum Length:2
The country of the primary account's primary address. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the opportunity can be updated. The default value is true. -
UpsideAmount: number
Title:
Best Case
Default Value:0
The maximum amount of revenue for the opportunity. -
WinProb: integer
(int32)
Title:
Win Probability
The estimated probability of winning the opportunity. -
winProbabilityDetails: array
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EnabledFlag: boolean
Title:
Enabled
Read Only:true
Maximum Length:1
Indicates whether the record is enabled or not. Y or null for enabled and N for disabled. -
EndDate: string
(date-time)
Title:
End Date
The date when the hint ends. -
Explanations: string
(byte)
The explanatory text for the reasoning behind predictions from the AI models.
-
HintCode: string
Title:
Hint Code
Maximum Length:10
The unique identifier of the hint. -
HintType: string
Title:
Hint Type
Read Only:true
Maximum Length:30
The record type. For example, RECOMMENDATION, WIN_PROB, etc. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocalizedDetail: string
Title:
Explanation
Read Only:true
Maximum Length:255
The translated explanation and details for the hint. -
LocalizedSummary: string
Title:
Action
Read Only:true
Maximum Length:180
The translated short summary of the hint. -
ObjectHintId: integer
(int64)
Title:
Object Hint ID
The unique identifier of the object hint. -
ObjectInstanceId: integer
(int64)
Title:
Object ID
The unique identifier of the object specified by OBJECT_TYPE column. -
ObjectType: string
Title:
Object Type
Maximum Length:30
The object for which hint is applicable for example, OPPORTUNITY, LEAD, etc. -
ObjectUuid: string
Title:
Object Unique ID
Maximum Length:50
The unique identifier of the object which is an alternate key. -
PredWinProb: number
Title:
Predicted Win Probability
The win probability predicted by the AI engine. -
RespResourceId: integer
(int64)
Title:
Response Resource ID
The resource ID of the user who provided feedback on the recommendation. -
StartDate: string
(date-time)
The date when the hint starts.
-
TaskId: integer
(int64)
The unique identifier of the task that was created for the recommendation.
-
TopHintFlag: boolean
Maximum Length:
1
Indicates the current highest ranked recommendation to display in the UI. -
UserResponse: string
Title:
User Response
Maximum Length:1
The user's response to a recommendation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : opportunities-Assessments-item-response
Type:
Show Source
object
-
AssessAnswerGroups: array
Assessment Answer Groups
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment. -
AssessedLanguage: string
Title:
Assessment Language
Maximum Length:4
Default Value:US
The language of the assessment. -
AssessedObjectId: integer
(int64)
Title:
Assessed Object ID
The unique identifier of the assessed business object. -
AssessedObjTypeCode: string
Title:
Object Type Code
Maximum Length:30
The code indicating the type of the assessed business object. -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of an assessment. -
AssessmentScore: integer
(int64)
Title:
Score
Default Value:0
The calculated score of assessment. -
AssessTemplateId: integer
(int64)
Title:
Template Name
The unique identifier of the assessment template that served as the source of this assessment. -
BusinessUnit: integer
(int64)
Title:
Business Unit
The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the assessment record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the assessment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the assessment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:255
The name of the assessment. -
RatingFeedback: string
Title:
Feedback
Read Only:true
The feedback mapped to the rating. -
RatingTerm: string
Title:
Rating
Read Only:true
The overall rating of the assessment as configured in the associated assessment template. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the valid status of the assessment. The valid values are IN_PROGRESS and COMPLETE. -
StatusFuse: string
Title:
Status
Read Only:true
The status of the assessment. -
TemplateName: string
Title:
Template
The name of the assessment template. -
TemplateType: string
Title:
Template Type
The type of the assessment template associated with the assessment. -
TotalAnswered: number
Title:
Total Questions Answered
The number of questions answered in the assessment. -
TotalQuestions: number
Title:
Total Questions
The total number of questions to be answered in the assessment.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-Assessments-AssessAnswerGroups-item-response
Type:
Show Source
object
-
AssessAnswerGroupId: integer
(int64)
The unique identifier of the answer group.
-
AssessmentAnswer: array
Assessment Answers
Title:
Assessment Answers
The assessment answers resource is used to view and update a response to a question in the question group. -
AssessmentId: integer
(int64)
The unique identifier of the assessment associated with answer group.
-
AttributeGroupId: integer
(int64)
The unique identifier of the question group of the associated template.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
The name of the answer group.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response
Type:
Show Source
object
-
Answered: string
Indicates if the question is answered or not.
-
AnswerId: integer
(int64)
The unique identifier of the assessment answer.
-
AssessmentId: integer
(int64)
The unique identifier of the assessments associated with answer.
-
AttributeGroupId: integer
(int64)
Title:
Question Group
The unique identifier of the question group associated with assessment answer. -
AttributeId: integer
(int64)
Title:
Question
The unique identifier of the question associated with assessment answer. -
AttributeName: string
Read Only:
true
Maximum Length:500
The name of the question. -
AttributeValueId: integer
(int64)
Title:
Response
The unique identifier of the response. -
Comments: string
Title:
Comments
Maximum Length:1500
The assessment runtime comments entered by end user. -
HasComments: string
Indicates if the comments are present or not.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseValue: string
Title:
Response
Read Only:true
The response to the question.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The login of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of the data. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The login of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-item-response
Type:
Show Source
object
-
ActualCloseDate: string
(date)
Title:
Actual Close Date
The date when the revenue line was closed. -
AmountAggregatedForScheduleFlag: boolean
Title:
Divide Amount by Transactions
Maximum Length:1
The amounts are divided by the number of transactions based on the set schedule. -
BUOrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the Business Unit that owns the opportunity. -
CalculatedLineRevnAmtInCorpCur: number
Title:
Revenue in Corporate Currency
Read Only:true
The calculated revenue amount in corporate currency. -
ChildSplitRevenue: array
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. -
CloseReasonCode: string
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. -
Comments: string
Title:
Line Comments
Maximum Length:250
The user-provided comments for the revenue line. -
CommitFlag: boolean
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. -
CompetitorPartyName: string
Title:
Competitor Party Name
Read Only:true
Maximum Length:360
The party name of the primary competitor of this child revenue. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
ContractEndDate: string
(date-time)
Title:
Contract End Date
The end date of the contract for the quote. -
ContractStartDate: string
(date-time)
Title:
Contract Start Date
The start date of the contract for the quote. -
ConversionRate: number
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. -
ConversionRateType: string
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. -
CostAmount: number
Title:
Cost
Default Value:0
The cost amount for the opportunity. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the child revenue record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CreditRcptPartOrgPartyId: integer
(int64)
Title:
Credit Recipient Partner
The unique identifier of the credit recipient partner organization party. -
CrmConversionRate: number
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. -
CrmConversionRateType: string
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. -
CrmCurcyCode: string
Title:
Currency
Maximum Length:15
The common CRM currency code. -
CurrStgId: integer
(int64)
Title:
Sales Stage
Read Only:true
The sales stage identifier of this revenue line. -
CustomerAccountId: integer
(int64)
Title:
Revenue Customer Account ID
The unique identifier of the customer account that owns the opportunity. -
CustomerRegistryId: string
Title:
Account Registry ID
Read Only:true
Maximum Length:30
The name of the opportunity account registry ID. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the opportunity revenue can be deleted. The default value is true. -
Description: string
Title:
Product
Maximum Length:240
The user-provided description of the product associated with the revenue. -
Discount: number
Title:
Discount
The discount percent. -
DownsideAmount: number
Title:
Worst Case
Default Value:0
The minimum amount of revenue for the opportunity. -
EffectiveDate: string
(date)
Title:
Close Date
The date when the child revenue closes. The default value is the opportunity's close date. -
EffectiveEndDate: string
(date)
Read Only:
true
The end date for the territory owner. -
EffectiveStartDate: string
(date)
Read Only:
true
The start date for the territory owner. -
ExpectAmount: number
Title:
Expected Revenue
Default Value:0
The maximum amount of revenue for the opportunity. -
ExpectDlvryDate: string
(date)
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. -
ExternalAssetKey: string
Title:
External Asset Key
Maximum Length:255
The asset key from an external system. -
ExternalParentAssetKey: string
Title:
External Parent Asset Key
Maximum Length:255
The root asset key of the parent from an external system. -
ExternalRootAssetKey: string
Title:
External Root Asset Key
Maximum Length:255
The root asset key obtained from an external system. -
ForecastCategory: string
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. -
ForecastOverrideCode: string
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. -
InventoryItemId: integer
(int64)
Title:
Product
The unique identifier of the product in the inventory. -
InventoryOrgId: integer
(int64)
Title:
Product
The unique identifier of the organization in the inventory. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:300
The alternate key identifier of the product that is associated with the revenue. -
ItemNumberInternal: string
Title:
Item Number Internal
Maximum Length:300
The unique internal identifier of the product that is associated with the revenue. -
LastUpdateDate: string
(date-time)
Title:
Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MarginAmount: number
Title:
Margin
Default Value:0
The margin amount for the opportunity. -
MonthlyRecurringRevenue: number
Title:
Monthly Recurring Revenue
The monthly recurring revenue on the revenue line. -
MonthlyUsageRevenue: number
Title:
Monthly Usage Revenue
The monthly usage revenue on the revenue line. -
Name1: string
Title:
Forecast Territory
Read Only:true
Maximum Length:60
The name of the territory. -
NonRecurringRevenue: number
Title:
Nonrecurring Revenue
The non recurring revenue amount associated with the revenue line. -
NqSplitAllocTypeCode: string
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. -
OpportunityCreationDate: string
(date-time)
Title:
Opportunity Creation Date
Read Only:true
The date and time when the opportunity was created. -
OpportunityCurrencyCode: string
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. -
OpportunityOwnerPartyName: string
Title:
Opportunity Owner
Read Only:true
Maximum Length:360
The name of the opportunity owner. -
OpportunityOwnerResourcePartyId: integer
(int64)
Title:
Owner
Read Only:true
The unique identifier of a valid employee resource who owns and manages the opportunity. -
OpportunityPrSrcNumber: string
Title:
Primary Source
Read Only:true
Maximum Length:100
The alternate key identifier of the primary marketing source or campaign that generated this opportunity. -
OptyEffectiveDate: string
(date)
Title:
Opportunity Close Date
Read Only:true
The date when the opportunity is expected to close. -
OptyId: integer
(int64)
Title:
Revenue Opportunity ID
The unique identified of the opportunity. -
OptyLastUpdateDate: string
(date-time)
Title:
Opportunity Last Update Date
Read Only:true
The date when the opportunity record was last updated. -
OptyLeadId: integer
(int64)
Title:
Opportunity Lead
The unique Identifier of the lead associated with opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The unique alternate identifier for the opportunity associated to child revenue. -
OrganizationId: integer
(int64)
Title:
Organization
The unique identifier of the organization to which the product belongs. -
OwnerDealExpirationDate: string
(date)
Title:
Effective End Date
The date when the owner deal expires. -
OwnerDealProtectedDate: string
(date)
Title:
Effective Start Date
The date when the owner deal starts. -
OwnerLockAsgnFlag: boolean
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. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The party number for the owner of child revenue. -
ParentRevnId: integer
(int64)
Title:
Parent Revenue ID
The unique identifier of the parent revenue line, used for Lineset functionality. -
PartEngagementTypeCd: string
Title:
Lead Registration Type
Maximum Length:100
The code indicating the type of partner engagement. -
PartOrgPartyId: integer
(int64)
Title:
Partner Organization Party ID
Read Only:true
The unique identifier of the primary revenue partner party. -
PartOrgPartyName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the primary partner associated with the child revenue. -
PartyName2: string
Title:
Sales Credit Recipient
Read Only:true
Maximum Length:360
The name of this sales credit recipient. -
PrCmptPartyId: integer
(int64)
Title:
Competitor
The unique identifier of the primary competitor of this child revenue. -
PriceTypeCode: string
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. -
PrimaryCompetitorPartyNumber: string
Title:
Primary Competitor Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the primary competitor of this child revenue. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
Read Only:true
The unique identifier of the primary contact of this child revenue. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the primary contact of this child revenue. -
PrimaryFlag: boolean
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. -
PrimaryOrganizationName: string
Read Only:
true
The name of the business unit to which this revenue line belongs. -
PrimaryPartnerCompanyNumber: string
Title:
Primary Partner Number
Maximum Length:30
The alternate key identifier of the revenue's primary partner company. -
ProdGroupId: integer
(int64)
Title:
Product Group
The unique identifier of the product group. -
ProdGroupModelConfigAttributes: string
Title:
Product Group Model Attributes
Read Only:true
Maximum Length:4000
The model configuration attributes associated with the product group in revenue line. -
ProdGroupModelFamily: string
Title:
Product Group Model Family
Read Only:true
Maximum Length:1000
The model family associated with the product group. -
ProdGroupModelLine: string
Title:
Product Group Model Line
Read Only:true
Maximum Length:1000
The model line associated with the product group. -
ProdGroupModelName: string
Title:
Product Group Model
Read Only:true
Maximum Length:1000
The model name associated with the product group in revenue line. -
ProdGroupName: string
Title:
Product Group
Maximum Length:250
The name of the product group associated with the revenue. -
ProdGroupQuotableFlag: boolean
Title:
Quotable
Read Only:true
Maximum Length:1
Indicates whether a product group is quotable. -
ProductConfigurableFlag: boolean
Title:
Configurable Product
Read Only:true
Maximum Length:1
Indicates whether a product allows configuration. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
Maximum Length:50
The reference number of the product group. -
productGroups: array
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. -
ProductModelConfigAttributes: string
Title:
Product Model Attributes
Read Only:true
Maximum Length:4000
The model configuration attributes associated with the product in revenue line. -
ProductModelFamily: string
Title:
Product Model Family
Read Only:true
Maximum Length:1000
The model family associated with the product. -
ProductModelLine: string
Title:
Product Model Line
Read Only:true
Maximum Length:1000
The model line associated with the product. -
ProductModelName: string
Title:
Product Model
Read Only:true
Maximum Length:1000
The model name associated with the product in revenue line. -
products: array
Products
Title:
Products
The products resource is used to view the products associated with an opportunity. -
ProductType: string
Title:
Product Type
The type of product on the revenue line, such as item or product group. -
PrPartOrgPartyId: integer
(int64)
Title:
Partner
The unique identifier of the primary revenue partner organization party. -
PrTerritoryVersionId: integer
(int64)
Title:
Forecast Territory
The unique identifier of the primary territory for this revenue item. -
PrTerritoryVersionIdForManual: string
Title:
Manually Assigned Territory Version ID
The version ID of a territory that is to be manually assigned to the revenue record. -
Quantity: number
Title:
Quantity
The quantity of product for this opportunity. -
RecordSet: string
Title:
Record Set
Read Only:true
The name of the predefined opportunity search filters. -
RecurDownsideAmount: number
Title:
Recurring Worst Case
The minimum revenue amount from the recurrence. -
RecurEndDate: string
(date)
Title:
End By
The date when the child revenue recurrence ends. -
RecurFrequencyCode: string
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. -
RecurNumberPeriods: integer
(int64)
Title:
End After
The number of times the child revenue should recur. -
RecurParentRevnId: integer
(int64)
Title:
Recurring Revenue Parent ID
The unique identifier for the parent revenue of the recurring revenue lines. -
RecurPeriodOrEndDateCode: string
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. -
RecurQuantity: number
Title:
Recurring Quantity
The quantity of the child revenue recurrence. -
RecurRevenue: number
Title:
Recurring Revenue
The recurring revenue amount on the revenue line. -
RecurRevnAmount: number
Title:
Scheduled Revenue Amount
The amount of revenue from the child revenue recurrence. -
RecurringRevenue: array
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. -
RecurStartDate: string
(date)
Title:
Start Date
The date when the recurrence starts. -
RecurTypeCode: string
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. -
RecurUnitPrice: number
Title:
Recurring Estimated Price
The price of each child revenue recurrence. -
RecurUpsideAmount: number
Title:
Recurring Best Case
The maximum revenue amount from the recurrence. -
ResourcePartyId: integer
(int64)
Title:
Owner
The unique identifier of the revenue owner. -
RevenueTerritory: array
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. -
RevenueTypeCategory: string
Title:
Revenue Type Category
Maximum Length:30
The revenue category type on the opportunity revenue line. -
RevnAmount: number
Title:
Amount
Default Value:0
The amount of revenue that is earned from this opportunity. -
RevnAmountCurcyCode: string
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. -
RevnCategoryCode: string
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. -
RevnCreationDate: string
(date-time)
Title:
Creation Date
The date when the revenue item was created. -
RevnId: integer
(int64)
Title:
Revenue ID
The unique identifier of the revenue for the opportunity. -
RevnLastUpdateDate: string
(date-time)
Title:
Update Date
The date and time when the revenue record was last updated. -
RevnLineTypeCode: string
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. -
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
The user-editable unique identifier for the child revenue. The default value is the revenue identifier. -
RevnSequenceNumber: integer
(int32)
Title:
Line Set
The revenue sequence number. -
SalesAccountId: integer
(int64)
Title:
Account
The unique identifier of the opportunity sales account. -
SalesChannelCd: string
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. -
SalesCreditTypeCode: string
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. -
SalesMethodId: integer
(int64)
Title:
Sales Method
Read Only:true
The unique identifier of the sales method for this revenue line. -
ScheduleAction: string
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. -
ScheduleNonRecurringAmount: number
Title:
Nonrecurring Amount for Schedule
The non recurring amount based on the set schedule. -
ScheduleRecurringAmount: number
Title:
Recurring Amount for Schedule
The recurring amount based on the set schedule. -
ScheduleUsageAmount: number
Title:
Usage Amount for Schedule
The usage amount based on the set schedule. -
SplitParentRevnId: integer
(int64)
Title:
Split Parent Revenue ID
The unique identifier of the split parent revenue. -
SplitPercent: number
Title:
Sales Credit
The percentage of split revenue. -
SplitTypeCode: string
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. -
StatusCd: string
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. -
StatusCode: string
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. -
SubscriptionId: integer
(int64)
Title:
Subscription Id
The unique identifier of the subscription. -
SubscriptionLineId: integer
(int64)
Title:
Subscription Line Id
The unique identifier of the subscription line within a subscription. -
SummaryRevnAmt: number
Title:
Opportunity Revenue
Read Only:true
Default Value:0
The revenue amount associated with the summary revenue line. -
SummaryRevnAmtInCorpCur: number
Title:
Opportunity Summary Revenue in Corporate Currency
Read Only:true
The calculated opportunity amount in corporate currency. -
SumRevnDownsideAmt: number
Title:
Opportunity Worst Case
Read Only:true
Default Value:0
The minimum amount of the summary revenue line for the opportunity. -
SumRevnUpsideAmt: number
Title:
Opportunity Best Case
Read Only:true
Default Value:0
The maximum amount of the summary revenue line for the opportunity. -
TargetPartyId: integer
(int64)
Title:
Account Party ID
The unique identifier of the sales account that owns the opportunity. -
TerrOwnerOrganizationId: integer
Read Only:
true
The unique identifier of the organization the territory owner of this revenue line belongs to. -
TerrOwnerPartyName: string
Title:
Forecast Territory Owner
Read Only:true
Maximum Length:360
The party name for the territory owner of this revenue line. -
TerrOwnerResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier for the territory owner of this revenue line. -
TimeFilter: string
Title:
Close Period
Read Only:true
The names of the filter on which opportunities can be filtered based on effective date range. -
TypeCode: string
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. -
UnitPrice: number
Title:
Estimated Price
The estimated unit price for the product. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure code for the product. -
UpdateFlag: boolean
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. -
UpsideAmount: number
Title:
Best Case
Default Value:0
The maximum amount of revenue for the opportunity. -
UsageRevenue: number
Title:
Usage Revenue
The usage revenue amount on the revenue line. -
WinProb: integer
(int32)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : opportunities-ChildRevenue-ChildSplitRevenue-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
ExtnPartyName: string
Title:
Owner
The name of the revenue owner. -
ExtnPartyNameLOVSwitcher: string
The switcher for ist of values for the revenue owner, used in UI scenarios.
-
ForecastTerritoryName: string
Title:
Territory Name
Maximum Length:60
The name of the forecast territory. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Organization
Read Only:true
The name of the resource organization associated the with revenue. -
OwnerLockAsgnFlag: boolean
Title:
Lock Credit Owner
Maximum Length:1
Default Value:false
Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The party number for the owner of child split revenue. -
PrTerritoryUpdatedByPartyName: string
Title:
Updated By
Read Only:true
Maximum Length:360
The name of the user who last updated the forecast territory. -
PrTerritoryVersionId: integer
(int64)
Title:
Forecast Territory
Forecast territory version identifier. -
PrTerritoryVersionIdForManual: string
Title:
Manually Assigned Territory Version ID
Indicates the version ID of a territory that is to be manually assigned to the revenue record. -
ResourcePartyId: integer
(int64)
Title:
Owner
The identifier of the resource associated with the child split revenue. -
RevnAmount: number
Title:
Line Revenue
Default Value:0
The revenue amount. -
RevnAmountCurcyCode: string
Title:
Currency
Maximum Length:15
The currency the amount on this revenue line is based on. -
RevnId: integer
(int64)
The unique identifier of the child split revenue.
-
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
The unique number for the revenue line. -
SalesCreditTypeCode: string
Title:
Sales Credit Type
Maximum Length:30
Default Value:QUOTA
Indicates the type of credit. -
SplitPercent: number
Title:
Sales Credit
The percentage of split revenue. -
TerrOwnerPartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the forecast territory owner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-productGroups-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The user-provided description of the product group. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:255
The name of the product group. -
LastUpdateDate: string
Title:
Last Updated Date
Read Only:true
The date the product group was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelConfigAttributes: string
Read Only:
true
The model configuration attributes associated with the product group. -
ModelName: string
Read Only:
true
The model name associated with the product group. -
ProdGroupId: integer
Title:
Product Group ID
Read Only:true
The unique identifier of the product group. -
QuotableFlag: boolean
Title:
Quotable
Read Only:true
Indicates whether a product group is quotable. -
ReferenceNumber: string
Title:
Reference Number
Read Only:true
The reference number of the product group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-products-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Read Only:true
Indicates if the product is Active. -
CSSEnabled: string
Read Only:
true
Indicates if the product is enabled for customer self-service. The default value is No. -
Description: string
Title:
Name
Read Only:true
Maximum Length:255
The description of the product associated with the opportunity. -
EndDate: string
(date-time)
Title:
Effective to Date
Read Only:true
The date after which the product is no longer available. -
InventoryItemId: integer
Title:
Inventory Item ID
Read Only:true
The unique identifier of the product inventory item associated with the opportunity. -
InvOrgId: integer
Title:
Inventory Organization ID
Read Only:true
The unique identifier of the inventory organization. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the product was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Description
Read Only:true
Maximum Length:4000
A detailed description of the product. -
ProdGroupId: integer
Title:
Product Group ID
Read Only:true
The unique identifier of the Product Group. -
ProductNum: string
Title:
Product Number
Read Only:true
The alternate key identifier of the product. -
ProductType: string
Title:
Product Type
Read Only:true
The type of the product, such as item or product group. -
ServiceRequestEnabledCode: string
Read Only:
true
The code indicating whether the product is serviceable. If the value is True, then the product is serviceable. -
StartDate: string
(date-time)
Title:
Effective from Date
Read Only:true
The date from which the product is available. -
Text: string
Title:
Keyword
The text or keywords associated with the product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-RecurringRevenue-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
EffectiveDate: string
(date)
Title:
Line Close Date
Estimated close date for this revenue - defaulted from opportunity's close date. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonRecurringRevenue: number
Title:
Nonrecurring Revenue
The non recurring revenue amount on the revenue line. -
Quantity: number
Title:
Quantity
Product quantity. -
RecurParentRevnId: integer
(int64)
Indicates the parent revenue id for the recurrence.
-
RecurRevenue: number
Title:
Recurring Revenue
The recurring revenue amount on the revenue line. -
RevnAmount: number
Title:
Line Revenue
Default Value:0
Revenue amount. -
RevnAmtCurcyCode: string
Read Only:
true
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. -
RevnId: integer
(int64)
Revenue identifier.
-
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL. -
UsageRevenue: number
Title:
Usage Revenue
The usage revenue amount on the revenue line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-RevenueTerritory-item-response
Type:
Show Source
object
-
AssignmentType: string
Title:
Assignment Type
Read Only:true
Maximum Length:15
The type of assignment used to assign the territory to the opportunity. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the revenue territory record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
EffectiveEndDate: string
(date)
The date when the resource organization assignment to the territory ends.
-
EffectiveStartDate: string
(date)
The date when the resource organization for the territory was assigned to the revenue line.
-
ForecastParticipationCode: string
Title:
Forecast Participation
Read Only:true
Maximum Length:30
The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Revenue Line Territory
Read Only:true
Maximum Length:60
The name of the territory that the opportunity belongs to. -
Name1: string
Title:
Organization
The name of the organization that the territory resource belongs to. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the resource who owns the territory. -
PartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the territory owner for the opportunity. -
RevnId: integer
(int64)
The unique identifier of the revenue.
-
RevnTerrId: integer
(int64)
The unique identifier of the revenue territory.
-
RoleId: integer
The unique identifier of the resource's role.
-
RoleName: string
The name of the resource's role.
-
TerritoryId: integer
(int64)
The unique identifier of the territory.
-
TerritoryVersionId: integer
(int64)
The unique identifier of the territory version.
-
TypeCode: string
Title:
Type
Read Only:true
Maximum Length:30
The code indicating the type of territory assigned to the opportunity. A list of valid values is defined in the lookup MOT_TERRITORY_TYPE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-Interviews-item-response
Type:
Show Source
object
-
AttachmentId: integer
(int64)
Title:
Attachment ID
The identifier for attachment of interview summary. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the interview record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the interview record was created. -
InterviewData: string
(byte)
Title:
Interview Data
The submitted interview data containing questionnaires and responses. -
InterviewDataLang: string
Title:
Interview Data Language
Maximum Length:30
The language in which interview has been submitted. -
InterviewDraft: string
(byte)
Title:
Interview Draft
The draft interview data. This allows a user to continue from the saved draft. -
InterviewId: integer
(int64)
Title:
Interview ID
The unique identifier of interview record. -
InterviewName: string
Title:
Interview Name
Maximum Length:100
The name of the interview. -
InterviewNumber: string
Title:
Interview Number
Maximum Length:30
The public unique identifier of the interview record. -
InterviewStatus: string
Title:
Interview Status
Maximum Length:30
Specifies the status of the interview -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date and time when the interview record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the interview record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Indicates the session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Read Only:true
Specifies how many times the row has been updated. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource ID
The unique identifier of the user who created the record. -
OwnerResourceNumber: string
Title:
Owner Resource Number
Read Only:true
Maximum Length:30
The public unique identifier of the user who created the record. -
OwnerResourcePartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the user who created the interview record. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:30
The name of the top level object associated with the interview. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier of top level object associated with the interview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the note record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
CurcyConvRateType: string
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. -
CurrencyCode: string
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. -
DeleteFlag: boolean
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. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The formatted address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The formatted phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of a note for the opportunity. -
NoteNumber: string
Maximum Length:
30
The system generated number. It can be generated from external system also (user key). -
NoteTitle: string
Title:
Title
Maximum Length:500
The user provided title for the note. -
NoteTxt: string
(byte)
Title:
Note
The column which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code used to classify a note, as asset or adjustment. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The identifier for the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique Identifier of the party to which the note is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of party associated with the opportunity. -
SourceObjectCode: string
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. -
SourceObjectId: string
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. -
UpdateFlag: boolean
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. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunityCampaigns-item-response
Type:
Show Source
object
-
CampaignEndDate: string
(date-time)
Title:
End Date
Read Only:true
The date when marketing integration campaign ends. -
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignName: string
Title:
Campaign Name
Read Only:true
Maximum Length:100
The campaign to which the current opportunity belongs. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The opportunity campaign number public surrogate key for OPTY_CAMPAIGN_NUMBER table. -
CampaignStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The date when marketing integration campaign starts. -
CampaignStatus: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:ORA_DRAFT
The status of marketing integration campaign. -
CampaignType: string
Title:
Type
Read Only:true
Maximum Length:30
The type of marketing integration campaign. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the opportunity campaign record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this record is created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the opportunity campaign data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date and time when this record is created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyCampaignId: integer
(int64)
Title:
Opportunity Campaign ID
The unique identifier of the opportunity campaign. -
OptyCampaignNumber: string
Title:
Opportunity Campaign Number
Maximum Length:30
The unique alternate identifier for the Opportunity Campaign. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. It is the reference key to opportunity header. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The alternate identifier for current opportunity. -
PrimaryFlag: boolean
Title:
Primary
Indicates whether the campaign is primary for the opportunity. -
RevenuePercentage: number
Title:
Revenue Percentage
To store the percentage value of the opportunity's revenue shared by one or more campaigns.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunityCompetitor2-item-response
Type:
Show Source
object
-
CmptPartyId: integer
(int64)
Title:
Party ID
The unique identifier for the competitor party. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments about the opportunity's competitor. -
CompetitorPartyNumber: string
Title:
Competitor Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the competitor party. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the contact record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Opportunity Name
Read Only:true
Maximum Length:275
The name of the opportunity. -
OptyCompetitorId: integer
(int64)
Title:
Opportunity Competitor ID
The unique identifier for the competitor of the opportunity. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier for the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The number of the opportunity which is the unique public identifier of the opportunity. -
PartyName: string
Title:
Competitor
Maximum Length:360
The name of the party. -
PrimaryFlg: string
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. -
ThreatLevelCode: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunityContact-item-response
Type:
Show Source
object
-
AffinityLvlCd: string
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. -
Comments: string
Title:
Comments
Maximum Length:255
The textual comments about the contact on the current opportunity. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
ContactedFlg: string
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. -
ContactPartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The alternate key identifier of the opportunity contact party. -
ContactPointId: integer
The unique identifier of the contact point for an opportunity contact.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the opportunity contact record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the contact record was created. -
DoNotContactFlag: boolean
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. -
EmailAddress: string
Title:
Email
Read Only:true
The e-mail address of the contact. -
EmailPreference: string
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. -
FormattedAddress: string
Title:
Address
Read Only:true
Maximum Length:255
The formatted address of the contact. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the contact. -
InfluenceLvlCd: string
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. -
JobTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The free form text for job title of the opportunity contact. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Maximum Length:
32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyConId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact associated with the opportunity. -
OptyId: integer
(int64)
Title:
Opportunity
The unique identifier of the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The unique alternate identifier for the opportunity. -
OrganizationPartyId: integer
(int64)
Read Only:
true
The unique identifier of the contact's organization. -
OrganizationPartyName: string
Title:
Organization
Read Only:true
Maximum Length:360
The name of the contact's organization. -
OrgContactId: integer
(int64)
Read Only:
true
The unique identifier of the organization contact for the opportunity. -
PartyName: string
Title:
Opportunity Contact Name
Read Only:true
Maximum Length:360
The name of the contact for the opportunity. -
PartyUniqueName: string
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. -
PERPartyId: integer
(int64)
Title:
Opportunity Contact
The party identifier of the opportunity contact. -
PersonCentricJobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the contact person. -
PhonePreference: string
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. -
PreferredContactMethod: string
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. -
PrimaryFlg: string
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. -
RelationshipCode: string
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. -
RelationshipId: integer
(int64)
The identifier of the relationship for the opportunity contact.
-
RoleCd: string
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. -
SalesAffinityCode: string
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. -
SalesBuyingRoleCode: string
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. -
SalesInfluenceLevelCode: string
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunityDeal-item-response
Type:
Show Source
object
-
ApprovedDate: string
(date)
Title:
Approved Date
Read Only:true
The date and time when deal was approved. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the opportunity deal record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the opportunity deal record was created. -
DealExpirationDate: string
(date)
Title:
Expiration Date
Read Only:true
The date and time when the deal is set to expire. -
DealId: integer
Title:
Deal ID
The unique identifier of the deal. -
DealName: string
Title:
Deal Name
Read Only:true
Maximum Length:250
The name of the opportunity deal. -
DealNumber: string
Title:
Registration Number
Maximum Length:30
The alternate key identifier of the deal registration. -
DealSize: number
Title:
Deal Size
Read Only:true
The size of the deal associated with the opportunity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the opportunity deal record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the opportunity deal record. -
LastUpdateLogin: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyDealId: integer
Title:
Opportunity Deal ID
Read Only:true
The unique identifier of the opportunity deal. -
OptyId: integer
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The unique alternate identifier for the opportunity. -
PartnerId: integer
(int64)
Title:
Partner ID
Read Only:true
The unique identifier of the partner tracked in the deal. -
PartyName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner. -
StatusCode: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunityLead-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
ContactName: string
Title:
Contact
Read Only:true
Maximum Length:450
The name of the primary lead contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Module
Read Only:true
Maximum Length:30
The module through which the record was created. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CustomerId: integer
(int64)
Title:
Customer Identifier
Read Only:true
The unique identifier of the customer record in the TCA schema. -
CustomerName: string
Title:
Customer
Read Only:true
Maximum Length:360
The name of the customer. -
DealEstimatedCloseDate: string
(date)
Title:
Deal Registration Estimated Close Date
The date when the deal registration for the opportunity is estimated to be closed. -
DealExpirationDate: string
(date)
Title:
Deal Expiration Date
The date when the lead registration will expire. -
DealPartProgramId: integer
(int64)
Title:
Partner Program ID
The unique identifier of the partner program associated with the lead registration. -
DealSize: number
Title:
Deal Size
Read Only:true
The deal size of the deal associated with the opportunity. -
DealType: string
Title:
Lead Registration Type
Maximum Length:30
The deal or lead registration type for the opportunity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the record. -
LeadAging: integer
Title:
Age in Days
Read Only:true
The number of days elapsed since the lead was created. -
LeadId: integer
(int64)
Title:
Lead Identifier
Read Only:true
The unique identifier of the lead for the opportunity. -
LeadName: string
Title:
Lead Name
Read Only:true
Maximum Length:250
The name of the lead associated with the opportunity. -
LeadNumber: string
Title:
Lead Number
Maximum Length:64
The alternate key identifier of the lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectUsage: string
Title:
Object Usage
Maximum Length:30
Indicates whether the current record represents a lead or a deal. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyLeadId: integer
(int64)
Title:
Opportunity Lead ID
The unique identifier of the lead for the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The number of the opportunity which is the unique public identifier of the opportunity. -
PartnerTypeCd: string
Title:
Partner Type
Maximum Length:250
The code indicating the type of the partner for the lead registration. -
PrDealPartOrgPartyId: integer
(int64)
Title:
Partner Organization Party ID
The unique identifier for the partner on the lead registration. -
PrDealPartResourcePartyId: integer
(int64)
Title:
Primary Partner Resource ID
The unique identifier for the primary partner resource on the lead registration. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact Identifier
Read Only:true
The unique identifier of the sales lead contact marked as a primary lead contact. -
Rank: string
Title:
Rank
Read Only:true
Maximum Length:30
The rank of the lead associated with the opportunity. -
RankMeaning: string
Title:
Rank
Read Only:true
The meaning of the rank code for the associated lead. -
RegistrationNumber: string
Title:
Registration Number
Maximum Length:120
The unique registration number of the lead for the opportunity. -
StatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
The code indicating the status of the opportunity lead. -
StatusCodeMeaning: string
Title:
Status
Read Only:true
The meaning of the status code for the associated lead. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the opportunity lead was last updated from mobile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunityResource-item-response
Type:
Show Source
object
-
AccessLevelCode: string
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. -
AsgnTerritoryVersionId: integer
(int64)
Title:
Territory
The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment. -
AssignmentType: string
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. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the opportunity resource record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the resource record was created. -
DealExpirationDate: string
(date)
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. -
DealProtected: string
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. -
DealProtectedDate: string
(date)
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. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The e-mail address of the opportunity team member. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the opportunity team member. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockAssignmentFlag: boolean
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'. -
MemberFunctionCode: string
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. -
MgrResourceId: integer
Read Only:
true
The unique identifier of the resource team member's manager. -
OptyId: integer
(int64)
The unique Identifier of the opportunity.
-
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The unique alternate identifier for the opportunity. -
OptyResourceId: integer
(int64)
Title:
Opportunity Resource ID
The unique party identifier for the existing opportunity resource. -
OptyResourceNumber: string
Title:
Opportunity Resource Number
Maximum Length:30
The alternate key identifier of the opportunity resource. -
OwnerFlag: boolean
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. -
PartnerOrgId: integer
(int64)
Title:
Name
The unique identifier of the partner organization. -
PartnerPartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the partner associated with the partner resource. -
PartyName: string
Title:
Team Member
Read Only:true
Maximum Length:360
The name of the opportunity team member. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the opportunity team member. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the opportunity team member. -
ResourceId: integer
(int64)
Title:
Team Member
The unique party identifier for the existing resource. -
ResourcePartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The alternate key identifier of the opportunity resource party. -
RoleName: string
Title:
Role
Read Only:true
Maximum Length:60
The role of the opportunity team member in the resource organization. -
TerritoryName: string
Title:
Territory
Read Only:true
Maximum Length:60
The name of the opportunity team member's territory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunityRollup-item-response
Type:
Show Source
object
-
CallsMade: number
Title:
Total Calls Made
Read Only:true
The total number of outbound calls made in context of the opportunity. -
CorpCurrencyCode: string
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EmailsSent: number
Title:
Total Emails Sent
Read Only:true
The total number of emails sent in context of the opportunity. -
LastCallMadeDate: string
(date-time)
Title:
Last Call Made
Read Only:true
The date when last outbound call was made in context of the opportunity. -
LastCompletedActivity: string
(date-time)
Title:
Last Completed Activity
Read Only:true
The date of last completed activity for an opportunity. Activity includes task, appointment, and call report. -
LastEmailSentDate: string
(date-time)
Title:
Last Email Sent
Read Only:true
The date when last email was sent in context of the opportunity. -
LastTouchDate: string
(date-time)
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. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextTaskDue: string
(date)
Title:
Next Task Due
Read Only:true
The date when a task is due for an opportunity. -
NumberOfOpenActivities: number
Title:
Total Open Activities
Read Only:true
The total number of activities that are open for the opportunity. -
NumberOfTouches: number
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. -
OptyId: integer
(int64)
Title:
Opportunity Identifier
Read Only:true
The unique identifier of the opportunity. -
TotalCompletedActivities: number
Title:
Total Completed Activities
Read Only:true
The total number of completed activities for an opportunity. -
TotalNotes: number
Title:
Total Notes
Read Only:true
The total number of public notes associated with an opportunity. -
TotalQuotes: number
Title:
Total Quotes
Read Only:true
The total number of quotes for an opportunity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunitySource1-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Maximum Length:
32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyId: integer
(int64)
The unique Identifier of the opportunity.
-
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The number of the opportunity which is the unique public identifier of the opportunity. -
OptySrcId: integer
(int64)
The unique Identifier of the source of the opportunity.
-
SrcNumber: string
Title:
Source Code
Maximum Length:100
A unique number indicating the source of the marketing event for the opportunity, such as campaign, new product line, a marketing seminar, and so on. -
UserLastUpdateDate: string
(date-time)
The date and time when the opportunity was last updated from mobile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-opportunityStageSnapshots-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the opportunity stage snapshot is active. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
This value is used to guarantee the uniqueness of the row when duplicates are created in different databases. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the opportunity stage snapshot. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the opportunity stage snapshot was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the opportunity stage snapshot was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the opportunity stage snapshot. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the opportunity stage snapshot. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Sales Stage
Read Only:true
Maximum Length:50
The name of the opportunity stage snapshot. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyStgSnapshotId: integer
(int64)
Title:
Opportunity Stage Snapshot ID
The unique identifier of the opportunity stage snapshot. -
PhaseCd: string
Title:
Sales Stage Phase
Read Only:true
Maximum Length:30
Default Value:"B - Working the Deal"
The current phase of the opportunity sales stage. -
QuotaFactor: number
Title:
Sales Stage Quota Factor
Read Only:true
The quota factor of the opportunity sales stage. -
StageStatusCd: string
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. -
StgEnterDate: string
(date-time)
Title:
Sales Stage Enter Date
The date when the opportunity entered a sales stage. -
StgExitDate: string
(date-time)
Title:
Sales Stage Exit Date
The date when the opportunity exited a sales stage. -
StgId: integer
(int64)
Title:
Sales Stage ID
The unique identifier of the opportunity sales stage. -
StgOrder: number
Title:
Sales Stage Order
Read Only:true
The order of the opportunity's sales stage in the sales method.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunitySubscription-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:15
The currency associated with the subscription. -
DeleteFlag: boolean
Title:
Deleted
Read Only:true
Indicates whether the user has access to delete the record. -
EndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The end date of the subscription. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetPrice: number
Title:
Total Contract Value
Read Only:true
The total contract value of the subscription. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptySubscriptionId: integer
(int64)
Title:
Opportunity Subscription ID
The primary key and the unique internal identifier of the row. -
OptySubscriptionNumber: string
Title:
Opportunity Subscription Number
Maximum Length:30
The unique subscription number to associate a subscription with an opportunity. -
PrimaryFlag: boolean
Title:
Primary
Indicates whether a subscription is the Primary Subscription associated with the opportunity. -
StartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The start date of the subscription. -
Status: string
Title:
Subscription Status
Read Only:true
Maximum Length:30
The current status of the subscription. -
SubscriptionId: integer
(int64)
Title:
Subscription ID
The subscription associated with an opportunity. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The number assigned to the line within a subscription by the system or the customer. -
SubscriptionPeriod: string
Title:
Subscription Term
The duration of the subscription. -
UpdateFlag: boolean
Title:
Updated
Read Only:true
Indicates whether the user has access to update the record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OpportunityTeam-item-response
Type:
Show Source
object
-
AccessLevelCode: string
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. -
AsgnTerrBasedInd: string
Read Only:
true
Maximum Length:1
Indicates the territory is assigned using automatic territory-based assignment. -
AsgnTerritoryVersionId: integer
(int64)
Title:
Territory
Read Only:true
Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment. -
AssignmentType: string
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. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city of the resource. -
ConflictId: integer
(int64)
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. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
The country code of the resource. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the opportunity resource record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time of the creation of the opportunity resource record. -
DealExpirationDate: string
(date)
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. -
DealProtectedDate: string
(date)
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. -
EmailAddress: string
Read Only:
true
Maximum Length:320
The e-mail address of the resource. -
ForecastParticipationCode: string
Title:
Enable Forecasting
Read Only:true
Maximum Length:30
Default Value:REVENUE
The forecast participation type of the territory. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The formatted phone number for the opportunity team member. -
FunctionCode: string
Title:
Function
Read Only:true
Maximum Length:30
The code of the function or role of the territory team member. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time of the last update of the opportunity resource record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the opportunity resource record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the opportunity resource record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockAssignmentFlag: boolean
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. -
MemberFunctionCode: string
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. -
OptyId: integer
(int64)
The unique identifier of the opportunity.
-
OptyNumber: string
Title:
Opportunity Number
Read Only:true
Maximum Length:30
The alternate unique identifier of the opportunity associated with the opportunity team. -
OptyResourceId: integer
(int64)
Title:
Opportunity Resource ID
Read Only:true
The unique identifier of the opportunity resource. -
OptyResourceNumber: string
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). -
OptyTeamId: string
Read Only:
true
Maximum Length:255
The unique key to identify the opportunity team member. -
OwnerFlag: boolean
Title:
Primary
Read Only:true
Indicates whether the opportunity team member is the owner of the opportunity. -
PartnerOrgId: integer
(int64)
Read Only:
true
The unique party identifier of the partner organization that the partner resource belongs to. -
PartnerPartyName: string
Read Only:
true
Maximum Length:360
The name of the partner organization that the partner resource belongs to. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The full name of the opportunity team member. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the opportunity team member. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the opportunity team member. -
PrimaryPhoneNumber: string
Read Only:
true
Maximum Length:40
The primary formatted phone number for the resource. -
ResourceId: integer
(int64)
The unique identifier of the resource.
-
ResourcePartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The resource party number of the opportunity team member. -
RoleName: string
Read Only:
true
Maximum Length:255
The role of the resource. -
State: string
Title:
State
Read Only:true
Maximum Length:60
The state of the resource. -
TerritoryFunctionCode: string
Title:
Territory Function
Read Only:true
Maximum Length:30
The code of the business function of the territory. -
TerritoryName: string
Title:
Territory Name
Read Only:true
Maximum Length:60
The name of the territory. -
TerritoryOwnerFlag: boolean
Read Only:
true
Indicates whether the opportunity team member is the territory owner. -
TerritoryVersionId: integer
(int64)
The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
-
TypeCode: string
Title:
Type
Read Only:true
Maximum Length:30
Default Value:PRIME
The code of the type of the territory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-item-response
Type:
Show Source
object
-
ActionParameters: string
Title:
Action Parameters
Maximum Length:1000
List of parameters required to execute the action specified through PERFORM_ACTION field. -
AssociationStatusCode: string
Title:
Association Status Code
Maximum Length:30
The status of the association. -
CompletedObjsCnt: integer
Title:
Completed Objectives Count
Read Only:true
The count of completed objectives. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrentAssocFlag: boolean
Title:
Current Association
Read Only:true
Maximum Length:1
Indicates whether it's the current ACTIVE association or the most recently updated association. -
ErrorLogs: array
Error Logs
Title:
Error Logs
The error logs resource is used to view error logs associated to the orchestration associations. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextStepId: integer
(int64)
Title:
Next Step ID
Read Only:true
The unique identifier of the next step to be executed as part of the current Orchestration. -
NextStepSmartActionId: integer
(int64)
Title:
Next Step Smart Action ID
Read Only:true
The smart action identifier of the next step to be executed as part of the current Orchestration. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationAssociationNumber: string
Title:
Orchestration Association Number
Maximum Length:64
The alternate identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
PendingObjectivesCount: integer
Title:
Pending Objectives Count
Read Only:true
Number of pending objectives. -
PerformAction: string
Title:
Action to Perform
Maximum Length:30
The action that user can perform on this orchestration association. -
SkippedNothelpfulObjsCnt: integer
Title:
Skipped Objectives Count
Read Only:true
The count of skipped or not helpful objectives. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:100
The language independent object code. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier for the source object code. -
StageObjectives: array
Stage Objectives
Title:
Stage Objectives
The stage objectives resource is used to view the stage objectives of the orchestration association. -
Stages: array
Stages
Title:
Stages
The stages resource is used to view the stage of the orchestration association. -
Steps: array
Steps
Title:
Steps
The steps resource is used to view the steps of the orchestration association. -
StepsInExecutionPath: array
Steps In Execution Path
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. -
StepTransitions: array
Step Transitions
Title:
Step Transitions
The step transitions resource is used to view the step transitions of the orchestration association. -
TotalObjsCnt: integer
Title:
Total Objectives Count
Read Only:true
The total number of objectives.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
ErrorDescription: string
(byte)
Title:
Error Description
The description of the error. -
ErrorLogsId: integer
(int64)
Title:
Error Logs ID
The unique identifier of the orchestration error logs. -
ErrorLogsNumber: string
Title:
Error Logs Number
Maximum Length:64
The alternate identifier of the orchestration error logs. -
ErrorText: string
Title:
Error Text
Maximum Length:2000
The brief error details. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:100
The language independent object code. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier for the source object code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StageObjectives-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DisplaySequence: integer
Title:
Display Sequence
The order in which the stages are to be executed or shown back in UI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the stages in the orchestration admin run time UIs. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageObjDescription: string
Title:
Objective Description
Read Only:true
Maximum Length:2000
The description text of the orchestration stage objective object. -
OrchestrationStageObjDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the stages in the orchestration admin run time UIs. -
OrchestrationStageObjectiveId: integer
(int64)
Title:
Stage Objective ID
The unique identifier of the orchestration stage objective object. -
OrchestrationStageObjName: string
Title:
Objective Name
Read Only:true
Maximum Length:100
The name of the orchestration stage objective object. -
OrchestrationStageObjNumber: string
Title:
Stage Objective Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage objective object. -
RunTimeStageObjectiveId: integer
(int64)
Title:
Run Time Stage Objective ID
The unique identifier of the orchestration stage objective object. -
RunTimeStageObjectiveNumber: string
Title:
Run Time Stage Objective Number
Maximum Length:64
The alternate identifier of the orchestration stage objective object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The status of the orchestration stage objective transition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-Stages-item-response
Type:
Show Source
object
-
CompletedObjsCnt: integer
Title:
Completed Objectives Count
The count of completed objectives. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrentStageFlag: boolean
Title:
Current Stage
Maximum Length:1
Indicates whether it's the current INPROGRESS stage or the most recently updated stage. -
DisplaySequence: integer
Title:
Display Sequence
The order in which the stage objectives are to be executed or shown back in UI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageDescription: string
Title:
Objective Description
Read Only:true
Maximum Length:2000
The description text of the orchestration stage object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
PendingObjectivesCount: integer
Title:
Pending Objectives Count
Number of pending objectives. -
RuntimeStageId: integer
(int64)
Title:
Run Time Stage ID
The unique identifier of the orchestration stages runtime object. -
RuntimeStageNumber: string
Title:
Run Time Stage Number
Maximum Length:64
The alternate identifier of the orchestration stages runtime object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The status of the orchestration stages. -
SkippedNothelpfulObjsCnt: integer
Title:
Skipped Objectives Count
The count of skipped or not helpful objectives. -
StageEndDate: string
(date-time)
Title:
Stage End Date
The date and time when the stage execution starts. -
StageStartDate: string
(date-time)
Title:
Stage Start Date
The date and time when the stage execution ends. -
StepsCountInExecutionPath: integer
Title:
Step Count in Execution Path
Read Only:true
Number of Steps in the execution path for the orchestration stage. -
TotalObjsCnt: integer
Title:
Total Objectives Count
The total number of objectives.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-Steps-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrentStepFlag: boolean
Title:
Current Step
Maximum Length:1
Indicates whether it's the current INPROGRESS step or the most recently updated step. -
DisplaySequence: integer
Title:
Display Sequence
The order in which the steps are to be executed or shown back in UI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The run time status of the orchestration stage objective transition. -
RunTimeStepId: integer
(int64)
Title:
Run Time Step ID
The unique identifier of the orchestration steps runtime object. -
RunTimeStepNumber: string
Title:
Run Time Step Number
Maximum Length:64
The alternate identifier of the orchestration steps runtime object. -
StepEndDate: string
(date-time)
Title:
Step End Date
The date and time when the step execution ends. -
StepStartDate: string
(date-time)
Title:
Step Start Date
The date and time when the step execution starts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StepsInExecutionPath-item-response
Type:
Show Source
object
-
ContainMultipleTasks: string
Read Only:
true
Maximum Length:1
Indicates whether the step contains multiple tasks. -
CurrentStepFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether it's the current INPROGRESS step or the most recently updated step. -
DisplaySequence: integer
(int32)
Read Only:
true
The order of the steps in the orchestration administrator runtime UIs. -
ExecutionMethod: string
Read Only:
true
Maximum Length:30
The execution type for the orchestration step. The possible values are Manual and Automatic. -
FulfillsObjectiveCnt: integer
Read Only:
true
The count of objectives. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssocId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration association. -
OrchestrationStageId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration stage object. -
OrchestrationStageObjId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration stage objective object. -
OrchestrationStepId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Read Only:
true
Maximum Length:100
The name of orchestration step. -
RunTimeStatus: string
Read Only:
true
Maximum Length:30
The runtime status of the orchestration steps. -
StepEndDate: string
(date-time)
Read Only:
true
Specifies the date and time when the step execution ends. -
StepStartDate: string
(date-time)
Read Only:
true
Specifies the date and time when the step execution starts. -
StepSuggestionText: string
Read Only:
true
Maximum Length:2000
Suggestion text of the Orchestration step. -
StepType: string
Read Only:
true
Maximum Length:30
The type of step.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StepTransitions-item-response
Type:
Show Source
object
-
ActivityAppointmentStatusCode: string
Title:
Appointment Status
Read Only:true
Maximum Length:30
Denotes the status of the Appointment. -
ActivityDescription: string
(byte)
Title:
Description
Read Only:true
A text field for capturing some descriptive information about the activity. -
ActivityDueDate: string
(date)
Title:
Due Date
Read Only:true
The date the task activity is due to be completed. -
ActivityEndDate: string
(date-time)
Title:
End Date
Read Only:true
The end date and time of an appointment, or the completion time of a task. -
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the activity. -
ActivityNumber: string
Title:
Activity Number
Read Only:true
Maximum Length:64
Alternate identifier of the activity. System generated or can come from external system (user key). -
ActivityOwnerId: integer
(int64)
Title:
Owner ID
Read Only:true
The primary resource on the activity. Supports resources only. -
ActivityOwnerPartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
Name of the party. -
ActivityPartialDescription: string
Title:
Short Description
Read Only:true
Maximum Length:4000
A column that stores the first 4000 characters of activity description. -
ActivitySMARTActionContext: string
Title:
Smart Action Context
Read Only:true
Maximum Length:4000
Stores metadata needed for smart action -
ActivitySMARTActionId: integer
(int64)
Title:
Smart Action ID
Read Only:true
Smart action identifier. Foriegn key from zca_user_action. -
ActivityStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation datetime for a task. -
ActivitySubject: string
Title:
Subject
Read Only:true
Maximum Length:500
Subject or name ot title of the activity. -
ActivityTaskStatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
Status of the activity. Defaulted to NOT_STARTED. -
ActivityWebConferenceId: string
Title:
Web Conference ID
Read Only:true
Maximum Length:255
The unique identifier of the web conference. -
ActivityWebConferenceURL: string
Title:
Web Conference URL
Read Only:true
Maximum Length:2000
The web conference join URL. -
AllowSkipFlag: boolean
Title:
Allow Step Skipping
Read Only:true
Maximum Length:1
Default Value:true
Indicates whether or not to show skip or thumbs down icon in guidance primary or secondary banner. -
Comments: string
Title:
Comments
Maximum Length:2000
Specifies the brief comments required for runtime step transition row. -
ConversationId: integer
(int64)
Title:
Conversation ID
The unique identifier of conversation message. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EmailType: string
Title:
Email Type
Maximum Length:30
The orchestration step transition runtime email type. -
ExitOrchestrationFlag: boolean
Title:
Exit Orchestration
Read Only:true
Maximum Length:1
Indicates whether or not to exit the orchestration when stop step occurs. -
InboundConvMsgId: integer
(int64)
Title:
Inbound Conversation Message ID
The unique identifier of inbound conversation message. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationAssociationNumber: string
Title:
Orchestration Association Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
OrchestrationStepTasksId: integer
(int64)
Title:
Orchestration Step Tasks ID
Unique identifier for the orchestration step tasks. -
OrchestrationStepType: string
Title:
Step Type
Read Only:true
Maximum Length:30
The type of step. -
OrchStepTransitionFlag: boolean
Title:
Current Step Transition
Maximum Length:1
Indicates whether it's the current INPROGRESS Step transition or the most recently updated step transition row. -
OutboundConvMsgId: integer
(int64)
Title:
Outbound Conversation Message ID
The unique identifier of outbound conversation message. -
RefreshPageFlag: boolean
Title:
Refresh Page
Maximum Length:1
Indicates whether or not to refresh the whole page before surfacing the current Step in the runtime UI. -
StepDisplaySequence: integer
Title:
Display Sequence
Read Only:true
The order of the steps in the orchestration administrator runtime UIs. -
StepSuggestionText: string
Title:
Step Suggestion Text
Read Only:true
Maximum Length:2000
Suggestion text of the Orchestration step. -
StepTaskDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the steps in the orchestration administrator runtime UIs. -
StepTransitionId: integer
(int64)
Title:
Step Transition ID
The unique identifier of the orchestration step transition object. -
StepTransitionNumber: string
Title:
Step Transition Number
Maximum Length:64
The alternate identifier of the orchestration step transition object. -
StepType: string
Title:
Step Type
Maximum Length:30
The type of the step to which the step transitions correspond to. -
SuccessCriteriaEvalFlag: boolean
Title:
Success Criteria Evaluation Flag
Maximum Length:1
Specifies the success criteria evaluation result for the step. -
TransitionDueDateTime: string
(date-time)
Title:
Transition Due Date Time
The date and time when the step transition is due. -
TransitionEndDateTime: string
(date-time)
Title:
Transition End Date Time
The date and time when the step transition ended. -
TransitionStartDateTime: string
(date-time)
Title:
Transition Start Date Time
The date and time when the step transition started. -
TransitionStatus: string
Title:
Transition Status
Maximum Length:30
The status of the orchestration step transition. -
WrapUpId: integer
(int64)
Title:
Wrap-up ID
The unique identifier of the wrap up.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-RevenuePartnerPrimary-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the contact record was created. -
DealEstCloseDate: string
(date-time)
Title:
Deal Registration Estimated Close Date
The date when the deal registration is estimated to close. -
DealExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the deal registration will expire. -
DealType: string
Title:
Type
Maximum Length:30
The type of deal registration. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The number of the opportunity which is the unique public identifier of the opportunity. -
PartnerCompanyNumber: string
Title:
Partner Company Number
Maximum Length:30
The alternate key identifier of the partner's company. -
PartnerPartyNumber: string
Read Only:
true
Maximum Length:30
The alternate key identifier of the partner party associated with the opportunity. -
PartOrgEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the primary partner organization for this revenue. -
PartOrgFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the primary partner organization for this revenue. -
PartOrgPartyId: integer
(int64)
Title:
Name
The unique identifier of the partner organization associated with the revenue. -
PartProgramId: integer
(int64)
Title:
Program
The unique identifier of the partner program associated with the revenue. -
PartTypeCd: string
Title:
Type
Maximum Length:30
The code indicating the type of the party associated with the summary or primary revenue of the opportunity. A list of valid values is defined in the lookup PARTNER_PROFILE. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of the partner party is associated with the opportunity. -
PartyName: string
Title:
Partner
Maximum Length:360
The name of the partner party associated with the opportunity. -
PartyName1: string
Title:
Primary Resource
Maximum Length:360
The name of the primary partner resource associated with the opportunity. -
PreferredContactEmail: string
Title:
Contact Email
Read Only:true
The preferred e-mail address of the partner???s primary contact. -
PreferredContactName: string
Title:
Primary Contact
Read Only:true
The preferred name of the partner???s primary contact. -
PreferredContactPhone: string
Title:
Contact Phone
Read Only:true
The preferred phone number of the partner???s primary contact. -
PrimaryFlg: string
Title:
Primary
Indicates whether the Revenue Partner is the primary Revenue Partner for the opportunity. -
PrPartResourcePartyId: integer
(int64)
Title:
Primary Resource
The unique identifier of the primary partner resource. -
RegistrationNumber: string
Title:
Registration Number
Maximum Length:120
The registration number of the deal registration. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:30
The registration status of the partner who create the opportunity or deal. -
RevnId: integer
(int64)
The unique identifier of the summary or primary revenue for the opportunity.
-
RevnPartnerNumber: string
Title:
Opportunity Partner Number
Maximum Length:30
The party number of the partner record. -
RevnPartOrgPartyId: integer
(int64)
The unique identifier of the partner party associated with the opportunity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
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. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates if action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function for smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
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. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
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. -
UserActionURLBinding: array
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
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. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
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. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
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. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-winProbabilityDetails-item-response
Type:
Show Source
object
-
DataType: string
Read Only:
true
Maximum Length:255
The data type associated with the value of the feature used for predictions from the AI models. -
FeatureName: string
Read Only:
true
The name of the feature used for predictions from the AI models. -
FeatureValue: string
Read Only:
true
Maximum Length:255
The value of the feature used for predictions from the AI models. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AiObjectHints
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
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. - OptyNumber:
- Assessments
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The assessments resource is used to view, create, update, and delete the assessment of an opportunity. - OptyNumber:
- AssetVA
-
Operation: /crmRestApi/resources/11.13.18.05/assetsAssets represents the products owned by Customers. Anything tangible or intangible that is capable of being owned or controlled to produce value. For example: Tangible Items - Computers, engines, machine parts, and so on. Intangible items - Software, Services, Licenses and agreements
- AssignmentModeLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{AssignmentMode}%2CBindLookupType%3DORA_MOO_OPTY_ASGN_MODE_OPTIONS
The lookups resource is used to view standard lookup codes. - finder:
- Attachment
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity. - OptyNumber:
- BusinessUnitPVO
-
The CRM business units resource is used to view the business unit details.
- CampaignVOVA
-
Operation: /crmRestApi/resources/11.13.18.05/campaignsThe campaigns resource is used to view, create, update, and delete campaigns. A campaign is an effort reach out to contacts and leads to convert them to a customer.
- ChildRevenue
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
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. - OptyNumber:
- ClosePeriodLookupPVO
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_CLS_PERIOD
The lookups resource is used to view standard lookup codes. - finder:
- CustomerAccountPickerVO
-
Operation: /crmRestApi/resources/11.13.18.05/accountsAn account for a customer or prospect. This object is an aggregation of primary account profile, and contact information, and references a single primary address.
- ForecastCategoryVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ForecastCategory}%2CBindLookupType%3DORA_MOO_FORECAST_CATEGORY_TYPE
The lookups resource is used to view standard lookup codes. - finder:
- FrcstOverrideCodeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZSF_FCST_INCLUDE_IN_FCST%2CBindLookupCode%3D{ForecastOverrideCode}
The lookups resource is used to view standard lookup codes. - finder:
- Interviews
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The interviews resource is used to view the list of interviews related to the opportunities. - OptyNumber:
- LobForSearchLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_LINE_OF_BUSINESS%2CBindLookupCode%3D{LineOfBusinessCode}
The lookups resource is used to view standard lookup codes. - finder:
- Note
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
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. - OptyNumber:
- OpportunityCampaigns
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity. - OptyNumber:
- OpportunityCompetitor2
-
Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2Parameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity. - OptyNumber:
- OpportunityContact
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
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. - OptyNumber:
- OpportunityDeal
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity deals resource is used to view the deals associated with an opportunity. - OptyNumber:
- OpportunityLead
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity. - OptyNumber:
- OpportunityOriginVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{OpportunityOrigin}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_ORIGIN
The lookups resource is used to view standard lookup codes. - finder:
- OpportunityResource
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity. - OptyNumber:
- OpportunityRollup
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity rollups resource is used to view an opportunity rollup. - OptyNumber:
- OpportunitySource1
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
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. - OptyNumber:
- OpportunitySubscription
-
Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySubscriptionParameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level. - OptyNumber:
- OpportunityTeam
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity teams resource is used to view the team members and territory team members associated with an opportunity. - OptyNumber:
- OpportunityTypePVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{OpportunityTypeCode}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_TYPE
The lookups resource is used to view standard lookup codes. - finder:
- OptyDealHorizonLOV
-
Parameters:
- finder:
CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_DEAL_HORIZION%2CpReferenceGroupName%3DMOO_SETID_DEAL_HORIZION%2CpEnabledFlag%3DY
The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id. - finder:
- OptyDecisionLevelLOV
-
Parameters:
- finder:
CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_DECISION_LEVEL%2CpReferenceGroupName%3DMOO_SETID_DECISION_LEVEL%2CpEnabledFlag%3DY
The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id. - finder:
- OptyRenewalProcessPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RenewalProcess}%2CBindLookupType%3DORA_MOO_OPTY_RENEWAL_PROCESS
The lookups resource is used to view standard lookup codes. - finder:
- OptyRiskLevelLOV
-
Parameters:
- finder:
CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_RISK_LEVEL%2CpReferenceGroupName%3DMOO_SETID_RISK_LEVEL%2CpEnabledFlag%3DY
The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id. - finder:
- OptyStatusCategoryLookupVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZBS_SALESLOOKUPS_CATEGORY
The lookups resource is used to view standard lookup codes. - finder:
- OptyStatusZbsValuesLOV
-
Parameters:
- finder:
StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS%2CBindBUId%3D{PrimaryOrganizationId}
The configurable setup data defined specifically for sales usage. - finder:
- OptyStrategicValueLOV
-
Parameters:
- finder:
CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_STRATEGIC_VALUE%2CpReferenceGroupName%3DMOO_SETID_STRATEGIC_VALUE%2CpEnabledFlag%3DY
The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id. - finder:
- OrchestrationAssociations
-
Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociationsParameters:
- OptyNumber:
$request.path.OptyNumber
The orchestrations associations resource is used to view, create, update, and delete an orchestration association. - OptyNumber:
- PartnerPickerVA
-
Parameters:
- finder:
ActivePartnersFinder%3BBindDefaultStatus%3DACTIVE%2CBindExtraStatus%3DACTIVE
The partner list of values resource is used to view a list of partners. - finder:
- RatedCurrenciesVO
-
The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
- ReasonWonLostLOV
-
Parameters:
- finder:
CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpEnabledFlag%3DY%2CpLookupType%3DMOO_SETID_WIN_LOSS_REASON%2CpReferenceGroupName%3DMOO_SETID_WIN_LOSS_REASON
The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id. - finder:
- RegisteredLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_DEAL_REGISTERED_FLAG
The lookups resource is used to view standard lookup codes. - finder:
- RegistrationStatusLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DOPTY_PARTNER_REGISTRATION_TYPE%2CBindLookupCode%3D{RegistrationStatus}
The lookups resource is used to view standard lookup codes. - finder:
- RegistrationTypeLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DPARTNER_REGISTRATION_INITIATOR%2CBindLookupCode%3D{RegistrationType}
The lookups resource is used to view standard lookup codes. - finder:
- RevenuePartnerPrimary
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
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. - OptyNumber:
- RevenueSalesChannelLookupVO
-
Parameters:
- finder:
SalesChannelFinder%3BBindLookupCode%3DZPM_PARTNER_CHANNEL_TYPES%2CBindLookupType%3DZPM_SALES_CHANNEL
The resource is used to view the values for sales channels of opportunity revenue. - finder:
- SalesMethodLOV
-
Parameters:
- finder:
SalesMethodByBUFinder%3BBindBUId%3D{PrimaryOrganizationId}%2CBindOpportunityType%3D{OpportunityTypeCode}
A sales method is an approach used in the sales process. A method can encompass every stage associated with the sales process, from prospecting to forecasting to closing opportunities. - finder:
- SalesStageLOV
-
Parameters:
- finder:
SalesStageBySalesMethodFinder%3BBindSalesMethodId%3D{SalesMethodId}
The sales stage for a given sales method describes the progress of an opportunity in the sales cycle. - finder:
- SearchFilteringLookupPVO
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_RECORD_SET
The lookups resource is used to view standard lookup codes. - finder:
- YesNoLOV
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DYES_NO
The lookups resource is used to view standard lookup codes. - finder:
- opportunityStageSnapshots
-
Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/opportunityStageSnapshotsParameters:
- OptyNumber:
$request.path.OptyNumber
The opportunity stage snapshots is used to view all the historical snapshots of the opportunity. - OptyNumber:
- smartActions
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
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. - OptyNumber:
- winProbabilityDetails
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
The win probability details resource is used to view the details of the winning probability of an opportunity. - OptyNumber:
Examples
The following example shows how to get an opportunity by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_332708
Example of Response Body
The following shows an example of the response body in JSON format.
{ "PrimaryOrganizationId" : 204, "CurrencyCode" : "USD", "SalesMethodId" : 100000012430001, "SalesStageId" : 100000012430007, "Name" : "Major Server Upgrade", "OptyId" : 300100111705686, "OptyNumber" : "CDRM_332708", "OwnerResourcePartyId" : 3807, "KeyContactId" : 100000016105039, "PrimaryRevenueId" : 300100111705687, "SalesMethod" : "Standard Sales Process", "SalesStage" : "01 - Qualification", "DescriptionText" : "Looking for the Right Contacts, Characteristics, Determining the Need, Budget and Sponsor", "AverageDaysAtStage" : 30, "MaximumDaysInStage" : 800, "PhaseCd" : "QUALIFICATION-DISCOVERY", "ForecastOverrideCode" : "CRITERIA", "SalesChannelCd" : "ZPM_DIRECT_CHANNEL_TYPES", ... }