Jump to

• Request
• Response

Update a contest

patch

/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=

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

• ConflictId: integer (int64)
  Default Value: 0

  Conflict ID
• ContestHistory: array Contest History
  Title: Contest History

  Contest History
• ContestName: string
  Title: Contest Name

  Maximum Length: 275

  Contest Name
• ContestParticipants: array Contest Resources
  Title: Contest Resources

  Contest Resources
• ContestScores: array Contest Scores
  Title: Contest Scores

  Contest Scores
• Description: string
  Title: Description

  Maximum Length: 3000

  Description
• EndDate: string (date-time)
  Title: End Date

  End Date
• KPIId: integer (int64)
  Title: KPI ID

  KPI ID
• OwnerId: integer (int64)
  Title: Owner ID

  Owner ID
• StartDate: string (date-time)
  Title: Start Date

  Start Date

{
    "type":"object",
    "properties":{
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "ContestHistory":{
            "title":"Contest History",
            "type":"array",
            "description":"Contest History",
            "items":{
                "$ref":"#/components/schemas/contests-ContestHistory-item-patch-request"
            }
        },
        "ContestName":{
            "title":"Contest Name",
            "maxLength":275,
            "type":"string",
            "description":"Contest Name",
            "nullable":false
        },
        "ContestParticipants":{
            "title":"Contest Resources",
            "type":"array",
            "description":"Contest Resources",
            "items":{
                "$ref":"#/components/schemas/contests-ContestParticipants-item-patch-request"
            }
        },
        "ContestScores":{
            "title":"Contest Scores",
            "type":"array",
            "description":"Contest Scores",
            "items":{
                "$ref":"#/components/schemas/contests-ContestScores-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":3000,
            "type":"string",
            "description":"Description",
            "nullable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date-time",
            "nullable":false
        },
        "KPIId":{
            "title":"KPI ID",
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"Owner ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date-time",
            "nullable":false
        }
    }
}

Nested Schema : Contest History

Type: array

Title: Contest History

Contest History

Show Source

• Array of: object contests-ContestHistory-item-patch-request

{
    "title":"Contest History",
    "type":"array",
    "description":"Contest History",
    "items":{
        "$ref":"#/components/schemas/contests-ContestHistory-item-patch-request"
    }
}

Nested Schema : Contest Resources

Type: array

Title: Contest Resources

Contest Resources

Show Source

• Array of: object contests-ContestParticipants-item-patch-request

{
    "title":"Contest Resources",
    "type":"array",
    "description":"Contest Resources",
    "items":{
        "$ref":"#/components/schemas/contests-ContestParticipants-item-patch-request"
    }
}

Nested Schema : Contest Scores

Type: array

Title: Contest Scores

Contest Scores

Show Source

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

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

Nested Schema : contests-ContestHistory-item-patch-request

Type: object

Show Source

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

Nested Schema : contests-ContestParticipants-item-patch-request

Type: object

Show Source

• ConflictId: integer (int64)
  Default Value: 0

  Contest Participant Conflict ID
• ContestResourceRole: string
  Title: Contest Resource Role

  Maximum Length: 40

  Contest Resource Role

{
    "type":"object",
    "properties":{
        "ConflictId":{
            "type":"integer",
            "description":"Contest Participant Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "ContestResourceRole":{
            "title":"Contest Resource Role",
            "maxLength":40,
            "type":"string",
            "description":"Contest Resource Role",
            "nullable":true
        }
    }
}

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

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-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContestHistory":{
            "title":"Contest History",
            "type":"array",
            "description":"Contest History",
            "items":{
                "$ref":"#/components/schemas/contests-ContestHistory-item-response"
            }
        },
        "ContestId":{
            "title":"Contest ID",
            "type":"integer",
            "description":"Contest ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContestName":{
            "title":"Contest Name",
            "maxLength":275,
            "type":"string",
            "description":"Contest Name",
            "nullable":false,
            "x-queryable":true
        },
        "ContestNumber":{
            "title":"Contest Number",
            "maxLength":64,
            "type":"string",
            "description":"Contest Number",
            "nullable":false,
            "x-queryable":true
        },
        "ContestParticipants":{
            "title":"Contest Resources",
            "type":"array",
            "description":"Contest Resources",
            "items":{
                "$ref":"#/components/schemas/contests-ContestParticipants-item-response"
            }
        },
        "ContestScores":{
            "title":"Contest Scores",
            "type":"array",
            "description":"Contest Scores",
            "items":{
                "$ref":"#/components/schemas/contests-ContestScores-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Delete Contest",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":3000,
            "type":"string",
            "description":"Description",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "KPIAggregation":{
            "title":"KPI Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"KPI Calculation Type",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIDescription":{
            "title":"KPI Description",
            "maxLength":3000,
            "type":"string",
            "description":"KPI Description",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIId":{
            "title":"KPI ID",
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPIName":{
            "title":"KPI Name",
            "maxLength":275,
            "type":"string",
            "description":"KPI Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumber":{
            "title":"KPI Number",
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"Owner ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner Name",
            "maxLength":360,
            "type":"string",
            "description":"Owner Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerNumber":{
            "title":"Owner Number",
            "maxLength":30,
            "type":"string",
            "description":"Owner Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerUniqueName":{
            "title":"Owner Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"Owner Unique Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Update Contest",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Contest History

Type: array

Title: Contest History

Contest History

Show Source

• Array of: object contests-ContestHistory-item-response

{
    "title":"Contest History",
    "type":"array",
    "description":"Contest History",
    "items":{
        "$ref":"#/components/schemas/contests-ContestHistory-item-response"
    }
}

Nested Schema : Contest Resources

Type: array

Title: Contest Resources

Contest Resources

Show Source

• Array of: object contests-ContestParticipants-item-response

{
    "title":"Contest Resources",
    "type":"array",
    "description":"Contest Resources",
    "items":{
        "$ref":"#/components/schemas/contests-ContestParticipants-item-response"
    }
}

Nested Schema : Contest Scores

Type: array

Title: Contest Scores

Contest Scores

Show Source

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

{
    "title":"Contest Scores",
    "type":"array",
    "description":"Contest Scores",
    "items":{
        "$ref":"#/components/schemas/contests-ContestScores-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-ContestHistory-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "ContestId":{
            "type":"integer",
            "description":"Contest ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicNumber1Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 1 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber1UOM":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 1 UOM",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber1Value":{
            "type":"integer",
            "description":"Dynamic Number 1 Value",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicNumber2Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 2 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber2UOM":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 2 UOM",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber2Value":{
            "type":"integer",
            "description":"Dynamic Number 2 Value",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicText1Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 1 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText1Value":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 1 Value",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText2Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 2 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText2Value":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 2 Value",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordDate":{
            "type":"string",
            "description":"History Record Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordId":{
            "type":"integer",
            "description":"History Record ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordObjectId":{
            "type":"integer",
            "description":"The unique identifier of the history record object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HistoryRecordObjectNumber":{
            "maxLength":256,
            "type":"string",
            "description":"The alternate unique identifier of the history record object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordOwnerId":{
            "type":"integer",
            "description":"History Resource Owner ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HistoryRecordOwnerName":{
            "maxLength":360,
            "type":"string",
            "description":"The owner of the history record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordOwnerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the history record owner.",
            "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
        },
        "StaticText":{
            "maxLength":4000,
            "type":"string",
            "description":"Static Text",
            "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."
        }
    }
}

Nested Schema : contests-ContestParticipants-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "ConflictId":{
            "type":"integer",
            "description":"Contest Participant Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContestId":{
            "title":"Contest ID",
            "type":"integer",
            "description":"Contest ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContestNumber":{
            "title":"Contest Number",
            "maxLength":64,
            "type":"string",
            "description":"Contest Number",
            "nullable":false,
            "x-queryable":true
        },
        "ContestResourceId":{
            "title":"Contest Resource ID",
            "type":"integer",
            "description":"Contest Resource ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContestResourceRole":{
            "title":"Contest Resource Role",
            "maxLength":40,
            "type":"string",
            "description":"Contest Resource Role",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ResourceAvatarUri":{
            "type":"string",
            "description":"Participant Avatar URI",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Resource ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "nullable":false,
            "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 : 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"
    }
}

Links

ContestHistory

Operation: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestHistory

Parameters:

• ContestNumber: $request.path.ContestNumber

Contest History

ContestParticipants

Operation: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestParticipants

Parameters:

• ContestNumber: $request.path.ContestNumber

Contest Resources

ContestScores

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

Parameters:

• ContestNumber: $request.path.ContestNumber

Contest Scores

Back to Top