機械翻訳について

ジャンプ先

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

期間目標の更新

patch

/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalPeriodGoals/{ParticipantPeriodGoalId}

リクエスト

パス・パラメータ

• ParticipantGoalId(required): integer(int64)
  参加者パフォーマンス・メジャーに関連付けられた目標の一意の識別子です。
• ParticipantPerformanceMeasureId(required): integer(int64)
  参加者プラン・コンポーネントに関連付けられたパフォーマンス・メジャーの一意の識別子。
• ParticipantPeriodGoalId(required): integer(int64)
  期間目標の一意の識別子。
• ParticipantPlanComponentId(required): integer(int64)
  参加者報酬プランに関連付けられたプラン・コンポーネントの一意の識別子です。
• participantCompensationPlansUniqID(required): string
  これは、関係者報酬プラン・リソースの複合キーを構成し、関係者報酬プランのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、参加者報酬プラン・コレクション・リソースを問い合せて、ハッシュ・キーを取得するために参加者報酬プランの特定のインスタンスに移動する必要があります。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AlternatePeriodTarget1: number
  タイトル: Alternate Period Target 1

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget2: number
  タイトル: Alternate Period Target 2

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget3: number
  タイトル: Alternate Period Target 3

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget4: number
  タイトル: Alternate Period Target 4

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget5: number
  タイトル: Alternate Period Target 5

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• PeriodTarget: number
  タイトル: Period Target

  デフォルト値: 0

  メジャーの期間ターゲット番号。

{
    "type":"object",
    "properties":{
        "AlternatePeriodTarget4":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget5":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget1":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget2":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget3":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response

タイプ: object

ソースを表示

• AlternateITDTarget1: number
  タイトル: Alternate ITD Target 1

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternateITDTarget2: number
  タイトル: Alternate ITD Target 2

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternateITDTarget3: number
  タイトル: Alternate ITD Target 3

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternateITDTarget4: number
  タイトル: Alternate ITD Target 4

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternateITDTarget5: number
  タイトル: Alternate ITD Target 5

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternatePeriodTarget1: number
  タイトル: Alternate Period Target 1

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget2: number
  タイトル: Alternate Period Target 2

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget3: number
  タイトル: Alternate Period Target 3

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget4: number
  タイトル: Alternate Period Target 4

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget5: number
  タイトル: Alternate Period Target 5

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  期間目標を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  期間目標が作成された日時。
• GoalId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられた目標の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• IntervalGoalId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられた間隔目標の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• ITDTarget: number
  タイトル: ITD Target

  読取り専用: true

  デフォルト値: 0

  メジャーの間隔累計ターゲット番号。
• LastUpdateDate: string (date-time)
  読取り専用: true

  期間目標が最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  期間目標を最後に更新したユーザー。
• links: array Links
  タイトル: Links

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

  目標の一意のID。
• ParticipantIntervalGoalId: integer (int64)
  読取り専用: true

  参加者間隔目標詳細の一意の識別子。
• ParticipantPeriodGoalId: integer (int64)
  読取り専用: true

  期間目標の一意の識別子。
• PeriodEndDate: 文字列(日付)
  タイトル: End Date

  読取り専用: true

  期間が終了する日付。
• PeriodGoalId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられた期間目標の一意の識別子です。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• PeriodId: integer (int64)
  タイトル: Period

  読取り専用: true

  カレンダに定義されている期間の一意の識別子。
• PeriodName: string
  タイトル: Period

  読取り専用: true

  最大長: 30

  カレンダで定義された期間の名前。
• PeriodStartDate: 文字列(日付)
  タイトル: Start Date

  読取り専用: true

  期間の開始日。
• PeriodTarget: number
  タイトル: Period Target

  デフォルト値: 0

  メジャーの期間ターゲット番号。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the period goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period of time ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateITDTarget2":{
            "title":"Alternate ITD Target 2",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget2"
                ]
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget4":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateITDTarget3":{
            "title":"Alternate ITD Target 3",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget3"
                ]
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget5":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateITDTarget1":{
            "title":"Alternate ITD Target 1",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget1"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget4":{
            "title":"Alternate ITD Target 4",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget4"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget5":{
            "title":"Alternate ITD Target 5",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget5"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ITDTarget":{
            "title":"ITD Target",
            "type":"number",
            "description":"The interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "PeriodTarget"
                ]
            },
            "x-queryable":true
        },
        "ParticipantPeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget1":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget2":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget3":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the period goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantIntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the participant interval goal details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the period goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The unique identifier for the period of time defined in the calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the period of time begins.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":30,
            "type":"string",
            "description":"The name for a period of time defined in the calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the period goal is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

「トップに戻る」