すべてのプラン・コンポーネントの取得
get
/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents
リクエスト
パス・パラメータ
- CompensationPlanId(required): integer(int64)
報酬プランの一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - 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 : 指定した主キーを持つプラン・コンポーネントを検索します。
ファインダ変数:- CompensationPlanComponentId; 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; プラン・コンポーネントの支給計算の性質がイベントごとか間隔ごとかを示します。 指定可能な値には、間隔ごとにBONUS、イベントごとにCOMMISSIONがあります。 これは、プラン・コンポーネントの作成後は更新できません。 許容可能な値のリストは、参照CN_PLAN_INCENTIVE_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- CalculationPhase; integer;アプリケーションで計算のためにプラン・コンポーネントが考慮されるフェーズ。 サポートされている2つのフェーズ: フェーズ1およびフェーズ2。 取り得る値は1と2です。 デフォルト値は、1です。 許容可能な値のリストは、参照CN_CALCULATION_PHASEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- CalculationSequence; integer;計算エンジンで報酬プラン内のプラン・コンポーネントが考慮される順序を示します。 デフォルト値は、1です。
- CompensationPlanComponentId; integer;報酬プランに関連付けられたプラン・コンポーネントの一意の識別子。
- CompensationPlanId; integer;報酬プランの一意の識別子。
- CompensationPlanName; string;報酬プランの名前。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- EndDate; string;報酬プランに関連付けられたプラン・コンポーネントが非アクティブになる日時。 このフィールドは必須です。 許容可能な書式はyyyy-mm-ddです。 日付を割り当てた後は、NULLに更新できません。
- LastUpdateDate; string; レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
- LastUpdateLogin; string; レコードが最後に更新された日付。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- PlanComponentId; integer;プラン・コンポーネントの一意の識別子。
- PlanComponentName; string;プラン・コンポーネントの名前。
- PlanComponentValidForCalculation; string; プラン・コンポーネントの計算準備が完了しているかどうかを示します。 可能な値には、プラン・コンポーネントが有効で計算の準備ができている場合はCOMPLETE、計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_FORMULA_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- StartDate; string;報酬プランに関連付けられたプラン・コンポーネントがアクティブになる日時。 このフィールドは必須です。 許容可能な書式はyyyy-mm-ddです。 日付を割り当てた後は、NULLに更新できません。
- TargetIncentiveAmount; number;重みと報酬プラン・ターゲット・インセンティブを乗算して導出される各プラン・コンポーネントの金額。
- TargetIncentivePercent; number;プラン・コンポーネントが報酬プランに与える影響の割合。 デフォルト値は100です。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : compensationPlans-CompensationPlanComponents
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : compensationPlans-CompensationPlanComponents-item-response
タイプ:
ソースを表示
object
-
CalculateIncentive: string
タイトル:
Calculate Incentive
読取り専用:true
最大長:30
プラン・コンポーネントの支給計算の性質がイベントごとか間隔ごとかを示します。 指定可能な値には、間隔ごとにBONUS、イベントごとにCOMMISSIONがあります。 これは、プラン・コンポーネントの作成後は更新できません。 許容可能な値のリストは、参照CN_PLAN_INCENTIVE_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CalculationPhase: 整数(int32)
タイトル:
Calculation Phase
読取り専用:true
アプリケーションでプラン・コンポーネントが計算対象とみなされるフェーズ。 サポートされている2つのフェーズ: フェーズ1およびフェーズ2。 取り得る値は1と2です。 デフォルト値は、1です。 許容可能な値のリストは、参照CN_CALCULATION_PHASEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CalculationSequence: integer (int64)
タイトル:
Calculation Sequence
デフォルト値:1
報酬プラン内のプラン・コンポーネントが計算エンジンによって考慮される順序を示します。 デフォルト値は、1です。 -
CompensationPlanComponentId: integer (int64)
報酬プランに関連付けられたプラン・コンポーネントの一意の識別子です。
-
CompensationPlanId: integer (int64)
タイトル:
Compensation Plan ID
報酬プランの一意の識別子です。 -
CompensationPlanName: string
タイトル:
Compensation Plan Name
読取り専用:true
最大長:80
報酬プランの名前。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
EndDate: 文字列(日付)
タイトル:
End Date
報酬プランに関連付けられたプラン・コンポーネントが非アクティブになる日時。 このフィールドは必須です。 許容可能な書式はyyyy-mm-ddです。 日付を割り当てた後は、NULLに更新できません。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
PlanComponentId: integer (int64)
タイトル:
Plan Component ID
プラン・コンポーネントの一意の識別子。 -
PlanComponentName: string
タイトル:
Plan Component Name
読取り専用:true
最大長:80
プラン・コンポーネントの名前。 -
PlanComponentValidForCalculation: string
タイトル:
Valid for Calculation
読取り専用:true
最大長:30
デフォルト値:INCOMPLETE
プラン・コンポーネントの計算準備が完了しているかどうかを示します。 可能な値には、プラン・コンポーネントが有効で計算の準備ができている場合はCOMPLETE、計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_FORMULA_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
StartDate: 文字列(日付)
タイトル:
Start Date
報酬プランに関連付けられたプラン・コンポーネントがアクティブになる日時。 このフィールドは必須です。 許容可能な書式はyyyy-mm-ddです。 日付を割り当てた後は、NULLに更新できません。 -
TargetIncentiveAmount: number
タイトル:
Target Incentive Amount
読取り専用:true
デフォルト値:100
加重と報酬プラン・ターゲット・インセンティブを乗算して導出された各プラン・コンポーネントの金額。 -
TargetIncentivePercent: number
タイトル:
Target Incentive Percent
デフォルト値:100
プラン・コンポーネントが報酬プランに与える影響のパーセント。 デフォルト値は100です。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのプラン・コンポーネントを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/compensationPlans/300100090306794/child/compensationPlanComponents
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "PlanComponentId": 300100085059410, "CalculationSequence": 1, "TargetIncentivePercent": 90, "StartDate": "2016-01-01", "EndDate": "2016-12-31", "CalculationPhase": 1, "CalculateIncentive": "BONUS", "PlanComponentValidForCalculation": "COMPLETE", "PlanComponentName": "2016 QA calc scenario 800 PC", "TargetIncentiveAmount": 9000, "CompensationPlanComponentId": 300100090480156, "CompensationPlanId": 300100090306794, "CompensationPlanName": "Silver Inc Plan", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-07T07:52:52-07:00", "LastUpdateDate": "2017-06-07T07:58:01.058-07:00", "LastUpdateLogin": "5160681C1C454D39E0532DD6F00A08CA", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ ... ] }, ...