Jump to

• Request
• Response
• Examples

Create an opportunity competitor

post

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

Request

Path Parameters

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments about the opportunity's competitor.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyCompetitorId":{
            "title":"Opportunity Competitor ID",
            "type":"integer",
            "description":"The unique identifier for the competitor of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyName":{
            "title":"Competitor",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false,
            "x-queryable":false
        },
        "CmptPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the competitor party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            }
        },
        "ThreatLevelCode":{
            "title":"Threat Level",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        }
    }
}

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

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments about the opportunity's competitor.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Competitor",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "Name":{
            "title":"Opportunity Name",
            "maxLength":"275",
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompetitorPartyNumber":{
            "title":"Competitor Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the competitor party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyCompetitorId":{
            "title":"Opportunity Competitor ID",
            "type":"integer",
            "description":"The unique identifier for the competitor of the opportunity.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false,
            "x-queryable":false
        },
        "CmptPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the competitor party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            },
            "x-queryable":true
        },
        "ThreatLevelCode":{
            "title":"Threat Level",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "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

CompetitorVO1

Operation: /crmRestApi/resources/11.13.18.05/competitors

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.

CompttrThrtLvlLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL%2CBindLookupCode%3D{ThreatLevelCode}

The lookups resource is used to view standard lookup codes.

YesNoLookup

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 create an opportunity competitor by submitting a post request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
"CmptPartyId" : 300100092002566
}

Example of Response Body

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

{
PartyName: "AutoCustomer07c32793225",
ThreatLevelCode: "LOW"
Comments: null,
OptyCompetitorId: 300100092629898,
CmptPartyId: 300100092002566,
PrimaryFlg: "N",
Name: "Pinnacle Green Server Opportunity",
CreatedBy: "MHoope",
OptyId: 300100092516122,
CreationDate: "2016-11-17T05:36:07-08:00",
LastUpdateDate: "2016-11-17T05:36:08-08:00",
LastUpdateLogin": "415C6A46FCB04D77E05354C0F20A8390",
LastUpdatedBy": "MHoope",
...
}

Back to Top