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

Get all opportunity contacts

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • OpportunityContactAltKeyFinder: Finds an opportunity contact based on contact or opportunity unique public identifier.
      Finder Variables:
      • ContactPartyNumber; string; The unique public identifier of a contact.
      • OptyNumber; string; The unique public identifier of an opportunity.
    • OptyContactUserKey: Finds the contacts details associated to an opportunity by the primary key of the Contact.
      Finder Variables:
      • OptyId; integer; The unique ID of the opportunity.
      • PERPartyId; integer; The party ID of the opportunity contact.
    • PrimaryKey: Finds the contacts details associated to an opportunity by the primary key OptyConId.
      Finder Variables:
      • OptyConId; integer; The unique identifier of the opportunity contact.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AffinityLvlCd; string; 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; The textual comments about the contact on the current opportunity.
    • ConflictId; integer; The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
    • ContactPartyNumber; string; The alternate key identifier of the opportunity contact party.
    • ContactedFlg; string; 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.
    • DoNotContactFlag; boolean; 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.
    • InfluenceLvlCd; string; 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; The free form text for job title of the opportunity contact.
    • OptyConId; integer; The unique identifier of the contact associated with the opportunity.
    • OptyId; integer; The unique identifier of the opportunity.
    • OptyNumber; string; The unique alternate identifier for the opportunity.
    • PERPartyId; integer; The party identifier of the opportunity contact.
    • PartyName; string; The name of the contact for the opportunity.
    • PersonCentricJobTitle; string; The job title of the contact person.
    • PreferredContactMethod; string; 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.
    • RoleCd; string; 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; 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; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : opportunities-OpportunityContact
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : opportunities-OpportunityContact-item-response
Type: object
Show Source
  • Title: Affinity Level
    Maximum Length: 30
    The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Comments
    Maximum Length: 255
    The textual comments about the contact on the current opportunity.
  • Title: Conflict ID
    Default Value: 0
    The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
  • Title: Contacted
    Maximum Length: 1
    Default Value: N
    Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the opportunity contact party.
  • The unique identifier of the contact point for an opportunity contact.
  • Read Only: true
    Maximum Length: 64
    The user who created the opportunity contact record.
  • Read Only: true
    The date and time when the contact record was created.
  • Title: Do Not Contact
    Read Only: true
    Maximum Length: 1
    Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False.
  • Title: Email
    Read Only: true
    The e-mail address of the contact.
  • Title: Email Preference
    Read Only: true
    Maximum Length: 255
    Indicates if the opportunity contact has an email preference of do not email, ok to email, or no value.
  • Title: Address
    Read Only: true
    Maximum Length: 255
    The formatted address of the contact.
  • Title: Phone
    Read Only: true
    The formatted phone number of the contact.
  • Title: Influence Level
    Maximum Length: 30
    The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Title
    Read Only: true
    Maximum Length: 100
    The free form text for job title of the opportunity contact.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Links
  • Title: Contact ID
    The unique identifier of the contact associated with the opportunity.
  • Title: Opportunity
    The unique identifier of the opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity.
  • Read Only: true
    The unique identifier of the contact's organization.
  • Title: Organization
    Read Only: true
    Maximum Length: 360
    The name of the contact's organization.
  • Read Only: true
    The unique identifier of the organization contact for the opportunity.
  • Title: Opportunity Contact Name
    Read Only: true
    Maximum Length: 360
    The name of the contact for the opportunity.
  • Title: Related Account
    Read Only: true
    Maximum Length: 900
    The unique contact name displayed on party related screens. The default value for Contacts is the concatenation of attributes ContactName and UniqueNameSuffix. The default value for Organizations is the concatenation of the unique name alias and UniqueNameSuffix.
  • Title: Opportunity Contact
    The party identifier of the opportunity contact.
  • Title: Job Title
    Read Only: true
    Maximum Length: 100
    The job title of the contact person.
  • Title: Phone Preference
    Read Only: true
    Maximum Length: 255
    Indicates if the opportunity contact has a phone preference of do not call, ok to call, or no value.
  • Title: Preferred Contact Method
    Read Only: true
    Maximum Length: 30
    The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
  • Title: Primary
    Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.
  • Title: Relationship Code
    Read Only: true
    Maximum Length: 30
    The code indicating whether it's a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.
  • The identifier of the relationship for the opportunity contact.
  • Title: Function
    Maximum Length: 30
    The code identifying the roles played by a contact in the opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Affinity
    Read Only: true
    Maximum Length: 30
    The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Buying Role
    Read Only: true
    Maximum Length: 30
    The code identifying the roles played by a contact in the buying process. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Title: Influence Level
    Read Only: true
    Maximum Length: 30
    The code indicating the influence the opportunity contact has on the buying process of the current opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
Back to Top

Examples

The following example shows how to get all opportunity contacts by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_341580//child/OpportunityContact

Example of Response Body

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

{
   "items" : [2]
0:{
    "AffinityLvlCd" : null,
    "ContactedFlg" : "N",
    "CreatedBy" : "MHoope",
    "CreationDate" : "2016-11-16T05:15:38-08:00",
    "Comments" : null,
    "InfluenceLvlCd" : null,
    "LastUpdateDate" : "2016-11-16T05:15:43-08:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateLogin" : null,
    "OptyConId" : 300100092629555,
    "PERPartyId" : 100000018544431,
    "OptyId" : 300100092516122,
    "RelationshipId" : null,
    "RoleCd" : null,
    "PrimaryFlg" : "N",
    "RelationshipCode" : null,
    "PartyName" : "Juan BELL",
    "EmailAddress" : "sendmail-test-discard@oracle.com",
    "ContactPointId" : 100000018544441,
    "FormattedAddress" : "1625 19th Ave,SEATTLE, WA 98122",
    "FormattedPhoneNumber" : 2065584951,
    "DoNotContactFlag" : false,
    "ContactPartyNumber": 100000018544430,
   		...
}
 -1:{
...
}
 ...
}
Back to Top