Update a contest score
patch
/crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores/{ContestScoresUniqID}
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=
-
ContestScoresUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ContestId and ResourceId ---for the Contest Scores resource and used to uniquely identify an instance of Contest Scores. The client should not generate the hash key value. Instead, the client should query on the Contest Scores collection resource with a filter on the primary key values in order to navigate to a specific instance of Contest Scores.
For example: ContestScores?q=ContestId=<value1>;ResourceId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ContestScoreDetails: array
Contest Score Details
Title:
Contest Score Details
Contest Score Details
Nested Schema : Contest Score Details
Type:
array
Title:
Contest Score Details
Contest Score Details
Show Source
Nested Schema : contests-ContestScores-ContestScoreDetails-item-patch-request
Type:
Show Source
object
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.
Root 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
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
- ContestScoreDetails
-
Parameters:
- ContestNumber:
$request.path.ContestNumber
- ContestScoresUniqID:
$request.path.ContestScoresUniqID
Contest Score Details - ContestNumber: