すべてのルール割当の取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments
リクエスト
パス・パラメータ
- RuleId(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 : 指定された識別子を持つルール割当を検索します。
ファインダ変数:- RuleAssignmentId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AssignedObjectId; integer;割り当てられたオブジェクトの一意の識別子。
- AssignedObjectName; string;割り当てられたオブジェクトの名前。
- AssignedObjectType; string; 参加者、ロール、チーム、グループ、適格なカテゴリなど、割当のタイプ。
- CreatedBy; string; ルール割当てを作成したユーザー。
- CreationDate; string; ルール割当てが作成された日付。
- EndDate; string; ルール割当てが非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。
- GroupMemberCreditFlag; boolean;グループのメンバーが他のグループ・メンバー・ダイレクト・クレジットのクレジットを取得するかどうかを示します。 この値は、積上ルール・タイプとアナリスト階層ルール・タイプに適用されます。
- LastUpdateDate; string; ルール割当てが最後に更新された日付。
- LastUpdateLogin; string; ルール割当てを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; ルール割当てを最後に更新したユーザー。
- OrganizationId; integer;ビジネス・ユニットの一意の識別子。
- RevenueType; string;収益や非収益など、生成されたクレジットのタイプ。 この値は、クレジットおよび積上ルール・タイプに適用されます。 受け入れられる値のリストは、参照タイプCN_RS_REVENUE_TYPEで定義されます。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。
- RoleId; integer;関係者に関連付けられたロールの一意の識別子。 この値は、割り当てられたオブジェクト・タイプが関係者である場合に適用されます。
- RoleName; string; ルールに割り当てられた関係者に関連付けられたロールの名前。
- RollupFlag; boolean;クレジット受領者に対して積上クレジットが生成されるかどうかを示します。 この値は、与信ルール・タイプに適用されます。
- RuleAssignmentId; integer;ルール割当ての一意の識別子。 この値は作成アクション中に生成されます。
- RuleId; integer; ルールの一意の識別子。
- SplitPercent; number;貸方金額を計算するためにトランザクション金額に対して適用されるパーセント数。 この値は、与信ルール・タイプに適用されます。
- StartDate; string; ルール割当てがアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。
- SummaryFlag; boolean;参加者が間接クレジットとして要約された直接クレジットを受け取るか、個々の直接クレジットを受け取るかを示します。 この値は、クレジットおよび積上ルール・タイプに適用されます。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationRuleHierarchies-RuleAssignments
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : incentiveCompensationRuleHierarchies-RuleAssignments-item-response
タイプ:
ソースを表示
object
-
AssignedObjectId: integer (int64)
タイトル:
Name
割り当てられたオブジェクトの一意の識別子。 -
AssignedObjectName: string
読取り専用:
true
割り当てられたオブジェクトの名前。 -
AssignedObjectType: string
タイトル:
Type
最大長:30
関係者、ロール、チーム、グループ、適格カテゴリなど、割当のタイプ。 -
CreatedBy: string
読取り専用:
true
最大長:64
ルール割当を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ルール割当が作成された日付。 -
EndDate: 文字列(日付)
タイトル:
End Date
ルール割当が非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。 -
GroupMemberCreditFlag: boolean
タイトル:
Receive direct credit
最大長:1
デフォルト値:false
グループのメンバーが他のグループ・メンバー・ダイレクト・クレジットのクレジットを取得するかどうかを示します。 この値は、積上ルール・タイプとアナリスト階層ルール・タイプに適用されます。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ルール割当が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
ルール割当を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
ルール割当を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrganizationId: integer (int64)
ビジネス・ユニットの一意の識別子。
-
RevenueType: string
タイトル:
Revenue Type
最大長:30
デフォルト値:REVENUE
収益や非収益など、生成されたクレジットのタイプ。 この値は、クレジットおよび積上ルール・タイプに適用されます。 受け入れられる値のリストは、参照タイプCN_RS_REVENUE_TYPEで定義されます。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。 -
RoleId: integer (int64)
タイトル:
Role
関係者に関連付けられたロールの一意の識別子。 この値は、割り当てられたオブジェクト・タイプが関係者である場合に適用されます。 -
RoleName: string
タイトル:
Name
読取り専用:true
最大長:60
ルールに割り当てられた関係者に関連付けられたロールの名前。 -
RollupFlag: boolean
タイトル:
Roll Up to Parents
最大長:1
デフォルト値:false
貸方受け側に対して積上クレジットが生成されるかどうかを示します。 この値は、与信ルール・タイプに適用されます。 -
RuleAssignmentId: integer (int64)
読取り専用:
true
ルール割当の一意の識別子。 この値は作成アクション中に生成されます。 -
RuleId: integer (int64)
タイトル:
Parent
ルールの一意の識別子。 -
SplitPercent: number
タイトル:
Split Percent
デフォルト値:100
貸方金額を計算するためにトランザクション金額に対して適用されるパーセント数値。 この値は、与信ルール・タイプに適用されます。 -
StartDate: 文字列(日付)
タイトル:
Start Date
ルール割当がアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。 -
SummaryFlag: boolean
タイトル:
Summarize rollups
最大長:1
デフォルト値:false
参加者が、要約された直接クレジットまたは個々の直接クレジットを間接クレジットとして受け取るかどうかを示します。 この値は、クレジットおよび積上ルール・タイプに適用されます。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。