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

Get all lead teams members

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTeam

Request

Path Parameters
  • 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
  • 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:

    • PrimaryKey: Finds a lead team with the specified primary key.
      Finder Variables:
      • LeadTeamId; integer; The unique identifier of the lead team.
  • 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:
    • AccessLevelCode; string; The access level granted to the lead team member, manager, and administrator of the organizations in the resource hierarchy.
    • AddedOnDateTime; string; The create date and time for the lead team member based either on the date the resource was added to the lead resource or the date the territory was added to lead territory.
    • City; string; The city of the resource.
    • ConflictId; integer; The conflict identifier.
    • Country; string; The country code of the resource.
    • CreatedBy; string; The user identifier of the user who created the lead team member.
    • CreationDate; string; The create date and time of the lead team member.
    • EmailAddress; string; The email address of the resource.
    • FunctionCode; string; The code of the function or role of the lead team member.
    • FunctionalRole; string; The code of the function or role of the lead team member.
    • LastUpdateDate; string; The date when the lead team was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the lead team.
    • LastUpdatedBy; string; The user who last updated the lead team.
    • LeadId; integer; The unique identifier of the lead.
    • LeadNumber; string; The alternate unique identifier of the lead.
    • LeadResourceId; integer; The unique identifier of the lead resource.
    • LeadTeamId; integer; The unique identifier of the lead team.
    • PartyId; integer; The unique identifier of the party.
    • PartyName; string; The name of the resource.
    • PartyNumber; string; The alternate identifier of the resource.
    • PrimaryFlag; boolean; Indicates whether the lead team member is the owner of the lead.
    • PrimaryPhoneNumber; string; Primary formatted phone number for the resource.
    • PrimaryPhonePurpose; string; Primary purpose of the phone for the resource.
    • ResourceId; integer; Resource party identifier of the lead team member.
    • State; string; The state of the resource.
    • TerritoryFunctionCode; string; The code of the business function of the territory.
    • TerritoryName; string; The name of the territory.
    • TerritoryNumber; string; The number of the territory.
    • TerritoryVersionId; number; Version identifier of the territory for the resource that got assigned to the lead through territory-based assignment.
    • TypeCode; string; The code of the type of the territory.
  • 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 : leads-MklLeadTeam
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : leads-MklLeadTeam-item-response
Type: object
Show Source
Back to Top