Opportunities: Required Attributes and Path Parameters
This section lists the required attributes and path parameters for the request payloads of the Opportunities resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
|
Parent Level |
Opportunity |
|
Child Resources |
Opportunity Contacts |
|
Opportunity Resources |
|
|
Opportunity Revenue Partner |
|
|
Notes |
|
|
Revenue Items |
|
|
Revenue Items > Opportunity Revenue Territories |
|
|
Opportunity Sources |
|
|
Opportunity Competitors |
|
|
Opportunity Leads |
|
|
Assessments |
|
|
Assessments > Assessment Answer Groups |
|
|
Assessments > Assessment Answer Groups > Assessment Answers |
The following table lists the attributes required for the POST method for Opportunities resource.
| Resource | Attribute | Attribute Description |
|---|---|---|
|
Opportunity |
Name |
The name of the lead associated with the opportunity. |
The following table lists the attributes required for the POST method for Opportunities child resources.
| Resource | Attribute | Attribute Description |
|---|---|---|
|
Opportunity > Opportunity Contacts |
PERPartyId |
The unique identifier of a valid employee resource who owns and manages the opportunity. |
|
Opportunity > Opportunity Resources |
ResourceId |
The unique party identifier for the existing resource record in Oracle Sales and Fusion Service. |
|
Opportunity > Opportunity Revenue Partner |
PartOrgPartyId |
The unique identifier of the partner organization associated with the revenue. |
|
Opportunity > Notes |
NoteTxt |
The column to store the note text. |
|
NoteTypeCode |
The note type code for categorization of the note. The list of values for the note type code is available in the NoteSourceTypeVA. |
|
|
Opportunity > Revenue Items |
ProdGroupId |
The unique identifier of the product group. |
|
InventoryItemId |
The unique identifier of the product in the inventory. |
|
|
InventoryOrgId |
The unique identifier of the organization in the inventory. |
|
|
Opportnity > Revenue Items > Opportunity Revenue Territories |
TerritoryVersionId |
Territory version identifier. |
|
PartyName |
The name of the territory owner for the opportunity. |
|
|
TerritoryId |
Territory identifier. |
|
|
Name |
The name of the territory that the opportunity belongs to. |
|
|
Opportunity > Opportunity Sources |
SrcNumber |
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. |
|
Opportunity > Opportunity Competitors |
CmptPartyId |
The unique identifier for the competitor party. |
|
Opportunity > Opportunity Leads |
LeadNumber |
The unique identification number for the lead. |
|
Opportunity > Assessments |
AssessTemplateId |
The name of the assessment template that served as the source of this assessment. |
Note:
You can use either ProductGroupId or InverntoryItemId and InventoryOrgId for the Child Revenue child resource.The following table lists the path parameters required for the PATCH method for the Opportunities resource.
| Resource | Path | Path Parameters |
|---|---|---|
|
Opportunity |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId} |
OptyId |
The following table lists the path parameters required for the PATCH method for the Opportunities child resources.
| Resource | Path | Path Parameters |
|---|---|---|
|
Opportunity > Opportunity Contacts |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/OpportunityContact/{OptyConId} |
OptyId OptyConId |
|
Opportunity > Opportunity Resources |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/OpportunityResource/{OptyResourceId } |
OptyId OptyResourceId |
|
Opportunity > Opportunity Revenue Partners |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/RevenuePartnerPrimary/{RevnPartOrgPartyId } |
OptyId RevnPartOrgPartyId |
|
Opportunity > Notes |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}}/child/Note/{NoteId } |
OptyId NoteId |
|
Opportunity > Revenue Items |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/childRevenue/{RevnId} |
OptyId RevnId |
|
Opportunity > Revenue Items > Opportunity Revenue Territories |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/ChildRevenue/{RevnId}/child/RevenueTerritory/{RevenueTerritoryUniqID} |
OptyId RevnId RevenueTerritoryUniqID |
|
Opportunity > Opportunity Sources |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/OpportunitySource1/{OptySrcId } |
OptyId OptySrcId |
|
Opportunity > Opportunity Competitors |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/OpportunityCompetitor2/{OptyCompetitorId } |
OptyId OptyCompetitorId |
|
Opportunity > Opportunity Leads |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}}/child/OpportunityLead/{OptyLeadId } |
OptyId OptyLeadId |
|
Opportunity > Assessments |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/Assessments/{AssessmentId} |
OptyId AssessmentId |
|
Opportunity > Assessments > Assessment Answer Groups |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId} |
OptyId AssessmentId AssessAnswerGroupId |
|
Opportunity > Assessments > Assessment Answer Groups > Assessment Answers |
/crmRestApi/resources/11.13.18.10/opportunities/{OptyId}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId} |
OptyId AssessmentId AssessAnswerGroupId AnswerId |