Jump to

• Request
• Response
• Examples

Get all opportunity teams

get

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

Request

Path Parameters

• OptyNumber(required): string
  The unique alternate identifier for the opportunity.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• finder: string
  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: The combined key to get one opportunity team member.
    Finder Variables:
    • OptyId; integer; The unique identifier of the opportunity associated with the opportunity team.
    • ResourceId; integer; The unique identifier of the resource with the opportunity team.
    • TerritoryVersionId; integer; The unique identifier of the territory version with the opportunity team.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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 opportunity team member, manager, and administrator of the organizations in the resource hierarchy.
  • AsgnTerrBasedInd; string; Indicates the territory is assigned using automatic territory-based assignment.
  • AsgnTerritoryVersionId; integer; Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
  • City; string; The city of the resource.
  • ConflictId; integer; 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.
  • Country; string; The country code of the resource.
  • CreatedBy; string; The user who created the opportunity resource record.
  • CreationDate; string; The date and time of the creation of the opportunity resource record.
  • DealExpirationDate; string; 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.
  • DealProtectedDate; string; 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.
  • EmailAddress; string; The e-mail address of the resource.
  • 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 and time of the last update of the opportunity resource record.
  • LastUpdateLogin; string; The session login associated to the user who last updated the opportunity resource record.
  • LastUpdatedBy; string; The user who last updated the opportunity resource record.
  • LockAssignmentFlag; boolean; Indicates whether an opportunity team member can be removed from the team by automatic assignment.
  • MemberFunctionCode; string; The role of the team member on the opportunity, such as Integrator, Executive Sponsor, Technical Account Manager.
  • OptyId; integer; The unique identifier of the opportunity.
  • OptyNumber; string; The alternate unique identifier of the opportunity associated with the opportunity team.
  • OptyResourceId; integer; The unique identifier of the opportunity resource.
  • OptyResourceNumber; string; The label displaying the association between an opportunity and a resource (typically an opportunity sales team member).
  • PartnerOrgId; integer; The unique party identifier of the partner organization that the partner resource belongs to.
  • PartnerPartyName; string; The name of the partner organization that the partner resource belongs to.
  • PartyName; string; The full name of the opportunity team member.
  • PersonFirstName; string; The first name of the opportunity team member.
  • PersonLastName; string; The last name of the opportunity team member.
  • PrimaryPhoneNumber; string; The primary formatted phone number for the resource.
  • ResourceId; integer; The unique identifier of the resource.
  • ResourcePartyNumber; string; The resource party number of the opportunity 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.
  • TerritoryVersionId; integer; The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
  • TypeCode; string; The code of the type of the territory.
• totalResults: boolean
  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

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityTeam-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object opportunities-OpportunityTeam-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityTeam-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : opportunities-OpportunityTeam-item-response

Type: object

Show Source

• AccessLevelCode: string
  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.
• AsgnTerrBasedInd: string
  Read Only: true

  Maximum Length: 1

  Indicates the territory is assigned using automatic territory-based assignment.
• AsgnTerritoryVersionId: integer (int64)
  Title: Territory

  Read Only: true

  Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
• AssignmentType: string
  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.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the resource.
• ConflictId: integer (int64)
  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.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The country code of the resource.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the opportunity resource record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time of the creation of the opportunity resource record.
• DealExpirationDate: string (date)
  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.
• DealProtectedDate: string (date)
  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.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The e-mail address of the resource.
• ForecastParticipationCode: string
  Title: Enable Forecasting

  Read Only: true

  Maximum Length: 30

  Default Value: REVENUE

  The forecast participation type of the territory.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The formatted phone number for the opportunity team member.
• FunctionCode: string
  Title: Function

  Read Only: true

  Maximum Length: 30

  The code of the function or role of the territory team member.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time of the last update of the opportunity resource record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the opportunity resource record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the opportunity resource record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockAssignmentFlag: boolean
  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.
• MemberFunctionCode: string
  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.
• OptyId: integer (int64)
  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Read Only: true

  Maximum Length: 30

  The alternate unique identifier of the opportunity associated with the opportunity team.
• OptyResourceId: integer (int64)
  Title: Opportunity Resource ID

  Read Only: true

  The unique identifier of the opportunity resource.
• OptyResourceNumber: string
  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).
• OptyTeamId: string
  Read Only: true

  Maximum Length: 255

  The unique key to identify the opportunity team member.
• OwnerFlag: boolean
  Title: Primary

  Read Only: true

  Indicates whether the opportunity team member is the owner of the opportunity.
• PartnerOrgId: integer (int64)
  Read Only: true

  The unique party identifier of the partner organization that the partner resource belongs to.
• PartnerPartyName: string
  Read Only: true

  Maximum Length: 360

  The name of the partner organization that the partner resource belongs to.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The full name of the opportunity team member.
• PersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the opportunity team member.
• PersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the opportunity team member.
• PrimaryPhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The primary formatted phone number for the resource.
• ResourceId: integer (int64)
  The unique identifier of the resource.
• ResourcePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The resource party number of the opportunity team member.
• RoleName: string
  Read Only: true

  Maximum Length: 255

  The role of the resource.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state of the resource.
• TerritoryFunctionCode: string
  Title: Territory Function

  Read Only: true

  Maximum Length: 30

  The code of the business function of the territory.
• TerritoryName: string
  Title: Territory Name

  Read Only: true

  Maximum Length: 60

  The name of the territory.
• TerritoryOwnerFlag: boolean
  Read Only: true

  Indicates whether the opportunity team member is the territory owner.
• TerritoryVersionId: integer (int64)
  The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
• TypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: PRIME

  The code of the type of the territory.

{
    "type":"object",
    "properties":{
        "TerritoryName":{
            "title":"Territory Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time of the creation of the opportunity resource record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The access level granted to the opportunity team member, manager, and administrator of the organizations in the resource hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The full name of the opportunity team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AsgnTerrBasedInd":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the territory is assigned using automatic territory-based assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealProtectedDate":{
            "title":"Deal Protected from Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerPartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner organization that the partner resource belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryOwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity team member is the territory owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyResourceNumber":{
            "title":"Opportunity Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The label displaying the association between an opportunity and a resource (typically an opportunity sales team member).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyResourceId":{
            "title":"Opportunity Resource ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerritoryFunctionCode":{
            "title":"Territory Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the business function of the territory.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique party identifier of the partner organization that the partner resource belongs to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The resource party number of the opportunity team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The formatted phone number for the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the opportunity associated with the opportunity team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity resource record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity resource record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the type of the territory.",
            "nullable":false,
            "readOnly":true,
            "default":"PRIME",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the opportunity team member is the owner of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the function or role of the territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "DealExpirationDate":{
            "title":"Deal Protected to Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ForecastParticipationCode":{
            "title":"Enable Forecasting",
            "maxLength":"30",
            "type":"string",
            "description":"The forecast participation type of the territory.",
            "nullable":true,
            "readOnly":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The role of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The primary formatted phone number for the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "OptyTeamId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique key to identify the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role of the team member on the opportunity, such as Integrator, Executive Sponsor, Technical Account Manager.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockAssignmentFlag":{
            "title":"Lock Assignment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an opportunity team member can be removed from the team by automatic assignment.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "AsgnTerritoryVersionId":{
            "title":"Territory",
            "type":"integer",
            "description":"Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time of the last update of the opportunity resource record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the opportunity resource record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to get all opportunity teams by submitting a GET request on the REST resource.

cURL Command

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Response Body

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

{
    "items": [
        {
            "OptyId": 300100564137678,
            "ResourceId": 100010025532672,
            "TerritoryVersionId": null,
            "PersonFirstName": "Gabrielle ",
            "PersonLastName": " Lee",
            "PrimaryPhoneNumber": "5066601",
            "EmailAddress": "[e-mail]",
            "TerritoryName": null,
            "TypeCode": null,
            "TerritoryOwnerFlag": "false",
            "FunctionCode": null,
            "TerritoryFunctionCode": null,
            "ForecastParticipationCode": null,
            "AccessLevelCode": "300",
            "OptyResourceId": 300100564137680,
            "AssignmentType": "Ad hoc assignment",
            "LockAssignmentFlag": true,
            "AsgnTerrBasedInd": null,
            "Country": "US",
            "State": "CA",
            "City": "Belmont",
            "RoleName": null,
            "OptyTeamId": "300100564137678_100010025532672__300100564137680",
            "DealProtectedDate": null,
            "DealExpirationDate": null,
            "MemberFunctionCode": "INTEGRATOR",
            "OwnerFlag": true,
            "ConflictId": 0,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-10-28T03:49:50.836+00:00",
            "LastUpdatedBy": "SALES_ADMIN",
            "LastUpdateDate": "2022-10-28T03:49:57.983+00:00",
            "LastUpdateLogin": "EB853827FF440A52E053773AF80A4A5C",
            "FormattedPhoneNumber": "[phone]",
            "PartnerOrgId": null,
            "OptyResourceNumber": "CDRM_138216",
            "ResourcePartyNumber": "100010025532672",
            "OptyNumber": "CDRM_152510",
            "PartnerPartyName": null,
            "AsgnTerritoryVersionId": null,
            "PartyName": "Gabrielle   Lee",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF",
                    "name": "OpportunityTeam",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF",
                    "name": "OpportunityTeam",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510",
                    "name": "opportunities",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/TerritoryFunctionLOVViewAccessor",
                    "name": "TerritoryFunctionLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/TeamMemberFunctionLOVViewAccessor",
                    "name": "TeamMemberFunctionLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/AccessLevelLOVViewAccessor",
                    "name": "AccessLevelLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/TerritoryTypeLOVViewAccessor",
                    "name": "TerritoryTypeLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/TerrFcastParticipationLOVViewAccessor",
                    "name": "TerrFcastParticipationLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/MemberFunctionCodeLOVViewAccessor",
                    "name": "MemberFunctionCodeLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/AssignmentTypeLOVViewAccessor",
                    "name": "AssignmentTypeLOVViewAccessor",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam",
            "name": "OpportunityTeam",
            "kind": "collection"
        }
    ]
}

Back to Top