Create an opportunity revenue partner
post
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary
Request
Path Parameters
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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. -
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. -
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. -
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root 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 : 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.
Links
- DealTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_DEAL_TYPE%2CBindLookupCode%3D{DealType}
The lookups resource is used to view standard lookup codes. - finder:
- PartnerDimensionMemberVA
-
Parameters:
- finder:
PartnerTypesFinder%3BOwnerId%3D{PartOrgPartyId}
A list of business relationships shared with a partner. - finder:
- PartnerEnrolledProgramsVA
-
Parameters:
- finder:
PartnerEnrolledProgramsFinderByPartner%3BPartnerPartyId%3D{PartOrgPartyId}
The partner enrolled programs list of values resource is used to view a list of the partner programs a partner is enrolled in. - finder:
- PartnerPickerVA
-
Parameters:
- finder:
ActivePartnersFinder%3BBindDefaultStatus%3DACTIVE%2CBindExtraStatus%3DACTIVE
The partner list of values resource is used to view a list of partners. - finder:
- PartnerRegistrationStatusLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DPARTNER_REGISTRATION_TYPE%2CBindLookupCode%3D{RegistrationStatus}
The lookups resource is used to view standard lookup codes. - finder:
Examples
The following example shows how to create an opportunity partner by submitting a post request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_341580/child/RevenuePartnerPrimary
Example of Request Body
The following shows an example of the request body in JSON format.
{ "PartOrgPartyId" : 300100031667673 }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "OptyId": 300100092516122, "PartOrgPartyId": 300100031667673, "PartProgramId": null, "PartTypeCd": null, "RevnId": 300100092516123, "RevnPartOrgPartyId": 300100092629926, "DealEstCloseDate": null, "DealExpirationDate": null, "DealType": null, "PrPartResourcePartyId": null, "RegistrationNumber": null, "PartyId": 300100031667673, "PartyName": "Weltech Corp", "PartyName1": null, "RevnPartnerNumber": "CDRM_81099", "LastUpdateDate": "2016-11-17T07:34:21-08:00", "LastUpdateLogin": "415C6A46FCB04D77E05354C0F20A8390", "LastUpdatedBy": "MHoope", "CreationDate": "2016-11-17T07:34:21-08:00", "CreatedBy": "MHoope", "PartOrgEmailAddress": "Weltech@oracle.com", "PartOrgFormattedPhoneNumber": "+91 (978)978", "RegistrationStatus": null, "PreferredContactName": "Weltech Corp", "PreferredContactEmail": "weltech@oracle.com", "PreferredContactPhone": "+91 (978)978 x978", "PartnerPartyNumber": "CDRM_70933" }