機械翻訳について

ジャンプ先

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

パフォーマンス測定の更新

patch

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures/{PlanComponentPerformanceMeasureId}

リクエスト

パス・パラメータ

• PlanComponentPerformanceMeasureId(required): integer(int64)
  プラン・コンポーネントに関連付けられたパフォーマンス・メジャー・レコードの一意の識別子です。
• planComponentsUniqID(required): string
  これは、プラン・コンポーネント・リソースのコンポジット・キー(PlanComponentIdおよびOrgId)を構成する属性のハッシュ・キーで、プラン・コンポーネントのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、プラン・コンポーネントの特定のインスタンスに移動するために、主キー値に対するフィルタを使用してプラン・コンポーネント・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• CalculationSequence: 整数(int32)
  タイトル: Calculation Sequence

  デフォルト値: 1

  プラン・コンポーネント内のパフォーマンス・メジャーが計算エンジンで考慮される順序。 これは、依存メジャーが他の基準メジャーの計算結果を参照する場合に設定されます。 依存メジャーは、基準メジャーよりも高い計算順序にする必要があります。
• EarningBasis: string
  タイトル: Earning Basis

  最大長: 1

  デフォルト値: Y

  達成計算と支給計算で同じクレジット・カテゴリを使用するかどうか、およびインセンティブ算式で計算にメジャー達成を使用するかどうかを指定します。 使用可能な値はY、Nです。 Yのままにして、プラン・コンポーネントのインセンティブ算式でパフォーマンス・メジャー達成を参照します。 トランザクションを個別に処理するパフォーマンス・メジャーが、イベントごとにインセンティブを計算するプラン・コンポーネントに関連付けられている場合、支給基準はYである必要があります。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• PerformanceMeasureId: integer (int64)
  タイトル: Performance Measure ID

  パフォーマンス・メジャー・レコードの一意の識別子。
• PerformanceMeasureWeight: integer (int64)
  タイトル: Weight

  デフォルト値: 100

  パフォーマンス・メジャーがプラン・コンポーネントに与える影響の割合。
• PlanComponentId: integer (int64)
  タイトル: Plan Component ID

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。

{
    "type":"object",
    "properties":{
        "PerformanceMeasureWeight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "default":100,
            "x-hints":{
                "precision":18
            }
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":1,
            "type":"string",
            "description":"Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. \nKeep it Y, references the performance measure attainment in the incentive formula expression of the plan component. \nEarning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":9
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : planComponents-planComponentPerformanceMeasures-item-response

タイプ: object

ソースを表示

• CalculationSequence: 整数(int32)
  タイトル: Calculation Sequence

  デフォルト値: 1

  プラン・コンポーネント内のパフォーマンス・メジャーが計算エンジンで考慮される順序。 これは、依存メジャーが他の基準メジャーの計算結果を参照する場合に設定されます。 依存メジャーは、基準メジャーよりも高い計算順序にする必要があります。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• EarningBasis: string
  タイトル: Earning Basis

  最大長: 1

  デフォルト値: Y

  達成計算と支給計算で同じクレジット・カテゴリを使用するかどうか、およびインセンティブ算式で計算にメジャー達成を使用するかどうかを指定します。 使用可能な値はY、Nです。 Yのままにして、プラン・コンポーネントのインセンティブ算式でパフォーマンス・メジャー達成を参照します。 トランザクションを個別に処理するパフォーマンス・メジャーが、イベントごとにインセンティブを計算するプラン・コンポーネントに関連付けられている場合、支給基準はYである必要があります。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• EndDate: 文字列(日付)
  タイトル: End Date

  読取り専用: true

  パフォーマンス・メジャーに関連付けられたパフォーマンス・メジャーが非アクティブになる日付。 これは読取り専用フィールドです。 パフォーマンス・メジャーは、プラン・コンポーネントの日付を取得します。 書式はyyyy-mm-ddです。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• PerformanceInterval: string
  タイトル: Performance Interval

  読取り専用: true

  デフォルト値: -1000

  これはパフォーマンス測定の間隔値です。 累計が考慮される場合は、この間隔値に基づいて累計値がリセットされます。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。
• PerformanceMeasureId: integer (int64)
  タイトル: Performance Measure ID

  パフォーマンス・メジャー・レコードの一意の識別子。
• PerformanceMeasureName: string
  タイトル: Performance Measure Name

  読取り専用: true

  最大長: 80

  パフォーマンス・メジャーの名前。指定した結果または目標に対する進捗を測定するために使用されるインジケータです。
• PerformanceMeasureWeight: integer (int64)
  タイトル: Weight

  デフォルト値: 100

  パフォーマンス・メジャーがプラン・コンポーネントに与える影響の割合。
• PlanComponentId: integer (int64)
  タイトル: Plan Component ID

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
• PlanComponentName: string
  タイトル: Plan Component Name

  読取り専用: true

  最大長: 80

  プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。
• PlanComponentPerformanceMeasureId: integer (int64)
  プラン・コンポーネントに関連付けられたパフォーマンス・メジャー・レコードの一意の識別子です。
• ProcessTransactions: string
  タイトル: Process Transactions

  読取り専用: true

  最大長: 30

  メジャーでのトランザクションの処理方法を示します。 指定可能な値には、達成計算のためのグループ・トランザクションのGROUP、達成計算のためのINDIVIDUAL、達成計算のための各トランザクションの個別評価のためのINDIVIDUALが含まれます。 許容可能な値のリストは、参照CN_PROCESS_TXNで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• StartDate: 文字列(日付)
  タイトル: Start Date

  読取り専用: true

  パフォーマンス・メジャーに関連付けられたパフォーマンス・メジャーがアクティブになる日付。 これは読取り専用フィールドです。 パフォーマンス・メジャーは、プラン・コンポーネントの日付を取得します。 書式はyyyy-mm-ddです。
• UnitOfMeasure: string
  タイトル: Unit of Measure

  読取り専用: true

  最大長: 30

  デフォルト値: AMOUNT

  パフォーマンス・メジャー・プロパティの発生数量を表すファクタとして使用される標準化された数量。 可能な値には、メジャー達成のAMOUNTは金額に基づき、メジャー達成のPERCENTはパーセントに基づき、メジャー達成のQUANTITYは数量に基づき、メジャー達成のSCOREはスコアに基づきます。 デフォルト値はAMOUNTです。 許容可能な値のリストは、参照CN_MEASURE_UOMで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• ValidForCalculation: string
  タイトル: Valid for Calculation

  読取り専用: true

  最大長: 30

  デフォルト値: INCOMPLETE

  パフォーマンス・メジャーの計算準備が完了しているかどうかを示します。 可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_COMP_PLAN_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceInterval":{
            "title":"Performance Interval",
            "type":"string",
            "description":"This is the interval value  for the performance measurement. Where running total is considered, the accumulated value is reset based on this interval value. \nInterval would represent a unit of time like month, quarter, year. The default value is '-1000'.",
            "nullable":true,
            "readOnly":true,
            "default":"-1000",
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Performance Measure Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "default":"AMOUNT",
            "x-queryable":true
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the performance measure is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for invalid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_COMP_PLAN_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INCOMPLETE",
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the performance measure associated with the performance measure becomes inactive. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the performance measure associated with the performance measure becomes active. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureWeight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "default":100,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":1,
            "type":"string",
            "description":"Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. \nKeep it Y, references the performance measure attainment in the incentive formula expression of the plan component. \nEarning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the performance measure record associated with the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessTransactions":{
            "title":"Process Transactions",
            "maxLength":30,
            "type":"string",
            "description":"Indicates how the application processes transactions in a measure. The possible values include GROUP for Group transactions for the specified interval, for attainment calculation and INDIVIDUAL for evaluating each transaction independently, for attainment calculation. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "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."
        }
    }
}

リンク

CnLookupYesNoVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_YES_NO

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

PerformanceMeasureFormulaVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures

パフォーマンス・メジャー・リソースは、パフォーマンス・メジャーの表示、作成、更新および削除に使用されます。 また、パフォーマンス・メジャーのすべての詳細を表示するために使用することもできます。 パフォーマンス・メジャーは、参加者の達成度の決定です。 これには、目標/ターゲット、適格基準、メジャー算式およびスコア・カードを含めることができます。 新しいパフォーマンス・メジャーは、インセンティブ算式(出力式)を使用して、クレジット・カテゴリ(クレジット・ファクタおよびトランザクション・ファクタの有無にかかわらず)を使用して、スコア・カード(レート・ディメンション入力式なし)を使用して、5つの異なる方法で作成できます - この入力式は、スコア・カードが割り当てられた後、または前述の任意の組合せを使用して、またはパフォーマンス・メジャーのみが作成される(他のコンポーネントとの関連付けは個別に実行する必要がある)場合にのみ割り当てる必要があります パフォーマンス・メジャーを作成すると、目標、間隔目標および期間目標がデフォルト値0で作成されます。 その後、ユーザーは目標合計または期間目標を更新できます。

「トップに戻る」