Get an opportunity team (Not Supported)

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityTeam/{OpportunityTeamUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- OptyId, ResourceId and TerritoryVersionId ---for the Opportunity Teams resource and used to uniquely identify an instance of Opportunity Teams. The client should not generate the hash key value. Instead, the client should query on the Opportunity Teams collection resource with a filter on the primary key values in order to navigate to a specific instance of Opportunity Teams.

    For example: OpportunityTeam?q=OptyId=<value1>;ResourceId=<value2>;TerritoryVersionId=<value3>
  • The unique alternate identifier for the opportunity.
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 : opportunities-OpportunityTeam-item-response
Type: object
Show Source
  • Title: Access
    Read Only: true
    Maximum Length: 30
    The access level granted to the opportunity team member, manager, and administrator of the organizations in the resource hierarchy.
  • Read Only: true
    Maximum Length: 1
    Indicates the territory is assigned using automatic territory-based assignment.
  • Title: Territory
    Read Only: true
    Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
  • Title: Assignment Type
    Read Only: true
    Indicates how the resource is added to the opportunity team, for example Ad-Hoc means resource is added manually or through rule-based assignment. Territory means resource is added through territory-based assignment.
  • Title: City
    Read Only: true
    Maximum Length: 60
    The city of the resource.
  • Read Only: true
    Default Value: 0
    This value is used to guarantee the uniqueness of the row when duplicates are created in different databases, such as mobile databases or the server.
  • Title: Country
    Read Only: true
    Maximum Length: 2
    The country code of the resource.
  • Read Only: true
    Maximum Length: 64
    The user who created the opportunity resource record.
  • Read Only: true
    The date and time of the creation of the opportunity resource record.
  • Title: Deal Protected to Date
    Read Only: true
    The end date of the deal protection period of an opportunity team member. This date is set for members of territories that are removed from the opportunity because of territory realignment.
  • Title: Deal Protected from Date
    Read Only: true
    The start date of the deal protection period of an opportunity team member. This date is set for the members of territories that are removed from opportunity because of territory realignment.
  • Read Only: true
    Maximum Length: 320
    The e-mail address of the resource.
  • Title: Enable Forecasting
    Read Only: true
    Maximum Length: 30
    Default Value: REVENUE
    The forecast participation type of the territory.
  • Title: Primary Phone
    Read Only: true
    The formatted phone number for the opportunity team member.
  • Title: Function
    Read Only: true
    Maximum Length: 30
    The code of the function or role of the territory team member.
  • Read Only: true
    The date and time of the last update of the opportunity resource record.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the opportunity resource record.
  • Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the opportunity resource record.
  • Links
  • Title: Lock Assignment
    Read Only: true
    Maximum Length: 1
    Default Value: true
    Indicates whether an opportunity team member can be removed from the team by automatic assignment.
  • Title: Function
    Read Only: true
    Maximum Length: 30
    The role of the team member on the opportunity, such as Integrator, Executive Sponsor, Technical Account Manager.
  • The unique identifier of the opportunity.
  • Title: Opportunity Number
    Read Only: true
    Maximum Length: 30
    The alternate unique identifier of the opportunity associated with the opportunity team.
  • Title: Opportunity Resource ID
    Read Only: true
    The unique identifier of the opportunity resource.
  • Title: Opportunity Resource Number
    Read Only: true
    Maximum Length: 30
    The label displaying the association between an opportunity and a resource (typically an opportunity sales team member).
  • Read Only: true
    Maximum Length: 255
    The unique key to identify the opportunity team member.
  • Title: Primary
    Read Only: true
    Indicates whether the opportunity team member is the owner of the opportunity.
  • Read Only: true
    The unique party identifier of the partner organization that the partner resource belongs to.
  • Read Only: true
    Maximum Length: 360
    The name of the partner organization that the partner resource belongs to.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The full 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.
  • Read Only: true
    Maximum Length: 40
    The primary formatted phone number for the resource.
  • The unique identifier of the resource.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The resource party number of the opportunity team member.
  • Read Only: true
    Maximum Length: 255
    The role of the resource.
  • Title: State
    Read Only: true
    Maximum Length: 60
    The state of the resource.
  • Title: Territory Function
    Read Only: true
    Maximum Length: 30
    The code of the business function of the territory.
  • Title: Territory Name
    Read Only: true
    Maximum Length: 60
    The name of the territory.
  • Read Only: true
    Indicates whether the opportunity team member is the territory owner.
  • The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Default Value: PRIME
    The code of the type of the territory.
Back to Top