機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

コンテスト・スコアの更新

patch

/crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores/{ContestScoresUniqID}

リクエスト

パス・パラメータ

• ContestNumber(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
• ContestScoresUniqID(required): string
  これは、コンテスト・スコア・リソースに対してコンポジット・キー(ContestIdおよびResourceId ---)を構成する属性のハッシュ・キーで、コンテスト・スコアのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、コンテスト・スコアの特定のインスタンスに移動するために、主キー値に対するフィルタを使用してコンテスト・スコア・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: ContestScores?q=ContestId=<value1>;ResourceId=<value2>

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• ContestScoreDetails: array 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"
            }
        }
    }
}

ネストされたスキーマ : コンテスト・スコア詳細

タイプ: array

タイトル: Contest Score Details

コンテスト・スコア詳細

ソースを表示

• 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"
    }
}

ネストされたスキーマ : contests-ContestScores-ContestScoreDetails-item-patch-request

タイプ: object

ソースを表示

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

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : contests-ContestScores-item-response

タイプ: object

ソースを表示

• ContestEndDate: string (date-time)
  読取り専用: true

  コンテスト終了日
• ContestId: integer (int64)
  読取り専用: true

  コンテストID
• ContestName: string
  読取り専用: true

  最大長: 275

  コンテスト名
• ContestNumber: string
  読取り専用: true

  最大長: 64

  コンテスト番号
• ContestPcptScoreId: string
  読取り専用: true

  最大長: 255

  コンテスト参加者スコアID
• ContestScoreDetails: array Contest Score Details
  タイトル: Contest Score Details

  コンテスト・スコア詳細
• ContestStartDate: string (date-time)
  読取り専用: true

  コンテスト開始日
• DenomScore: number
  読取り専用: true

  KPIスコアの分母値。
• KPIAggregation: string
  読取り専用: true

  最大長: 200

  コンテスト・スコアのKPI計算タイプ
• KPIId: integer (int64)
  読取り専用: true

  KPI ID
• KPIName: string
  読取り専用: true

  最大長: 275

  KPI名
• KPINumber: string
  読取り専用: true

  最大長: 64

  KPI番号
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NumerScore: number
  読取り専用: true

  KPIスコアの分子値。
• PersonId: integer (int64)
  読取り専用: true

  Person ID
• ランク: number
  読取り専用: true

  ランク
• ResourceAvatarUri: string
  読取り専用: true

  リソース・アバターURI
• ResourceId: integer (int64)
  読取り専用: true

  リソースID
• ResourceName: string
  読取り専用: true

  最大長: 360

  リソース名
• ResourceNumber: string
  読取り専用: true

  最大長: 30

  リソース番号
• スコア: number
  読取り専用: true

  スコア
• UOMCode: string
  読取り専用: true

  最大長: 40

  単位コード

{
    "type":"object",
    "properties":{
        "ContestName":{
            "maxLength":275,
            "type":"string",
            "description":"Contest Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumber":{
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestEndDate":{
            "type":"string",
            "description":"Contest End Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":360,
            "type":"string",
            "description":"Resource Name",
            "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"
            }
        },
        "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
        },
        "ContestPcptScoreId":{
            "maxLength":255,
            "type":"string",
            "description":"Contest Participant Score ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Rank":{
            "type":"number",
            "description":"Rank",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIName":{
            "maxLength":275,
            "type":"string",
            "description":"KPI Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomScore":{
            "type":"number",
            "description":"The denominator value of the KPI score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Score":{
            "type":"number",
            "description":"Score",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "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
        },
        "ResourceId":{
            "type":"integer",
            "description":"Resource ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NumerScore":{
            "type":"number",
            "description":"The numerator value of the KPI score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceAvatarUri":{
            "type":"string",
            "description":"Resource Avatar URI",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":40,
            "type":"string",
            "description":"UOM Code",
            "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
        }
    }
}

ネストされたスキーマ : コンテスト・スコア詳細

タイプ: array

タイトル: Contest Score Details

コンテスト・スコア詳細

ソースを表示

• 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"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : contests-ContestScores-ContestScoreDetails-item-response

タイプ: object

ソースを表示

• ContestEndDate: string (date-time)
  読取り専用: true

  コンテスト終了日
• ContestId: integer (int64)
  読取り専用: true

  コンテストID
• ContestName: string
  読取り専用: true

  最大長: 275

  コンテスト名
• ContestNumber: string
  読取り専用: true

  最大長: 64

  コンテスト番号
• ContestStartDate: string (date-time)
  読取り専用: true

  コンテスト開始日
• DenomScore: number
  読取り専用: true

  KPIスコアの分母値。
• KPICategoryCode: string
  読取り専用: true

  最大長: 100

  KPIカテゴリ・コード
• KPICategoryName: string
  読取り専用: true

  最大長: 80

  KPIカテゴリ名
• KPIId: integer (int64)
  読取り専用: true

  KPI ID
• KPIName: string
  読取り専用: true

  最大長: 275

  KPI名
• KPINumber: string
  読取り専用: true

  最大長: 64

  KPI番号
• KPIObject: string
  読取り専用: true

  最大長: 40

  KPIオブジェクト
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NumerScore: number
  読取り専用: true

  KPIスコアの分子値。
• ResourceId: integer (int64)
  読取り専用: true

  リソースID
• ResourceName: string
  読取り専用: true

  最大長: 900

  リソース名
• ResourceNumber: string
  読取り専用: true

  最大長: 30

  リソース番号
• スコア: number
  読取り専用: true

  スコア
• UOMCode: string
  読取り専用: true

  最大長: 40

  単位コード

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

ContestScoreDetails

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

パラメータ:

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

コンテスト・スコア詳細

「トップに戻る」