すべてのプラン・コンポーネントの取得
get
/fscmRestApi/resources/11.13.18.05/planComponents
リクエスト
問合せパラメータ
- expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 指定された主キーを持つリソースを検索します。
ファインダ変数:- OrgId; integer;ビジネス・ユニットの一意の識別子。
- PlanComponentId; integer; ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
- PrimaryKey : 指定された主キーを持つリソースを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CalculateIncentive; string;イベントごとまたは間隔ごとのプラン・コンポーネントの支給計算の性質。 イベントごとに、適格なクレジットがあるたびに収益が生成されることを示します。 間隔ごとは、間隔のすべての適格クレジットが集計され、その間隔に対して1つの支給が生成されることを示します。 指定可能な値には、イベントごとにCOMMISSION、間隔ごとにBONUSがあります。 許容可能な値のリストは、参照CN_PLAN_INCENTIVE_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- CalculationPhase; integer;アプリケーションで計算のためにプラン・コンポーネントが考慮されるフェーズ。 サポートされている2つのフェーズ: フェーズ1およびフェーズ2。 取り得る値は1と2です。デフォルト値は1です。 許容可能な値のリストは、参照CN_CALCULATION_PHASEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- 摘要;文字列;プラン・コンポーネントに関連するユーザーが追加した追加詳細。
- DisplayName; string; このプラン・コンポーネントを表すために、営業担当ユーザー・インタフェース画面に表示されるプラン・コンポーネントのオプション名。
- EarningType; number;支給を通貨カテゴリおよび非通貨カテゴリに分類するために使用する属性。 可能な値は、金銭的な利益、ポイント、航空マイルを表します。 この値はOrgIdに依存するため、OrgId値の後に渡す必要があります。 デフォルト値は金銭支給 ('-1000')です。
- EndDate; string; プラン・コンポーネントが非アクティブになる日付。 書式はyyyy-mm-ddです。
- IncentiveType;文字列。ボーナスやコミッションなどのインセンティブ・タイプを表す属性。 指定可能な値には、BONUS、COMMISSIONおよびSTANDARDがあります。 許容可能な値のリストは、参照CN_REPORT_GROUPで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- InvalidReason; string; プラン・コンポーネントが無効な理由を説明する理由。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのセッション・ログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- 名前、文字列。パフォーマンスに基づいて参加者の支給を定義するプラン・コンポーネントの名前。
- NumberOfDimensions; integer; プラン・コンポーネントで使用されるレート表のディメンションの数。
- OrgId; integer;ビジネス・ユニットの一意の識別子。
- PaymentMadeThroughThirdPartyFlag; boolean;このプラン・コンポーネントの支払を他のリソースから行うことができるかどうかを示します。 取り得る値は、N、FALSE、YまたはTRUEです。 デフォルト値はFALSEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- PaymentPlanCategory;文字列。プラン・コンポーネント間で参加者の支払プランから支払調整を配賦するために使用される支払プラン・カテゴリ。 可能な値には、提供されるサービスの報酬月額、販売された製品、または追加の業績に対する報酬額のCOMMISSION、提供されるサービスや販売された製品に対する報酬額のCOMMISSION、販売者に報奨する一般的な方法、保証対象特定の期間にコミッション営業担当が受け取ることが保証される最小金額と、支払プラン調整の決定に使用されるプラン・コンポーネントに適用される一般条件であるSTANDARDです。 デフォルト値はSTANDARDです。 許容可能な値のリストは、参照CN_PAYMENT_PLAN_CATEGORYで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- PlanComponentId; integer; ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
- SplitOption; string; 入力番号をレート表ディメンションに分割する方法を示します。 可能な値には、達成全体に単一のレートを適用するNONE、階層内の達成に対して固定される複数のレートを適用するNON PROPORTIONAL、階層内の達成に対して比例する複数のレートを適用するPROPORTIONALなどがあります。 デフォルト値はNONEです。 許容可能な値のリストは、参照CN_SPLIT_TYPE_OPTIONで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- StartDate; string; プラン・コンポーネントがアクティブになる日付。 書式はyyyy-mm-ddです。
- ValidForCalculation; string; プラン・コンポーネントの計算準備が完了しているかどうかを示します。 可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_FORMULA_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : planComponents
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : planComponents-item-response
タイプ:
ソースを表示
object
-
CalculateIncentive: string
タイトル:
Calculate Incentive
最大長:30
イベントごとまたは間隔ごとのプラン・コンポーネント支給計算の性質。 イベントごとに、適格なクレジットがあるたびに収益が生成されることを示します。 間隔ごとは、間隔のすべての適格クレジットが集計され、その間隔に対して1つの支給が生成されることを示します。 指定可能な値には、イベントごとにCOMMISSION、間隔ごとにBONUSがあります。 許容可能な値のリストは、参照CN_PLAN_INCENTIVE_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CalculationPhase: 整数(int32)
タイトル:
Calculation Phase
デフォルト値:1
アプリケーションでプラン・コンポーネントが計算対象とみなされるフェーズ。 サポートされている2つのフェーズ: フェーズ1およびフェーズ2。 取り得る値は1と2です。デフォルト値は1です。 許容可能な値のリストは、参照CN_CALCULATION_PHASEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
Description: string
タイトル:
Description
最大長:1000
プラン・コンポーネントに関連するユーザーが追加した追加詳細。 -
DisplayName: string
タイトル:
Display Name
最大長:80
このプラン・コンポーネントを表すために営業担当ユーザー・インタフェース画面に表示されるプラン・コンポーネントのオプション名。 -
EarningType: number
タイトル:
Earning Type
デフォルト値:-1000
支給項目を通貨カテゴリおよび非通貨カテゴリに分類するために使用する属性です。 可能な値は、金銭的な利益、ポイント、航空マイルを表します。 この値はOrgIdに依存するため、OrgId値の後に渡す必要があります。 デフォルト値は金銭支給 ('-1000')です。 -
EndDate: 文字列(日付)
タイトル:
End Date
プラン・コンポーネントが非アクティブになる日付。 書式はyyyy-mm-ddです。 -
IncentiveType: string
タイトル:
Incentive Type
最大長:30
賞与やコミッションなど、インセンティブ・タイプを表す属性。 指定可能な値には、BONUS、COMMISSIONおよびSTANDARDがあります。 許容可能な値のリストは、参照CN_REPORT_GROUPで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
InvalidReason: string
タイトル:
Reason
読取り専用:true
プラン・コンポーネントが無効な理由を説明する事由。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのセッション・ログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Plan Component Name
最大長:80
プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。 -
NumberOfDimensions: integer
タイトル:
Number of Dimensions
読取り専用:true
プラン・コンポーネントで使用されるレート表のディメンション数。 -
OrgId: integer (int64)
タイトル:
Business Unit
ビジネス・ユニットの一意の識別子。 -
PaymentMadeThroughThirdPartyFlag: boolean
タイトル:
Payment Made Through Third Party
最大長:1
デフォルト値:false
このプラン・コンポーネントの支払を他のリソースから実行できるかどうかを示します。 取り得る値は、N、FALSE、YまたはTRUEです。 デフォルト値はFALSEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
PaymentPlanCategory: string
タイトル:
Payment Plan Category
最大長:30
デフォルト値:STANDARD
プラン・コンポーネント間で参加者の支払プランから支払調整を配賦するために使用される支払プラン・カテゴリです。 可能な値には、提供されるサービスの報酬月額、販売された製品、または追加の業績に対する報酬額のCOMMISSION、提供されるサービスや販売された製品に対する報酬額のCOMMISSION、販売者に報奨する一般的な方法、保証対象特定の期間にコミッション営業担当が受け取ることが保証される最小金額と、支払プラン調整の決定に使用されるプラン・コンポーネントに適用される一般条件であるSTANDARDです。 デフォルト値はSTANDARDです。 許容可能な値のリストは、参照CN_PAYMENT_PLAN_CATEGORYで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
PlanComponentId: integer (int64)
タイトル:
Plan Component ID
ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。 -
planComponentIncentiveFormulas: array Plan Component - Incentive Formulas
タイトル:
Plan Component - Incentive Formulas
プラン・コンポーネント - インセンティブ算式リソースは、インセンティブ算式のプラン・コンポーネントへの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられたインセンティブ算式のすべての詳細を表示するために使用することもできます。 このレコードでは、支給の計算に使用するフォーミュラを指定し、このレベルの追加詳細を提供します。 これは、プラン・コンポーネントが作成され、後で更新する必要がある場合に、値なしで自動的に作成されます。 -
planComponentPerformanceMeasures: array Plan Component - Performance Measures
タイトル:
Plan Component - Performance Measures
プラン・コンポーネント - パフォーマンス・メジャー・リソースは、パフォーマンス・メジャーとプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、プラン・コンポーネントでパフォーマンス・メジャーのすべての詳細を表示するために使用することもできます。 プラン・コンポーネント - パフォーマンス・メジャー・レコードは、パフォーマンス・メジャーをプラン・コンポーネントにリンクし、このレベルで追加詳細を提供します。 このレコードを作成する前に、パフォーマンス・メジャーが存在している必要があります。 -
planComponentsDFF: array Plan Component Descriptive Flex Fields
タイトル:
Plan Component Descriptive Flex Fields
プラン・コンポーネント - 付加フレックスフィールド・リソースは、プラン・コンポーネントのユーザー定義値の格納に使用されます。 新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。 -
SplitOption: string
タイトル:
Split Option
入力番号をレート表ディメンションに分割する方法を示します。 可能な値には、達成全体に単一のレートを適用するNONE、階層内の達成に対して固定される複数のレートを適用するNON PROPORTIONAL、階層内の達成に対して比例する複数のレートを適用するPROPORTIONALなどがあります。 デフォルト値はNONEです。 許容可能な値のリストは、参照CN_SPLIT_TYPE_OPTIONで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
StartDate: 文字列(日付)
タイトル:
Start Date
プラン・コンポーネントがアクティブになる日付。 書式はyyyy-mm-ddです。 -
ValidForCalculation: string
タイトル:
Valid for Calculation
最大長:30
デフォルト値:INCOMPLETE
プラン・コンポーネントの計算準備が完了しているかどうかを示します。 可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_FORMULA_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ネストされたスキーマ : プラン・コンポーネント - インセンティブ算式
タイプ:
array
タイトル:
Plan Component - Incentive Formulas
プラン・コンポーネント - インセンティブ算式リソースは、インセンティブ算式のプラン・コンポーネントへの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられたインセンティブ算式のすべての詳細を表示するために使用することもできます。 このレコードでは、支給の計算に使用するフォーミュラを指定し、このレベルの追加詳細を提供します。 これは、プラン・コンポーネントが作成され、後で更新する必要がある場合に、値なしで自動的に作成されます。
ソースを表示
ネストされたスキーマ : プラン・コンポーネント - パフォーマンス・メジャー
タイプ:
array
タイトル:
Plan Component - Performance Measures
プラン・コンポーネント - パフォーマンス・メジャー・リソースは、パフォーマンス・メジャーとプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、プラン・コンポーネントでパフォーマンス・メジャーのすべての詳細を表示するために使用することもできます。 プラン・コンポーネント - パフォーマンス・メジャー・レコードは、パフォーマンス・メジャーをプラン・コンポーネントにリンクし、このレベルで追加詳細を提供します。 このレコードを作成する前に、パフォーマンス・メジャーが存在している必要があります。
ソースを表示
ネストされたスキーマ : プラン・コンポーネント付加フレックスフィールド
タイプ:
array
タイトル:
Plan Component Descriptive Flex Fields
プラン・コンポーネント - 付加フレックスフィールド・リソースは、プラン・コンポーネントのユーザー定義値の格納に使用されます。 新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-item-response
タイプ:
ソースを表示
object
-
CalculateEnddateParticipantFlag: boolean
タイトル:
Calculate end-dated participants
現在の計算期間より前に終了日を持つ参加者が計算の対象となるかどうかを示します。 取り得る値はFALSEとTRUEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 これは、「インセンティブの計算」フィールドが間隔ごと(BONUS)の場合にのみ適用されます。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
IncentiveFormulaExpressionDescription: string
タイトル:
Expression Description
読取り専用:true
最大長:1000
プラン・コンポーネント・インセンティブ算式に関連するユーザーが追加した追加詳細。 -
IncentiveFormulaExpressionId: integer (int64)
タイトル:
Output Expression ID
インセンティブ算式で使用される式レコードの一意の識別子。 支給の計算に使用される式です。 -
IncentiveFormulaExpressionName: string
タイトル:
Expression Name
最大長:160
インセンティブ算式で使用される式の名前。 支給の計算に使用される式です。 -
IncentiveFormulaId: integer (int64)
インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
-
IncludeIndirectCredits: string
タイトル:
Include Indirect Credits
プラン・コンポーネントの計算に含める間接クレジットのタイプ。 可能な値は、このプラン・コンポーネントの達成または支給計算に含まれるすべての間接クレジットに対してALL、このプランの達成または支給計算に含められる積上間接クレジットのみのMGRですこのプラン・コンポーネントの達成または支給計算に含められる間接クレジットがない場合はなし、このプラン・コンポーネントの達成または支給計算に含められるチーム間接クレジットのみの場合はチーム。 デフォルト値はNONEです。 受理可能な値のリストは、参照CN_PLAN_INDIRECT_CREDITで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのセッション・ログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PayoutFrequency: string
タイトル:
Payout Frequency
デフォルト値:-1000
支給が計算される頻度を決定する間隔値です。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。 -
PlanComponentId: integer (int64)
タイトル:
Plan Component ID
読取り専用:true
ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。 -
PlanComponentIncentiveFormulaId: integer (int64)
読取り専用:
true
プラン・コンポーネントのインセンティブ算式レコードの一意の識別子。 -
PlanComponentIncentiveFormulasDeleteFlag: boolean
読取り専用:
true
デフォルト値:false
プラン・コンポーネント・インセンティブ算式を削除できるかどうかを示します。 -
planComponentRateDimensionalInputs: array Plan Component - Rate Dimensional Input Expressions
タイトル:
Plan Component - Rate Dimensional Input Expressions
プラン・コンポーネント - レート・ディメンション入力式リソースは、入力式とプラン・コンポーネントの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられた入力式のすべての詳細を表示するために使用することもできます。 このレコードは、レート表のレート・ディメンションの入力を指定し、このレベルの追加詳細を提供します。 このレコードを作成する前に、有効な使用方法もある有効な式が存在する必要があります。 レート表が割り当てられた後にのみ、入力式を割り当てる必要があります。 -
planComponentRateTables: array Plan Component - Rate Tables
タイトル:
Plan Component - Rate Tables
プラン・コンポーネント - レート表リソースは、レート表とプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、パフォーマンス・メジャーに関連付けられたレート表のすべての詳細を表示するために使用することもできます。 このレコードは、レート表をパフォーマンス・メジャーにリンクし、このレベルの追加詳細を提供します。 このレコードを作成する前に、レート表が存在する必要があります。 レート表関連は、インセンティブ算式が作成された後にのみ作成できます。 -
RenderedIncentiveFormulaExpression: 文字列(バイト)
タイトル:
Rendered Expression
読取り専用:true
演算子、属性、関数などのすべての式コンポーネントを含むインセンティブ算式全体。これは、主に式全体を表示するために使用されます。 -
ResetInterval: integer (int64)
タイトル:
Reset Interval
調整支給または累積支給が計算される期間です。 間隔は、月、四半期、年などの時間の単位を表します。 これは、True UpがYの場合にのみ適用されます。 -
TrueUpFlag: boolean
タイトル:
True up
最大長:1
当期間に対して計算された支給に、以前に計算された金額または支払金額(累積)が含まれているかどうかを示します 計算エンジンは、現在の計算済支給項目から前の支給項目を自動的に減算します。 取り得る値はFALSEとTRUEです。
ネストされたスキーマ : プラン・コンポーネント - レート・ディメンション入力式
タイプ:
array
タイトル:
Plan Component - Rate Dimensional Input Expressions
プラン・コンポーネント - レート・ディメンション入力式リソースは、入力式とプラン・コンポーネントの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられた入力式のすべての詳細を表示するために使用することもできます。 このレコードは、レート表のレート・ディメンションの入力を指定し、このレベルの追加詳細を提供します。 このレコードを作成する前に、有効な使用方法もある有効な式が存在する必要があります。 レート表が割り当てられた後にのみ、入力式を割り当てる必要があります。
ソースを表示
ネストされたスキーマ : プラン・コンポーネント - レート表
タイプ:
array
タイトル:
Plan Component - Rate Tables
プラン・コンポーネント - レート表リソースは、レート表とプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、パフォーマンス・メジャーに関連付けられたレート表のすべての詳細を表示するために使用することもできます。 このレコードは、レート表をパフォーマンス・メジャーにリンクし、このレベルの追加詳細を提供します。 このレコードを作成する前に、レート表が存在する必要があります。 レート表関連は、インセンティブ算式が作成された後にのみ作成できます。
ソースを表示
ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
IncentiveFormulaId: integer (int64)
タイトル:
Incentive Formula ID
インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。 -
InputExpressionDescription: string
タイトル:
Input Expression Description
読取り専用:true
最大長:1000
式の作成時に入力された入力式の説明。 -
InputExpressionId: integer (int64)
タイトル:
Input Expression ID
レート表のレート・ディメンションの入力式の一意の識別子。 -
InputExpressionName: string
タイトル:
Input Expression Name
最大長:160
プラン・コンポーネントで使用されるレート表のレート・ディメンションの入力式の名前。 入力式は、トランザクションから評価する値を制御し、結果と対応するレート表ディメンションを照合します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのセッション・ログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PlanComponentId: integer
読取り専用:
true
ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。 -
PlanComponentInputExpressionId: integer (int64)
タイトル:
Plan Component Input Expression Id
プラン・コンポーネントの入力式レコードの一意の識別子。 -
PlanComponentRateDimensionalInputsDeleteFlag: boolean
読取り専用:
true
デフォルト値:false
レート・ディメンション入力を削除できるかどうかを示します。 -
RateDimName: integer
タイトル:
Dimension Name
読取り専用:true
レート・ディメンションの名前。 レート表には、1つ以上のレート・ディメンションを含めることができます。 -
RateDimSequence: integer (int64)
タイトル:
Sequence
レート表の入力式の順序。 -
SplitFlag: boolean
タイトル:
Split
最大長:1
デフォルト値:false
レートを階層間で分割する場合、分割オプションは1つのレート・ディメンション入力式にのみ適用できます。 使用するレート・ディメンション入力式(レート・ディメンション)を指定します。 可能な値はFALSEおよびTRUEです。 デフォルト値はFALSEです。
ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
EndDate: 文字列(日付)
タイトル:
End Date
レート表がプラン・コンポーネントに対して非アクティブになる日付。 書式はyyyy-mm-ddです。 -
IncentiveFormulaId: integer (int64)
タイトル:
Incentive Formula ID
インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのセッション・ログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PlanComponentId: integer
読取り専用:
true
ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。 -
PlanComponentName: string
タイトル:
Plan Component Name
読取り専用:true
プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。 -
PlanComponentRateTableId: integer (int64)
プラン・コンポーネントに関連付けられたレート表の一意の識別子。
-
RateTableDescription: string
タイトル:
Description
読取り専用:true
最大長:1000
レート表の名称。 -
RateTableId: integer (int64)
タイトル:
Rate Table ID
レート表の一意の識別子。 -
RateTableName: string
タイトル:
Rate Table Name
最大長:80
レート表の名前。 レート表は、さまざまなパフォーマンス・レベルに対して給与比率レートや固定額を設定するために使用します。 -
StartDate: 文字列(日付)
タイトル:
Start Date
レート表がプラン・コンポーネントに対してアクティブになる日付。 書式はyyyy-mm-ddです。
ネストされたスキーマ : 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で定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ネストされたスキーマ : planComponents-planComponentsDFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Context Segment
最大長:30
このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント・コードを表します。 どのコンテキスト依存セグメントを表示するかを決定します。 -
__FLEX_Context_DisplayValue: string
タイトル:
Context Segment
このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント表示名を表します。 どのコンテキスト依存セグメントを表示するかを決定します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrgId: integer (int64)
タイトル:
Business Unit
ビジネス・ユニット組織の一意の識別子。 -
PlanComponentId: integer (int64)
ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのプラン・コンポーネントを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "PlanComponentId": 300100018351968, "Name": "QA BAT Bonus Plan_FY13-14", "Description": "dd", "CalculateIncentive": "BONUS", "OrgId": 204, "EarningType": -1000, "StartDate": "2013-01-01", "EndDate": "2014-12-31", "CalculationPhase": 1, "IncentiveType": "BONUS", "PaymentPlanCategory": "STANDARD", "PaymentMadeThroughThirdPartyFlag": false, "LastUpdateDate": "2017-06-07T08:48:01.356-07:00", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2013-01-08T00:38:22.822-08:00", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "LastUpdateLogin": "5160681C1F314D39E0532DD6F00A08CA", "DisplayName": "QA BAT Bonus Plan_FY13-14", "ValidForCalculation": "INCOMPLETE", "InvalidReason": "The performance measure 300100090063848 associated with this plan component is not valid for calculation. (CN-1575359) Details: Make the performance measure valid for calculation or associate a valid performance measure with this plan component to make it valid.", "SplitOption": "NONE", "NumberOfDimensions": 1, "links": [ ... ] }, { "PlanComponentId": 300100031848898, "Name": "GNQA BAT Bonus Plan_FY13-14", "Description": null, "CalculateIncentive": "BONUS", "OrgId": 204, "EarningType": -1000, "StartDate": "2013-01-01", "EndDate": "2014-12-31", "CalculationPhase": 1, "IncentiveType": "BONUS", "PaymentPlanCategory": "STANDARD", "PaymentMadeThroughThirdPartyFlag": false, "LastUpdateDate": "2014-01-06T16:23:29.709-08:00", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2014-01-06T16:23:21.817-08:00", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "LastUpdateLogin": "EF57614BDBB34C8CE0432720F00A1090", "DisplayName": "GNQA BAT Bonus Plan_FY13-14", "ValidForCalculation": "COMPLETE", "InvalidReason": null, "SplitOption": "NONE", "NumberOfDimensions": 1, "links": [ ... ] }, ], ... ] }