すべての支払プラン割当の取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments
リクエスト
パス・パラメータ
- PaymentPlanId(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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- DirectAssignments : 支払プランが参加者に直接割り当てられるかどうかを示します。
ファインダ変数: - IndirectAssignments : 支払プランがロールを介して参加者に割り当てられるかどうかを示します。
ファインダ変数: - PrimaryKey : 指定した主キーを持つ支払プラン割当を検索します。
ファインダ変数:- ParticipantPaymentPlanId; integer;参加者支払プラン割当レコードの一意の識別子。
- DirectAssignments : 支払プランが参加者に直接割り当てられるかどうかを示します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AnalystId; integer; 支払プランに割り当てられたアナリストの一意の識別子。
- AnalystName; string; 支払プランに割り当てられたアナリストの名前。
- AssignmentType; string; 支払プランの割当タイプ。
- CreatedBy; string; 支払プラン割当を作成したユーザー。
- CreationDate; string; 支払プラン割当が作成された日時。
- EndDate; string; 支払プランの割当が非アクティブになる日付。 許容可能な書式はyyyy-mm-ddです。
- FlatMinimumAmount; number;支払間隔ごとに参加者に支払う最小金額。 支払プロセスでは、支払期間の支給合計が最小金額を下回ると、支払調整が作成されます。 この支払調整は、通常、前払金または保証された最小額と呼ばれます。
- LastUpdateDate; string; 支払プラン割当が最後に更新された日時。
- LastUpdatedBy; string; 支払プラン割当を最後に更新したユーザー。
- MaximumAmount; number;支払間隔で参加者に支払う最大金額。 支払期間の支給合計が最大金額を超えると、支払プロセスによって支払調整が作成されます。 この支払調整は、多くの場合、上限と呼ばれます。
- ParticipantId; integer;参加者の一意の識別子。
- ParticipantName; string;インセンティブ報酬の参加者の名前。
- ParticipantPaymentPlanId; integer; 支払プランの一意の識別子。
- PersonNumber; string; 企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。 国別識別子コンポーネントとの関連はありません。
- RecoveryEndDate; string;参加者による前払金の回収が終了する日付。
- RecoveryStartDate; string;参加者による前払金の回収が開始される日付。
- RoleId; integer; 支払プラン・ロールに対する一意の識別子。
- RoleName; string;ロールの名前。
- StartDate; string;割当がアクティブになる日付。 許容可能な書式はyyyy-mm-ddです。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationPaymentPlans-PaymentPlanAssignments
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response
タイプ:
ソースを表示
object
-
AnalystId: integer (int64)
タイトル:
Analyst
読取り専用:true
支払プランに割り当てられたアナリストの一意の識別子。 -
AnalystName: string
タイトル:
Analyst Name
読取り専用:true
最大長:360
支払プランに割り当てられたアナリストの名前。 -
AssignmentType: string
タイトル:
Assignment Type
読取り専用:true
支払プランのアサイメント・タイプ。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
支払プラン割当を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
支払プラン割当が作成された日時。 -
EndDate: 文字列(日付)
タイトル:
End Date
支払プランの割当が非アクティブになる日付。 許容可能な書式はyyyy-mm-ddです。 -
FlatMinimumAmount: number
タイトル:
Flat Minimum Amount to Pay Participant
支払間隔ごとに参加者に支払う最小金額。 支払プロセスでは、支払期間の支給合計が最小金額を下回ると、支払調整が作成されます。 この支払調整は、通常、前払金または保証された最小額と呼ばれます。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
支払プラン割当が最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
支払プラン割当を最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MaximumAmount: number
タイトル:
Maximum Payment
支払間隔の参加者に支払う最大金額。 支払期間の支給合計が最大金額を超えると、支払プロセスによって支払調整が作成されます。 この支払調整は、多くの場合、上限と呼ばれます。 -
ParticipantId: integer (int64)
タイトル:
Participant Identifier
関係者の一意の識別子。 -
ParticipantName: string
タイトル:
Participant Name
読取り専用:true
最大長:360
インセンティブ報酬の関係者の名前。 -
ParticipantPaymentPlanId: integer (int64)
支払プランの一意の識別子。
-
PersonNumber: string
タイトル:
Person Number
読取り専用:true
最大長:30
企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。 国別識別子コンポーネントとの関連はありません。 -
RecoveryEndDate: 文字列(日付)
タイトル:
Recovery End Date
参加者による前払金の回収が終了する日付。 -
RecoveryStartDate: 文字列(日付)
タイトル:
Recovery Start Date
参加者による前払金の回収が開始する日付。 -
RoleId: integer (int64)
読取り専用:
true
支払プラン・ロールに対する一意の識別子。 -
RoleName: string
タイトル:
Role Name
読取り専用:true
最大長:60
ロールの名前。 -
StartDate: 文字列(日付)
タイトル:
Start Date
割当がアクティブになる日付。 許容可能な書式はyyyy-mm-ddです。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。