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

Get all account team members

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountTeam

Request

Path Parameters
  • The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
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 the account team with the specified primary key.
      Finder Variables:
      • AccountTeamId; integer; The unique identifier of the account team used to get the account 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 account team member, manager, and administrator of the organizations in the resource hierarchy.
    • AccountTeamId; integer; The unique key to identify the account team member.
    • AddedOnDateTime; string; The date when the account team member was created based on either the date the resource was added to the account resource or the date the territory was added to account territory.
    • AssignmentTypeCode; string; Indicates how the resource is added to the account team. For example, Ad-Hoc indicates that the resource is added manually or through rule-based assignment and Territory indicates that the resource is added through territory-based assignment.
    • City; string; The city of the resource.
    • CorpCurrencyCode; string; The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
    • Country; string; The country code of the resource.
    • CreatedBy; string; The user who created the account team member.
    • CreationDate; string; The date when the record was created.
    • CurcyConvRateType; string; The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
    • CurrencyCode; string; The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
    • EndDateActive; string; The end date the account team member is active.
    • ForecastParticipationCode; string; The forecast participation type of the territory.
    • FunctionCode; string; The code of the function or role of the territory team member.
    • LastUpdateDate; string; The date when the account team was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the account team record.
    • LockAssignmentFlag; boolean; Indicates that the account team member cannot be removed from the team by automatic assignment.
    • MemberFunctionCode; string; The code of the account team member function.
    • ObjectVersionNumber; integer; The object version number.
    • PartyId; integer; The unique identifier of the account.
    • ResourceEmailAddress; string; The e-mail address of the resource.
    • ResourceId; integer; The unique identifier of the resource party associated with the account team.
    • ResourceName; string; The full name of the account team member.
    • ResourcePartyNumber; string; The party number of the resource.
    • SalesProfileId; integer; The unique identifier of the sales account.
    • StartDateActive; string; The start date the account team member is active.
    • State; string; The state of the resource.
    • TeamMemberId; integer; The unique identifier of the account resource.
    • TerritoryFunctionCode; string; The code of the business function of the territory.
    • TerritoryName; string; The name of the territory associated with the account team..
    • TerritoryNumber; string; The number of the territory.
    • TerritoryVersionId; integer; The unique identifier of the territory version for the resource that got assigned to the account through territory-based assignment.
    • TypeCode; string; The code of the type of the territory associated with the account team.
    • UserLastUpdateDate; string; The date and time the account team member was last updated.
  • 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 : accounts-AccountTeam
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : accounts-AccountTeam-item-response
Type: object
Show Source
Back to Top