Get an opportunity competitor
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2/{OptyCompetitorId}
Request
Path Parameters
-
OptyCompetitorId(required): integer(int64)
The unique identifier for the competitor of the opportunity.
-
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 TopResponse
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.
Root Schema : opportunities-OpportunityCompetitor2-item-response
Type:
Show Source
object
-
CmptPartyId: integer
(int64)
Title:
Party ID
The unique identifier for the competitor party. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments about the opportunity's competitor. -
CompetitorPartyNumber: string
Title:
Competitor Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the competitor party. -
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
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the contact record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
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. -
Name: string
Title:
Opportunity Name
Read Only:true
Maximum Length:275
The name of the opportunity. -
OptyCompetitorId: integer
(int64)
Title:
Opportunity Competitor ID
The unique identifier for the competitor of the opportunity. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier for the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The number of the opportunity which is the unique public identifier of the opportunity. -
PartyName: string
Title:
Competitor
Maximum Length:360
The name of the party. -
PrimaryFlg: string
Title:
Primary
Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False. -
ThreatLevelCode: string
Title:
Threat Level
Maximum Length:30
The code indicating the level of threat or risk from the competitor. The list of valid values are Low, Medium, and High. A list of accepted values is defined in the lookup Competitor Threat Level. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CompetitorVO1
-
Parameters:
- finder:
ActiveCompetitorsFinder
A competitor is an organization that competes with the deploying organization in sales situations. This object stores additional competitor attributes such as SWOT, products sold by competitors and their mappings to the deploying organization's products, details of win/loss reasons, and associations to competitive literature. - finder:
- CompttrThrtLvlLookup
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL%2CBindLookupCode%3D{ThreatLevelCode}
The lookups resource is used to view standard lookup codes. - finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DYES_NO
The lookups resource is used to view standard lookup codes. - finder:
Examples
The following example shows how to get an opportunity competitor 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/OpportunityCompetitor2/300100092629553
Example of Response Body
The following shows an example of the response body in JSON format.
{ "PartyName" : "Aberdeen LLC", "CreatedBy": "MHoope", "CreationDate": "2016-11-16T05:02:42-08:00", "LastUpdateDate": "2016-11-16T05:03:04-08:00", "LastUpdateLogin": "415B9500195B1E30E05354C0F20ADDA7", "OptyId" : 300100092516122, "LastUpdatedBy": "MHoope", "ThreatLevelCode": "MEDIUM", "OptyCompetitorId": 300100092629553, "CmptPartyId": 100000012057022, "Comments": null, "PrimaryFlg": "N", "Name": "Pinnacle Green Server Opportunity" }