機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. プラン・コンポーネント
  4. プラン・コンポーネント - インセンティブ算式

すべてのインセンティブ算式の取得

get

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas

リクエスト

パス・パラメータ
  • これは、プラン・コンポーネント・リソースのコンポジット・キー(PlanComponentIdおよびOrgId)を構成する属性のハッシュ・キーで、プラン・コンポーネントのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、プラン・コンポーネントの特定のインスタンスに移動するために、主キー値に対するフィルタを使用してプラン・コンポーネント・コレクション・リソースを問い合せる必要があります。

    次に例を示します: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定された主キーを持つリソースを検索します。
      ファインダ変数:
      • IncentiveFormulaId; integer;インセンティブ算式レコードの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CalculateEnddateParticipantFlag; boolean;現在の計算期間より前の終了日を持つ参加者が計算対象とみなされるかどうかを示します。 取り得る値はFALSEとTRUEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 これは、「インセンティブの計算」フィールドが間隔ごと(BONUS)の場合にのみ適用されます。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string; レコードが作成された日時。
    • IncentiveFormulaExpressionDescription; string;プラン・コンポーネント・インセンティブ算式に関連するユーザーが追加した追加詳細。
    • IncentiveFormulaExpressionName; string;インセンティブ算式で使用される式の名前。 支給の計算に使用される式です。
    • IncentiveFormulaId; integer;インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのセッション・ログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • PayoutFrequency; string; 支給が計算される頻度を決定する間隔値です。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。
    • PlanComponentId; integer; ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
    • PlanComponentIncentiveFormulaId; integer; プラン・コンポーネントのインセンティブ算式レコードの一意の識別子。
    • ResetInterval; integer;これは、調整額または累積額の支給が計算される期間です。 間隔は、月、四半期、年などの時間の単位を表します。 これは、True UpがYの場合にのみ適用されます。
    • TrueUpFlag; boolean;現行期間に対して計算された支給項目に、以前に計算された金額または支払済金額(累積)が含まれているかどうかを示します 計算エンジンは、現在の計算済支給項目から前の支給項目を自動的に減算します。 取り得る値はFALSEとTRUEです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : planComponents-planComponentIncentiveFormulas
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-item-response
タイプ: object
ソースを表示
  • タイトル: Calculate end-dated participants
    現在の計算期間より前に終了日を持つ参加者が計算の対象となるかどうかを示します。 取り得る値はFALSEとTRUEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 これは、「インセンティブの計算」フィールドが間隔ごと(BONUS)の場合にのみ適用されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 255
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Expression Description
    読取り専用: true
    最大長: 1000
    プラン・コンポーネント・インセンティブ算式に関連するユーザーが追加した追加詳細。
  • タイトル: Output Expression ID
    インセンティブ算式で使用される式レコードの一意の識別子。 支給の計算に使用される式です。
  • タイトル: Expression Name
    最大長: 160
    インセンティブ算式で使用される式の名前。 支給の計算に使用される式です。
  • インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
  • タイトル: Include Indirect Credits
    プラン・コンポーネントの計算に含める間接クレジットのタイプ。 可能な値は、このプラン・コンポーネントの達成または支給計算に含まれるすべての間接クレジットに対してALL、このプランの達成または支給計算に含められる積上間接クレジットのみのMGRですこのプラン・コンポーネントの達成または支給計算に含められる間接クレジットがない場合はなし、このプラン・コンポーネントの達成または支給計算に含められるチーム間接クレジットのみの場合はチーム。 デフォルト値はNONEです。 受理可能な値のリストは、参照CN_PLAN_INDIRECT_CREDITで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 255
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのセッション・ログイン。
  • Links
  • タイトル: Payout Frequency
    デフォルト値: -1000
    支給が計算される頻度を決定する間隔値です。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。
  • タイトル: Plan Component ID
    読取り専用: true
    ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
  • 読取り専用: true
    プラン・コンポーネントのインセンティブ算式レコードの一意の識別子。
  • 読取り専用: true
    デフォルト値: false
    プラン・コンポーネント・インセンティブ算式を削除できるかどうかを示します。
  • Plan Component - Rate Dimensional Input Expressions
    タイトル: Plan Component - Rate Dimensional Input Expressions
    プラン・コンポーネント - レート・ディメンション入力式リソースは、入力式とプラン・コンポーネントの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられた入力式のすべての詳細を表示するために使用することもできます。 このレコードは、レート表のレート・ディメンションの入力を指定し、このレベルの追加詳細を提供します。 このレコードを作成する前に、有効な使用方法もある有効な式が存在する必要があります。 レート表が割り当てられた後にのみ、入力式を割り当てる必要があります。
  • Plan Component - Rate Tables
    タイトル: Plan Component - Rate Tables
    プラン・コンポーネント - レート表リソースは、レート表とプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、パフォーマンス・メジャーに関連付けられたレート表のすべての詳細を表示するために使用することもできます。 このレコードは、レート表をパフォーマンス・メジャーにリンクし、このレベルの追加詳細を提供します。 このレコードを作成する前に、レート表が存在する必要があります。 レート表関連は、インセンティブ算式が作成された後にのみ作成できます。
  • タイトル: Rendered Expression
    読取り専用: true
    演算子、属性、関数などのすべての式コンポーネントを含むインセンティブ算式全体。これは、主に式全体を表示するために使用されます。
  • タイトル: Reset Interval
    調整支給または累積支給が計算される期間です。 間隔は、月、四半期、年などの時間の単位を表します。 これは、True UpがYの場合にのみ適用されます。
  • タイトル: True up
    最大長: 1
    当期間に対して計算された支給に、以前に計算された金額または支払金額(累積)が含まれているかどうかを示します 計算エンジンは、現在の計算済支給項目から前の支給項目を自動的に減算します。 取り得る値はFALSEとTRUEです。
ネストされたスキーマ : プラン・コンポーネント - レート・ディメンション入力式
タイプ: array
タイトル: Plan Component - Rate Dimensional Input Expressions
プラン・コンポーネント - レート・ディメンション入力式リソースは、入力式とプラン・コンポーネントの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられた入力式のすべての詳細を表示するために使用することもできます。 このレコードは、レート表のレート・ディメンションの入力を指定し、このレベルの追加詳細を提供します。 このレコードを作成する前に、有効な使用方法もある有効な式が存在する必要があります。 レート表が割り当てられた後にのみ、入力式を割り当てる必要があります。
ソースを表示
ネストされたスキーマ : プラン・コンポーネント - レート表
タイプ: array
タイトル: Plan Component - Rate Tables
プラン・コンポーネント - レート表リソースは、レート表とプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、パフォーマンス・メジャーに関連付けられたレート表のすべての詳細を表示するために使用することもできます。 このレコードは、レート表をパフォーマンス・メジャーにリンクし、このレベルの追加詳細を提供します。 このレコードを作成する前に、レート表が存在する必要があります。 レート表関連は、インセンティブ算式が作成された後にのみ作成できます。
ソースを表示
ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 255
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Incentive Formula ID
    インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
  • タイトル: Input Expression Description
    読取り専用: true
    最大長: 1000
    式の作成時に入力された入力式の説明。
  • タイトル: Input Expression ID
    レート表のレート・ディメンションの入力式の一意の識別子。
  • タイトル: Input Expression Name
    最大長: 160
    プラン・コンポーネントで使用されるレート表のレート・ディメンションの入力式の名前。 入力式は、トランザクションから評価する値を制御し、結果と対応するレート表ディメンションを照合します。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 255
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのセッション・ログイン。
  • Links
  • 読取り専用: true
    ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
  • タイトル: Plan Component Input Expression Id
    プラン・コンポーネントの入力式レコードの一意の識別子。
  • 読取り専用: true
    デフォルト値: false
    レート・ディメンション入力を削除できるかどうかを示します。
  • タイトル: Dimension Name
    読取り専用: true
    レート・ディメンションの名前。 レート表には、1つ以上のレート・ディメンションを含めることができます。
  • タイトル: Sequence
    レート表の入力式の順序。
  • タイトル: Split
    最大長: 1
    デフォルト値: false
    レートを階層間で分割する場合、分割オプションは1つのレート・ディメンション入力式にのみ適用できます。 使用するレート・ディメンション入力式(レート・ディメンション)を指定します。 可能な値はFALSEおよびTRUEです。 デフォルト値はFALSEです。
ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 255
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: End Date
    レート表がプラン・コンポーネントに対して非アクティブになる日付。 書式はyyyy-mm-ddです。
  • タイトル: Incentive Formula ID
    インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 255
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのセッション・ログイン。
  • Links
  • 読取り専用: true
    ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
  • タイトル: Plan Component Name
    読取り専用: true
    プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。
  • プラン・コンポーネントに関連付けられたレート表の一意の識別子。
  • タイトル: Description
    読取り専用: true
    最大長: 1000
    レート表の名称。
  • タイトル: Rate Table ID
    レート表の一意の識別子。
  • タイトル: Rate Table Name
    最大長: 80
    レート表の名前。 レート表は、さまざまなパフォーマンス・レベルに対して給与比率レートや固定額を設定するために使用します。
  • タイトル: Start Date
    レート表がプラン・コンポーネントに対してアクティブになる日付。 書式はyyyy-mm-ddです。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのインセンティブ算式を取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC/ child/planComponentIncentiveFormulas

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "items": [
    {
      "IncentiveFormulaId": 300100090511052,
      "TrueUpFlag": true,
      "IncentiveFormulaExpressionId": 300100090511058,
      "IncentiveFormulaExpressionName": null,
      "PayoutFrequency": "-1000",
      "ResetInterval": -1000,
      "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "CreationDate": "2017-06-08T12:32:10.109-07:00",
      "LastUpdateDate": "2017-06-09T10:14:40.354-07:00",
      "LastUpdateLogin": "5182A4E294CD57DBE0532DD6F00A0C82",
      "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "IncentiveFormulaExpressionDescription": null,
      "IncludeIndirectCredits": "NONE",
      "CalculateEnddateParticipantFlag": true,
      "PlanComponentId": 300100090511050,
      "PlanComponentIncentiveFormulaId": 300100090511051,
      "PlanComponentIncentiveFormulasDeleteFlag": false,
      "links": [
        ...
      ]
    }
  ,
 ...
  ]
}
「トップに戻る」