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

Get a sales lead contact

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}

Request

Path Parameters
  • The unique identifier for the sales lead contact.
  • This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.
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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : leads-MklLeadTcMembers1-item-response
Type: object
Show Source
  • Title: Existing Account
    Read Only: true
    Maximum Length: 900
    The account name associated with lead contacts.
  • Title: City
    Read Only: true
    Maximum Length: 60
    City associated with the identifying address associated with this lead contact.
  • Title: Conflict Identifier
    Default Value: 0
    The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
  • Title: Do Not Call
    Read Only: true
    Maximum Length: 1
    Indicates if the user can call the person. If the value is True, then the user can not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
  • Title: Do Not Contact
    Read Only: true
    Maximum Length: 1
    Indicates if the user can contact the person by phone, e-mail, or mail. If the value is True, then the user can not contact the person. The default value is False.
  • Title: Do Not Mail
    Read Only: true
    Maximum Length: 1
    Indicates whether the sales lead person can be contacted.
  • Title: Job Title
    The label displaying the job title of a contact in his company.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created this sales lead contact.
  • Title: Creation Date
    Read Only: true
    The date and time when this sales lead contact is created.
  • Title: Email
    The e-mail address associated with the sales lead contact.
  • Title: Email Preference
    Read Only: true
    Maximum Length: 255
    Indicates if the lead contact has an email preference of do not email, ok to email, or no value.
  • Title: Phone
    The formatted phone number of the lead contact.
  • Title: Title
    Read Only: true
    Maximum Length: 100
    The job title of the sales lead contact.
  • Title: Last Updated Date
    Read Only: true
    The date and time of the last update of the sales lead contact.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the sales lead contact.
  • Title: Last Updated Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the sales lead record.
  • Title: Lead ID
    The unique identifier of the sales lead for this sales lead contact.
  • Title: Lead Contact ID
    The unique identifier for the sales lead contact.
  • Title: Lead Number
    Maximum Length: 30
    The alternate unique identifier of the lead.
  • Links
  • Title: Organization Contact ID
    Read Only: true
    The unique identifier of the Organization for this sales lead contact.
  • Title: Contact Party ID
    The unique identifier of the lead to which the contact is associated.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the party associated with the lead contact.
  • Title: Contact Party Number
    Read Only: true
    Maximum Length: 30
    The party number of the sales lead contact.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    The type of the party recorded as lead contact. Possible values are person, organization or group.
  • Title: Party Usage Code
    Maximum Length: 30
    The party usage recorded for this lead contact in the customer master.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The first name of the lead contact.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The last name or surname of a lead contact.
  • Title: Title
    Read Only: true
    Maximum Length: 60
    The title associated with the lead contact. This is not the same as the job title.
  • Title: Phone Preference
    Read Only: true
    Maximum Length: 255
    Indicates whether the lead contact has a phone preference of do not call, ok to call, or no value.
  • Title: Postal Code
    Read Only: true
    Maximum Length: 60
    Postal code part of the identifying address associated with this lead contact.
  • Read Only: true
    The account party identifier of the account associated to the lead contact.
  • Title: Primary
    Maximum Length: 1
    Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.
  • Title: Relationship ID
    The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.
  • Title: Function
    Maximum Length: 30
    The role of lead contact in the context of this lead.
  • 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.
  • Title: State
    Read Only: true
    Maximum Length: 60
    State part of the identifying address associated with this lead contact.
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 : leads-MklLeadTcMembers1-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • 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.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates whether the action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function associated with the smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • 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 the applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • 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.
  • 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 : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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 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 : leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • 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.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • 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
  • 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.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • 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.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • 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 : leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • 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
  • 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.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Links
HzLookupPVO1
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.
smartActions
Parameters:
  • LeadMemberId: $request.path.LeadMemberId
  • leadsUniqID: $request.path.leadsUniqID
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.
Back to Top

Examples

cURL Command

The following example shows how to get a contact by submitting a GET request on the REST resource using cURL. 

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582195

Example of Response Body

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

{
  "LeadMemberId" : 300100092582195,
  "RelationshipId" : null,
  "PartyUsageCode" : null,
  "PartyId" : 300100091395685,
  "Role" : null,
  "CreatedBy" : "MHoope",
  "CreationDate" : "2016-11-07T03:24:53-08:00",
  "LastUpdatedBy" : "MHoope",
  "LastUpdateDate" : "2016-11-07T03:25:05-08:00",
  "LeadId" : 300100092582093,
  "PartyName" : "Auto04c78940149Rel2 Last",
  "PrimaryFlag" : true,
  "PersonLastName" : "Last",
  "PersonFirstName" : "Auto04c78940149Rel2",
  "PartyType" : "PERSON",
  "PersonTitle" : null,
  "FormattedPhoneNumber" : null,
  "PartyNumber" : "CDRM_631453",
  "EmailAddress" : null,
  "OrgContactId" : null,
  "JobTitle" : null,
  "ContactDoNotCallFlag" : false,
  "ContactDoNotContactFlag" : false,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582195",
    "name" : "MklLeadTcMembers1",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000005737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582195",
    "name" : "MklLeadTcMembers1",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100092582093",
    "name" : "leads",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582195/lov/HzLookupPVO1",
    "name" : "HzLookupPVO1",
    "kind" : "Collection"
  } ]
}
Back to Top