Create an opportunity team member

post

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource

Request

Path Parameters
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Access
    Maximum Length: 30
    The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Territory
    The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.
  • Title: Conflict ID
    Default Value: 0
    The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
  • Title: Deal Protected to Date
    The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
  • Title: Deal Protected from Date
    The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
  • Title: Lock Assignment
    Maximum Length: 1
    Default Value: true
    Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
  • Title: Function
    Maximum Length: 30
    The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • The unique Identifier of the opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity.
  • Title: Opportunity Resource ID
    The unique party identifier for the existing opportunity resource.
  • Title: Opportunity Resource Number
    Maximum Length: 30
    The alternate key identifier of the opportunity resource.
  • Title: Primary
    Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.
  • Title: Name
    The unique identifier of the partner organization.
  • Title: Team Member
    The unique party identifier for the existing resource.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : opportunities-OpportunityResource-item-response
Type: object
Show Source
  • Title: Access
    Maximum Length: 30
    The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Territory
    The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.
  • Title: Assignment Type
    Read Only: true
    The code indicating how the resource is assigned to the sales account team. A list of accepted values are defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Conflict ID
    Default Value: 0
    The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
  • Read Only: true
    Maximum Length: 64
    The user who created the opportunity resource record.
  • Read Only: true
    The date and time when the resource record was created.
  • Title: Deal Protected to Date
    The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
  • Title: Deal Protected
    Read Only: true
    Indicates if the resource is under deal protection. If the value is True, then the resource is under deal protection. The default value is False.
  • Title: Deal Protected from Date
    The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The e-mail address of the opportunity team member.
  • Title: Phone
    Read Only: true
    The formatted phone number of the opportunity team member.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Links
  • Title: Lock Assignment
    Maximum Length: 1
    Default Value: true
    Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
  • Title: Function
    Maximum Length: 30
    The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Read Only: true
    The unique identifier of the resource team member's manager.
  • The unique Identifier of the opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity.
  • Title: Opportunity Resource ID
    The unique party identifier for the existing opportunity resource.
  • Title: Opportunity Resource Number
    Maximum Length: 30
    The alternate key identifier of the opportunity resource.
  • Title: Primary
    Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.
  • Title: Name
    The unique identifier of the partner organization.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the partner associated with the partner resource.
  • Title: Team Member
    Read Only: true
    Maximum Length: 360
    The name of the opportunity team member.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The first name of the opportunity team member.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The last name of the opportunity team member.
  • Title: Team Member
    The unique party identifier for the existing resource.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the opportunity resource party.
  • Title: Role
    Read Only: true
    Maximum Length: 60
    The role of the opportunity team member in the resource organization.
  • Title: Territory
    Read Only: true
    Maximum Length: 60
    The name of the opportunity team member's territory.
Back to Top

Examples

The following example shows how to create an opportunity team member 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/OpportunityResource

Example of Request Body

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

{
"ResourceId": 65475
}

Example of Response Body

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

 {
OptyResourceId: 300100092629934,
CreatedBy: "MHoope",
ResourceId: 65475,
CreationDate: "2016-11-17T05:54:14-08:00",
OptyId: 300100092516122,
AccessLevelCode: 200,
DealProtectedDate: null,
PartyName: "Lisa Abner",
DealExpirationDate: null,
EmailAddress: "mbaird@oracle.com",
MemberFunctionCode: "INTEGRATOR",
FormattedPhoneNumber: "+1 (640) 345-3456 x6567",
OwnerFlag: false,
ContactPartyNumber: 100000016934213,
DealProtected: "N",
LockAssignmentFlag: true,
AssignmentType: "Ad hoc assignment",
LastUpdatedBy: "MHoope",
LastUpdateDate"": "2016-11-17T08:21:01-08:00",
LastUpdateLogin"": "415C6A46FCB04D77E05354C0F20A8390",
PersonFirstName: "Lisa",
PersonLastName: "Abner",
AsgnTerritoryVersionId: null,
TerritoryName: null,
EmailAddress: "sendmail-test-discard@oracle.com",
FormattedPhoneNumber: "+1 ",
PartnerOrgId: null,
PartnerPartyName: null,
RoleName: null,
MgrResourceId: null,
OptyResourceNumber: "CDRM_370563",
ResourcePartyNumber: "33880"
}
Back to Top