1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Competitors Accounts

Get a competitor account

get

/crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : competitorAccounts-item-response
Type: object
Show Source
  • Title: Annual Revenue Amount
    Indicates the competitor company's annual revenue.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Chief Executive Name
    Maximum Length: 240
    The name of the organization's chief executive officer.
  • Title: Country
    Maximum Length: 2
    The home country of the competitor.
  • Read Only: true
    Maximum Length: 64
    The user who created the competitor record.
  • Maximum Length: 30
    Default Value: SALES
    The module that created the competitor record.
  • Read Only: true
    The date when the record was created.
  • Title: Currency
    Maximum Length: 15
    The currency code for annual revenue amount.
  • Title: D&B Credit Rating
    Maximum Length: 5
    The Dun & Bradstreet credit rating.
  • Read Only: true
    Indicates whether the competitor can be deleted.
  • Title: D-U-N-S Number
    Maximum Length: 30
    The DUNS Number in free form text format. The value is not restricted to nine digit number.
  • Title: Fiscal Year End Month
    Maximum Length: 30
    The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.
  • Title: Year Incorporated
    The year that the organization started business operations.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the competitor record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Title: Line of Business
    Maximum Length: 240
    The type of business activities performed at this site.
  • Links
  • Title: Minority-Owned Indicator
    Maximum Length: 30
    Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. The company is primarily owned by ethnic or racial minorities. The default value is N.
  • Title: Organization Name
    Maximum Length: 360
    The name of the competitor organization.
  • Title: Organization Size
    Maximum Length: 30
    The size of the competitor organization based on criteria such as revenue or number of employees.
  • The primary key for a competitor record.
  • Title: Name
    Maximum Length: 360
    The name of the competitor organization.
  • Title: Registry ID
    Maximum Length: 30
    The unique public identifier for a competitor.
  • Title: Party Type
    Maximum Length: 30
    Default Value: ORGANIZATION
    The type of the party record.
  • Title: Private Ownership
    Maximum Length: 1
    Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N.
  • Title: SIC Code
    Maximum Length: 30
    The Standard Industry Classification (SIC) code of the competitor.
  • Title: Small Business Indicator
    Maximum Length: 30
    Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.
  • Title: Status
    Maximum Length: 10
    Default Value: ACTIVE
    The competitor status - ACTIVE OR INACTIVE.
  • Title: Stock Symbol
    Maximum Length: 20
    The corporate stock symbol of the organization as listed in stock exchanges.
  • Title: Threat Level
    Maximum Length: 30
    The level of threat the competitor presents when competing against the deploying organization for a deal.
  • Maximum Length: 30
    The FSIO related trading partner codes.
  • Title: Name Suffix
    Maximum Length: 540
    The suffix used to generate the attribute PartyUniqueName. The suffix is linked to the OrganizationName attribute to generate the PartyUniqueName.
  • Read Only: true
    Indicates whether the record can be updated.
  • Title: Primary URL
    Maximum Length: 2000
    The uniform resource locator or a website containing information about the competitor.
  • Title: Year Established
    The year that the organization started it business operations.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : competitorAccounts-Attachment-item-response
Type: object
Show Source
Links
Attachment
Parameters:
  • PartyId: $request.path.PartyId
The attachments resource is used to view, create, and update attachments.
CompttrStatusLookupForSearch
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_STATUS
The following properties are defined on the LOV link relation:
  • Source Attribute: StatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
CompttrThrtLvlLookupLOV
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL
The following properties are defined on the LOV link relation:
  • Source Attribute: ThreatLevelCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
Back to Top

Examples

The following example shows how to get a competitor account by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}

Example of Response Body

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

{
    "PartyId": 300100070066841,
    "PartyNumber": "CDRM_153769",
    "PartyName": "ACmpttr0b759025130",
    "PartyType": "ORGANIZATION",
    "OrganizationName": "ACmpttr0b759025130",
    "UniqueNameSuffix": null,
    "OrganizationSize": null,
    "SICCode": null,
    "TradingPartnerIdentifier": null,
    "CeoName": null,
    "DbRating": null,
    "DUNSNumber": null,
    "FiscalYearendMonth": null,
    "IncorpYear": null,
    "LineOfBusiness": null,
    "MinorityOwnedInd": null,
    "SmallBusInd": null,
    "StockSymbol": null,
    "YearEstablished": null,
    "PublicPrivateOwnershipFlag": null,
    "AnnualRevenueAmount": null,
    "CurrencyCode": null,
    "StatusCode": "ACTIVE",
    "ThreatLevelCode": "HIGH",
    "URL": null,
    "Country": null,
    "CreatedByModule": "SALES",
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2015-03-28T09:10:35+00:00",
    "UpdateFlag": "false",
    "DeletetFlag": "false",
    "LastUpdateDate": "2015-03-28T09:10:45.577+00:00",
    "LastUpdateLogin": "125B23B85F187B53E0531833F40A8516",
    "LastUpdatedBy": "SALES_ADMIN",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100070066841",
            "name": "competitorAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E0002000000017371007E00020000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100070066841",
            "name": "competitorAccounts",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100070066841/child/Attachment",
            "name": "Attachment",
            "kind": "collection"
        }
    ]
}
Back to Top