機械翻訳について

ジャンプ先

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

コンテストの更新

patch

/crmRestApi/resources/11.13.18.05/contests/{ContestNumber}

リクエスト

パス・パラメータ

• ContestNumber(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  デフォルト値: 0

  競合ID
• ContestHistory: array Contest History
  タイトル: Contest History

  コンテスト履歴
• ContestName: string
  タイトル: Contest Name

  最大長: 275

  コンテスト名
• ContestParticipants: array Contest Resources
  タイトル: Contest Resources

  コンテスト・リソース
• ContestScores: array Contest Scores
  タイトル: Contest Scores

  コンテスト・スコア
• Description: string
  タイトル: Description

  最大長: 3000

  摘要
• EndDate: string (date-time)
  タイトル: End Date

  終了日
• KPIId: integer (int64)
  タイトル: KPI ID

  KPI ID
• OwnerId: integer (int64)
  タイトル: Owner ID

  所有者ID
• StartDate: string (date-time)
  タイトル: Start Date

  開始日

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

ネストされたスキーマ : コンテスト履歴

タイプ: array

タイトル: Contest History

コンテスト履歴

ソースを表示

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

ネストされたスキーマ : コンテスト・リソース

タイプ: array

タイトル: Contest Resources

コンテスト・リソース

ソースを表示

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

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

タイプ: array

タイトル: Contest Scores

コンテスト・スコア

ソースを表示

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

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

タイプ: object

ソースを表示

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

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

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  デフォルト値: 0

  コンテスト参加者コンフリクトID
• ContestResourceRole: string
  タイトル: Contest Resource Role

  最大長: 40

  コンテスト・リソース・ロール

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

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

タイプ: 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-item-response

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  デフォルト値: 0

  競合ID
• ContestHistory: array Contest History
  タイトル: Contest History

  コンテスト履歴
• ContestId: integer (int64)
  タイトル: Contest ID

  コンテストID
• ContestName: string
  タイトル: Contest Name

  最大長: 275

  コンテスト名
• ContestNumber: string
  タイトル: Contest Number

  最大長: 64

  コンテスト番号
• ContestParticipants: array Contest Resources
  タイトル: Contest Resources

  コンテスト・リソース
• ContestScores: array Contest Scores
  タイトル: Contest Scores

  コンテスト・スコア
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  作成者
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  作成日
• DeleteFlag: boolean
  読取り専用: true

  コンテストの削除
• Description: string
  タイトル: Description

  最大長: 3000

  摘要
• EndDate: string (date-time)
  タイトル: End Date

  終了日
• KPIAggregation: string
  タイトル: KPI Calculation Type

  読取り専用: true

  最大長: 200

  KPI計算タイプ
• KPIDescription: string
  タイトル: KPI Description

  読取り専用: true

  最大長: 3000

  KPIの説明
• KPIId: integer (int64)
  タイトル: KPI ID

  KPI ID
• KPIName: string
  タイトル: KPI Name

  読取り専用: true

  最大長: 275

  KPI名
• KPINumber: string
  タイトル: KPI Number

  最大長: 64

  KPI番号
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  最終更新日
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  最終更新者
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  最終更新ログイン
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  読取り専用: true

  オブジェクト・バージョン番号
• OwnerId: integer (int64)
  タイトル: Owner ID

  所有者ID
• OwnerName: string
  タイトル: Owner Name

  読取り専用: true

  最大長: 360

  所有者名
• OwnerNumber: string
  タイトル: Owner Number

  読取り専用: true

  最大長: 30

  所有者番号
• OwnerUniqueName: string
  タイトル: Owner Unique Name

  読取り専用: true

  最大長: 900

  所有者一意名
• StartDate: string (date-time)
  タイトル: Start Date

  開始日
• UpdateFlag: boolean
  読取り専用: true

  コンテストの更新

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner Name",
            "maxLength":360,
            "type":"string",
            "description":"Owner Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":3000,
            "type":"string",
            "description":"Description",
            "nullable":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
        },
        "ContestNumber":{
            "title":"Contest Number",
            "maxLength":64,
            "type":"string",
            "description":"Contest Number",
            "nullable":false,
            "x-queryable":true
        },
        "ContestHistory":{
            "title":"Contest History",
            "type":"array",
            "description":"Contest History",
            "items":{
                "$ref":"#/components/schemas/contests-ContestHistory-item-response"
            }
        },
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "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
        },
        "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
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"Owner ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContestScores":{
            "title":"Contest Scores",
            "type":"array",
            "description":"Contest Scores",
            "items":{
                "$ref":"#/components/schemas/contests-ContestScores-item-response"
            }
        },
        "KPIAggregation":{
            "title":"KPI Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"KPI Calculation Type",
            "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"
            }
        },
        "ContestId":{
            "title":"Contest ID",
            "type":"integer",
            "description":"Contest ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumber":{
            "title":"KPI Number",
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "x-queryable":true
        },
        "ContestName":{
            "title":"Contest Name",
            "maxLength":275,
            "type":"string",
            "description":"Contest Name",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIDescription":{
            "title":"KPI Description",
            "maxLength":3000,
            "type":"string",
            "description":"KPI Description",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Delete Contest",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "KPIId":{
            "title":"KPI ID",
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "ContestParticipants":{
            "title":"Contest Resources",
            "type":"array",
            "description":"Contest Resources",
            "items":{
                "$ref":"#/components/schemas/contests-ContestParticipants-item-response"
            }
        }
    }
}

ネストされたスキーマ : コンテスト履歴

タイプ: array

タイトル: Contest History

コンテスト履歴

ソースを表示

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

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

ネストされたスキーマ : コンテスト・リソース

タイプ: array

タイトル: Contest Resources

コンテスト・リソース

ソースを表示

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

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

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

タイプ: array

タイトル: Contest Scores

コンテスト・スコア

ソースを表示

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

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

タイプ: object

ソースを表示

• ContestId: integer (int64)
  読取り専用: true

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

  最大長: 200

  動的番号1の名前
• DynamicNumber1UOM: string
  読取り専用: true

  最大長: 200

  動的番号1単位
• DynamicNumber1Value: integer (int64)
  読取り専用: true

  動的数値1の値
• DynamicNumber2Name: string
  読取り専用: true

  最大長: 200

  動的番号2の名前
• DynamicNumber2UOM: string
  読取り専用: true

  最大長: 200

  動的番号2単位
• DynamicNumber2Value: integer (int64)
  読取り専用: true

  動的数値2の値
• DynamicText1Name: string
  読取り専用: true

  最大長: 200

  動的テキスト1の名前
• DynamicText1Value: string
  読取り専用: true

  最大長: 200

  動的テキスト1の値
• DynamicText2Name: string
  読取り専用: true

  最大長: 200

  動的テキスト2の名前
• DynamicText2Value: string
  読取り専用: true

  最大長: 200

  動的テキスト2の値
• HistoryRecordDate: string (date-time)
  読取り専用: true

  履歴レコード日
• HistoryRecordId: integer
  読取り専用: true

  履歴レコードID
• HistoryRecordObjectId: integer (int64)
  読取り専用: true

  履歴レコード・オブジェクトの一意の識別子。
• HistoryRecordObjectNumber: string
  読取り専用: true

  最大長: 256

  履歴レコード・オブジェクトの代替一意識別子。
• HistoryRecordOwnerId: integer (int64)
  読取り専用: true

  履歴リソース所有者ID
• HistoryRecordOwnerName: string
  読取り専用: true

  最大長: 360

  履歴レコードの所有者。
• HistoryRecordOwnerNumber: string
  読取り専用: true

  最大長: 30

  履歴レコード所有者の代替の一意の識別子。
• KPIId: integer (int64)
  読取り専用: true

  KPI ID
• links: array Links
  タイトル: Links

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

  最大長: 4000

  静的テキスト

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

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

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  デフォルト値: 0

  コンテスト参加者コンフリクトID
• ContestId: integer (int64)
  タイトル: Contest ID

  コンテストID
• ContestNumber: string
  タイトル: Contest Number

  最大長: 64

  コンテスト番号
• ContestResourceId: integer (int64)
  タイトル: Contest Resource ID

  コンテスト・リソースID
• ContestResourceRole: string
  タイトル: Contest Resource Role

  最大長: 40

  コンテスト・リソース・ロール
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  作成者
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  作成日
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  最終更新日
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  最終更新者
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  最終更新ログイン
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  読取り専用: true

  オブジェクト・バージョン番号
• ResourceAvatarUri: string
  読取り専用: true

  参加者アバターURI
• ResourceId: integer (int64)
  タイトル: Resource ID

  リソースID
• ResourceName: string
  タイトル: Name

  読取り専用: true

  最大長: 360

  名前
• ResourceNumber: string
  タイトル: Resource Number

  読取り専用: true

  最大長: 30

  リソース番号

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Last Updated 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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContestNumber":{
            "title":"Contest Number",
            "maxLength":64,
            "type":"string",
            "description":"Contest Number",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"Contest Participant Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "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
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceAvatarUri":{
            "type":"string",
            "description":"Participant Avatar URI",
            "nullable":true,
            "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
        },
        "ContestId":{
            "title":"Contest ID",
            "type":"integer",
            "description":"Contest ID",
            "format":"int64",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : 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"
    }
}

リンク

ContestHistory

操作: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestHistory

パラメータ:

• ContestNumber: $request.path.ContestNumber

コンテスト履歴

ContestParticipants

操作: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestParticipants

パラメータ:

• ContestNumber: $request.path.ContestNumber

コンテスト・リソース

ContestScores

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

パラメータ:

• ContestNumber: $request.path.ContestNumber

コンテスト・スコア

「トップに戻る」