Get a competitor
get
/crmRestApi/resources/11.13.18.05/competitors/{PartyId}
Request
Path Parameters
-
PartyId(required): integer(int64)
The unique identifier of the competitor.
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 : competitors-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the competitor record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the logged in user has access to delete the Competitor. The value will be false as Competitors cannot be deleted. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time 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 login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the competitor. -
PartyName: string
Title:
Competitor Name
Read Only:true
Maximum Length:360
The name of the competitor. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The alternate identifier of the party. -
PartyUniqueName: string
Title:
Name
Read Only:true
Maximum Length:900
The unique account name. For an Organization, the value is a concatenation of unique_name_alias and suffix. For a Person, the value is a concatenation of person_name and suffix. -
StatusCode: string
Title:
Status
Maximum Length:10
Default Value:ACTIVE
The code indicating the competitor's status. The accepted values are ACTIVE and INACTIVE. -
ThreatLevelCode: string
Title:
Threat Level
Maximum Length:30
The level of threat or risk from the competitor. The list of valid values are Low, Medium and High. A list of accepted values are 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. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the logged in user has access to update the Competitor. The value will be true or false based on the user???s Data Security privileges.
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
- CompttrStatusLookupForSearch
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_STATUS
The list of values for the competitor's status such as Active or Inactive.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CompttrThrtLvlLookupForSearch
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL
The list of values for the level of threat or risk from the competitor such as Low, Medium, or High.
The following properties are defined on the LOV link relation:- Source Attribute: ThreatLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to get a competitor 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/competitors/{PartyId}
Example of Response Body
The following shows an example of the response body in JSON format.
{ "PartyName": "ACmpttr0b759025130", "PartyUniqueName": "ACmpttr0b759025130", "StatusCode": "ACTIVE", "ThreatLevelCode": "HIGH", "PartyId": 300100070066841, "CreatedBy": "SALES_ADMIN", "CreationDate": "2015-03-28T09:10:35.022+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2015-03-28T09:10:45.577+00:00", "LastUpdateLogin": "125B23B85F187B53E0531833F40A8516", "PartyNumber": "CDRM_153769", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitors/300100070066841", "name": "competitors", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitors/300100070066841", "name": "competitors", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitors/300100070066841/lov/CompttrStatusLookupForSearch", "name": "CompttrStatusLookupForSearch", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitors/300100070066841/lov/CompttrThrtLvlLookupForSearch", "name": "CompttrThrtLvlLookupForSearch", "kind": "collection" } ] }