Jump to

• Request
• Response

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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ContestScoreDetails: array Contest Score Details
  Title: Contest Score Details

  Contest Score Details

{
    "type":"object",
    "properties":{
        "ContestScoreDetails":{
            "title":"Contest Score Details",
            "type":"array",
            "description":"Contest Score Details",
            "items":{
                "$ref":"#/components/schemas/contests-ContestScores-ContestScoreDetails-item-patch-request"
            }
        }
    }
}

Nested Schema : Contest Score Details

Type: array

Title: Contest Score Details

Contest Score Details

Show Source

• Array of: object contests-ContestScores-ContestScoreDetails-item-patch-request

{
    "title":"Contest Score Details",
    "type":"array",
    "description":"Contest Score Details",
    "items":{
        "$ref":"#/components/schemas/contests-ContestScores-ContestScoreDetails-item-patch-request"
    }
}

Nested Schema : contests-ContestScores-ContestScoreDetails-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : contests-ContestScores-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "ContestEndDate":{
            "type":"string",
            "description":"Contest End Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestId":{
            "type":"integer",
            "description":"Contest ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContestName":{
            "maxLength":275,
            "type":"string",
            "description":"Contest Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Contest Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestPcptScoreId":{
            "maxLength":255,
            "type":"string",
            "description":"Contest Participant Score ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestScoreDetails":{
            "title":"Contest Score Details",
            "type":"array",
            "description":"Contest Score Details",
            "items":{
                "$ref":"#/components/schemas/contests-ContestScores-ContestScoreDetails-item-response"
            }
        },
        "ContestStartDate":{
            "type":"string",
            "description":"Contest Start Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomScore":{
            "type":"number",
            "description":"The denominator value of the KPI score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIAggregation":{
            "maxLength":200,
            "type":"string",
            "description":"KPI Calculation Type for Contest Scores",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIId":{
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPIName":{
            "maxLength":275,
            "type":"string",
            "description":"KPI Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumber":{
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerScore":{
            "type":"number",
            "description":"The numerator value of the KPI score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Rank":{
            "type":"number",
            "description":"Rank",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceAvatarUri":{
            "type":"string",
            "description":"Resource Avatar URI",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Resource ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":360,
            "type":"string",
            "description":"Resource Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Score":{
            "type":"number",
            "description":"Score",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":40,
            "type":"string",
            "description":"UOM Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Contest Score Details

Type: array

Title: Contest Score Details

Contest Score Details

Show Source

• Array of: object contests-ContestScores-ContestScoreDetails-item-response

{
    "title":"Contest Score Details",
    "type":"array",
    "description":"Contest Score Details",
    "items":{
        "$ref":"#/components/schemas/contests-ContestScores-ContestScoreDetails-item-response"
    }
}

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 : contests-ContestScores-ContestScoreDetails-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "ContestEndDate":{
            "type":"string",
            "description":"Contest End Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestId":{
            "type":"integer",
            "description":"Contest ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContestName":{
            "maxLength":275,
            "type":"string",
            "description":"Contest Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Contest Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestStartDate":{
            "type":"string",
            "description":"Contest Start Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomScore":{
            "type":"number",
            "description":"The denominator value of the KPI score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPICategoryCode":{
            "maxLength":100,
            "type":"string",
            "description":"KPI Category Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPICategoryName":{
            "maxLength":80,
            "type":"string",
            "description":"KPI Category Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIId":{
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPIName":{
            "maxLength":275,
            "type":"string",
            "description":"KPI Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumber":{
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIObject":{
            "maxLength":40,
            "type":"string",
            "description":"KPI Object",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerScore":{
            "type":"number",
            "description":"The numerator value of the KPI score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Resource ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":900,
            "type":"string",
            "description":"Resource Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Score":{
            "type":"number",
            "description":"Score",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":40,
            "type":"string",
            "description":"UOM Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

ContestScoreDetails

Operation: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores/{ContestScoresUniqID}/child/ContestScoreDetails

Parameters:

• ContestNumber: $request.path.ContestNumber
• ContestScoresUniqID: $request.path.ContestScoresUniqID

Contest Score Details

Back to Top