Get a contest
get
/crmRestApi/resources/11.13.18.05/contests/{ContestNumber}
Request
Path Parameters
-
ContestNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : contests-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
Conflict ID -
ContestHistory: array
Contest History
Title:
Contest History
Contest History -
ContestId: integer
(int64)
Title:
Contest ID
Contest ID -
ContestName: string
Title:
Contest Name
Maximum Length:275
Contest Name -
ContestNumber: string
Title:
Contest Number
Maximum Length:64
Contest Number -
ContestParticipants: array
Contest Resources
Title:
Contest Resources
Contest Resources -
ContestScores: array
Contest Scores
Title:
Contest Scores
Contest Scores -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Creation Date -
DeleteFlag: boolean
Read Only:
true
Delete Contest -
Description: string
Title:
Description
Maximum Length:3000
Description -
EndDate: string
(date-time)
Title:
End Date
End Date -
KPIAggregation: string
Title:
KPI Calculation Type
Read Only:true
Maximum Length:200
KPI Calculation Type -
KPIDescription: string
Title:
KPI Description
Read Only:true
Maximum Length:3000
KPI Description -
KPIId: integer
(int64)
Title:
KPI ID
KPI ID -
KPIName: string
Title:
KPI Name
Read Only:true
Maximum Length:275
KPI Name -
KPINumber: string
Title:
KPI Number
Maximum Length:64
KPI Number -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Last Updated Date -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Last Updated By -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Last Update Login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object Version Number -
OwnerId: integer
(int64)
Title:
Owner ID
Owner ID -
OwnerName: string
Title:
Owner Name
Read Only:true
Maximum Length:360
Owner Name -
OwnerNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
Owner Number -
OwnerUniqueName: string
Title:
Owner Unique Name
Read Only:true
Maximum Length:900
Owner Unique Name -
StartDate: string
(date-time)
Title:
Start Date
Start Date -
UpdateFlag: boolean
Read Only:
true
Update Contest
Nested Schema : Contest Resources
Type:
array
Title:
Contest Resources
Contest Resources
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contests-ContestHistory-item-response
Type:
Show Source
object
-
ContestId: integer
(int64)
Read Only:
true
Contest ID -
DynamicNumber1Name: string
Read Only:
true
Maximum Length:200
Dynamic Number 1 Name -
DynamicNumber1UOM: string
Read Only:
true
Maximum Length:200
Dynamic Number 1 UOM -
DynamicNumber1Value: integer
(int64)
Read Only:
true
Dynamic Number 1 Value -
DynamicNumber2Name: string
Read Only:
true
Maximum Length:200
Dynamic Number 2 Name -
DynamicNumber2UOM: string
Read Only:
true
Maximum Length:200
Dynamic Number 2 UOM -
DynamicNumber2Value: integer
(int64)
Read Only:
true
Dynamic Number 2 Value -
DynamicText1Name: string
Read Only:
true
Maximum Length:200
Dynamic Text 1 Name -
DynamicText1Value: string
Read Only:
true
Maximum Length:200
Dynamic Text 1 Value -
DynamicText2Name: string
Read Only:
true
Maximum Length:200
Dynamic Text 2 Name -
DynamicText2Value: string
Read Only:
true
Maximum Length:200
Dynamic Text 2 Value -
HistoryRecordDate: string
(date-time)
Read Only:
true
History Record Date -
HistoryRecordId: integer
Read Only:
true
History Record ID -
HistoryRecordObjectId: integer
(int64)
Read Only:
true
The unique identifier of the history record object. -
HistoryRecordObjectNumber: string
Read Only:
true
Maximum Length:256
The alternate unique identifier of the history record object. -
HistoryRecordOwnerId: integer
(int64)
Read Only:
true
History Resource Owner ID -
HistoryRecordOwnerName: string
Read Only:
true
Maximum Length:360
The owner of the history record. -
HistoryRecordOwnerNumber: string
Read Only:
true
Maximum Length:30
The alternate unique identifier of the history record owner. -
KPIId: integer
(int64)
Read Only:
true
KPI ID -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StaticText: string
Read Only:
true
Maximum Length:4000
Static Text
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.
Nested Schema : contests-ContestParticipants-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
Contest Participant Conflict ID -
ContestId: integer
(int64)
Title:
Contest ID
Contest ID -
ContestNumber: string
Title:
Contest Number
Maximum Length:64
Contest Number -
ContestResourceId: integer
(int64)
Title:
Contest Resource ID
Contest Resource ID -
ContestResourceRole: string
Title:
Contest Resource Role
Maximum Length:40
Contest Resource Role -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Creation Date -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Last Updated Date -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Last Updated By -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Last Update Login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object Version Number -
ResourceAvatarUri: string
Read Only:
true
Participant Avatar URI -
ResourceId: integer
(int64)
Title:
Resource ID
Resource ID -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:360
Name -
ResourceNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
Resource Number
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contests-ContestScores-item-response
Type:
Show Source
object
-
ContestEndDate: string
(date-time)
Read Only:
true
Contest End Date -
ContestId: integer
(int64)
Read Only:
true
Contest ID -
ContestName: string
Read Only:
true
Maximum Length:275
Contest Name -
ContestNumber: string
Read Only:
true
Maximum Length:64
Contest Number -
ContestPcptScoreId: string
Read Only:
true
Maximum Length:255
Contest Participant Score ID -
ContestScoreDetails: array
Contest Score Details
Title:
Contest Score Details
Contest Score Details -
ContestStartDate: string
(date-time)
Read Only:
true
Contest Start Date -
DenomScore: number
Read Only:
true
The denominator value of the KPI score. -
KPIAggregation: string
Read Only:
true
Maximum Length:200
KPI Calculation Type for Contest Scores -
KPIId: integer
(int64)
Read Only:
true
KPI ID -
KPIName: string
Read Only:
true
Maximum Length:275
KPI Name -
KPINumber: string
Read Only:
true
Maximum Length:64
KPI Number -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumerScore: number
Read Only:
true
The numerator value of the KPI score. -
PersonId: integer
(int64)
Read Only:
true
Person ID -
Rank: number
Read Only:
true
Rank -
ResourceAvatarUri: string
Read Only:
true
Resource Avatar URI -
ResourceId: integer
(int64)
Read Only:
true
Resource ID -
ResourceName: string
Read Only:
true
Maximum Length:360
Resource Name -
ResourceNumber: string
Read Only:
true
Maximum Length:30
Resource Number -
Score: number
Read Only:
true
Score -
UOMCode: string
Read Only:
true
Maximum Length:40
UOM Code
Nested Schema : Contest Score Details
Type:
array
Title:
Contest Score Details
Contest Score Details
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contests-ContestScores-ContestScoreDetails-item-response
Type:
Show Source
object
-
ContestEndDate: string
(date-time)
Read Only:
true
Contest End Date -
ContestId: integer
(int64)
Read Only:
true
Contest ID -
ContestName: string
Read Only:
true
Maximum Length:275
Contest Name -
ContestNumber: string
Read Only:
true
Maximum Length:64
Contest Number -
ContestStartDate: string
(date-time)
Read Only:
true
Contest Start Date -
DenomScore: number
Read Only:
true
The denominator value of the KPI score. -
KPICategoryCode: string
Read Only:
true
Maximum Length:100
KPI Category Code -
KPICategoryName: string
Read Only:
true
Maximum Length:80
KPI Category Name -
KPIId: integer
(int64)
Read Only:
true
KPI ID -
KPIName: string
Read Only:
true
Maximum Length:275
KPI Name -
KPINumber: string
Read Only:
true
Maximum Length:64
KPI Number -
KPIObject: string
Read Only:
true
Maximum Length:40
KPI Object -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumerScore: number
Read Only:
true
The numerator value of the KPI score. -
ResourceId: integer
(int64)
Read Only:
true
Resource ID -
ResourceName: string
Read Only:
true
Maximum Length:900
Resource Name -
ResourceNumber: string
Read Only:
true
Maximum Length:30
Resource Number -
Score: number
Read Only:
true
Score -
UOMCode: string
Read Only:
true
Maximum Length:40
UOM Code
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ContestHistory
-
Parameters:
- ContestNumber:
$request.path.ContestNumber
Contest History - ContestNumber:
- ContestParticipants
-
Parameters:
- ContestNumber:
$request.path.ContestNumber
Contest Resources - ContestNumber:
- ContestScores
-
Parameters:
- ContestNumber:
$request.path.ContestNumber
Contest Scores - ContestNumber:
Examples
The following example shows how to get a contest 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/contests/{ContestNumber}
Example of Response Body
The following shows an example of the response body in JSON format.
{ "ContestId": 300100547824052, "ContestNumber": "CDRM_1039", "ContestName": "ContestAppointmentsCompleted_2021-08-10 10:52:17", "Description": "Testing_2021-08-10 10:52:17", "OwnerId": 300100206486893, "StartDate": "2021-08-10T10:51:38+00:00", "EndDate": "2021-09-09T10:52:18+00:00", "KPIId": 100100144204795, "CreatedBy": "cbarry", "CreationDate": "2021-08-10T10:50:40+00:00", "LastUpdatedBy": "cbarry", "LastUpdateDate": "2021-08-10T10:50:42.547+00:00", "LastUpdateLogin": "C92581ABB72CF83AE0533AFDF40A3E1C", "ObjectVersionNumber": 1, "ConflictId": 0, "OwnerName": "Conor Barry", "OwnerNumber": "CDRM_900650", "OwnerUniqueName": "Conor Barry", "KPIName": "Appointments Completed", "KPINumber": "SEED_6_S", "KPIDescription": "Measures the number of appointments completed.", "UpdateFlag": true, "DeleteFlag": true, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039", "name": "contests", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039", "name": "contests", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039/child/ContestHistory", "name": "ContestHistory", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039/child/ContestParticipants", "name": "ContestParticipants", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039/child/ContestScores", "name": "ContestScores", "kind": "collection" } ] }