Jump to

• Request
• Response
• Examples

Get an opportunity team member

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource/{OpportunityResourceUniqID}

Request

Path Parameters

• OpportunityResourceUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Opportunity Team Members resource and used to uniquely identify an instance of Opportunity Team Members. The client should not generate the hash key value. Instead, the client should query on the Opportunity Team Members collection resource in order to navigate to a specific instance of Opportunity Team Members to get the hash key.
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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-OpportunityResource-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• AsgnTerritoryVersionId: integer (int64)
  Title: Territory

  The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.
• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  The code indicating how the resource is assigned to the sales account team. A list of accepted values are defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• 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 when the resource record was created.
• DealExpirationDate: string (date)
  Title: Deal Protected to Date

  The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
• DealProtected: string
  Title: Deal Protected

  Read Only: true

  Indicates if the resource is under deal protection. If the value is True, then the resource is under deal protection. The default value is False.
• DealProtectedDate: string (date)
  Title: Deal Protected from Date

  The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the opportunity team member.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the opportunity team member.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• LockAssignmentFlag: boolean
  Title: Lock Assignment

  Maximum Length: 1

  Default Value: true

  Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• MgrResourceId: integer
  Read Only: true

  The unique identifier of the resource team member's manager.
• OptyId: integer (int64)
  The unique Identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OptyResourceId: integer (int64)
  Title: Opportunity Resource ID

  The unique party identifier for the existing opportunity resource.
• OptyResourceNumber: string
  Title: Opportunity Resource Number

  Maximum Length: 30

  The alternate key identifier of the opportunity resource.
• OwnerFlag: boolean
  Title: Primary

  Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.
• PartnerOrgId: integer (int64)
  Title: Name

  The unique identifier of the partner organization.
• PartnerPartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the partner associated with the partner resource.
• PartyName: string
  Title: Team Member

  Read Only: true

  Maximum Length: 360

  The 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.
• ResourceId: integer (int64)
  Title: Team Member

  The unique party identifier for the existing resource.
• ResourcePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the opportunity resource party.
• RoleName: string
  Title: Role

  Read Only: true

  Maximum Length: 60

  The role of the opportunity team member in the resource organization.
• TerritoryName: string
  Title: Territory

  Read Only: true

  Maximum Length: 60

  The name of the opportunity team member's territory.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the resource record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryName":{
            "title":"Territory",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the opportunity team member's territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyName":{
            "title":"Team Member",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the opportunity team member.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealProtectedDate":{
            "title":"Deal Protected from Date",
            "type":"string",
            "description":"The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerPartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner associated with the partner resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyResourceNumber":{
            "title":"Opportunity Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OptyResourceId":{
            "title":"Opportunity Resource ID",
            "type":"integer",
            "description":"The unique party identifier for the existing opportunity resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity resource party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerOrgId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity resource record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "OwnerFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "DealExpirationDate":{
            "title":"Deal Protected to Date",
            "type":"string",
            "description":"The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique Identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealProtected":{
            "title":"Deal Protected",
            "type":"string",
            "description":"Indicates if the resource is under deal protection. If the value is True, then the resource is under deal protection. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RoleName":{
            "title":"Role",
            "maxLength":"60",
            "type":"string",
            "description":"The role of the opportunity team member in the resource organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ResourceId":{
            "title":"Team Member",
            "type":"integer",
            "description":"The unique party identifier for the existing resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"The code indicating how the resource is assigned to the sales account team. A list of accepted values are defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MgrResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource team member's manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockAssignmentFlag":{
            "title":"Lock Assignment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "AsgnTerritoryVersionId":{
            "title":"Territory",
            "type":"integer",
            "description":"The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Links

AccessLevelLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_ACCESS_LEVEL

The lookups resource is used to view standard lookup codes.

MemberFunctionLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_RESOURCE_FUNCTION%2CBindLookupCode%3D{MemberFunctionCode}

The lookups resource is used to view standard lookup codes.

YesNoLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DYES_NO

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

The following example shows how to get an opportunity team member by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_341580/child/OpportunityResource/300100092629556

Example of Response Body

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

{
"AccessLevelCode": "200",
"PartyName": "Matt Brown",
"ResourceId": 73620,
"OptyResourceId": 300100092629556,
"OptyId": 300100092516122,
"DealExpirationDate": null,
"CreationDate": "2016-11-16T05:02:42-08:00",
"LastUpdateDate": "2016-11-16T05:03:04-08:00",
"DealProtected": "N",
"MemberFunctionCode": "INTEGRATOR",
"OwnerFlag": false,
"LockAssignmentFlag": true,
"AssignmentType": "Ad hoc assignment",
"CreatedBy": "MHoope",
"LastUpdatedBy": "MHoope",
"LastUpdateLogin": "415B9500195B1E30E05354C0F20ADDA7",
"PersonFirstName": "Matt",
"PersonLastName": "Brown",
"AsgnTerritoryVersionId": null,
"TerritoryName": null.
"EmailAddress": "[e-mail]",
"FormattedPhoneNumber": "+1",
"PartnerOrgId": null,
"PartnerPartyName": null,
"RoleName": null,
"MgrResourceId": null,
"OptyResourceNumber": "CDRM_366561",
"ResourcePartyNumber": "34724",
"DealProtectedDate": null
}

Back to Top