機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. インセンティブ報酬ルール階層

すべてのルール階層の取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 指定された識別子を持つルール階層を検索します。
      ファインダ変数:
      • RuleId; integer; 階層内のルールの一意の識別子。
    • RuleNumberRowFinder : 指定したルール番号を持つルール階層を検索します。
      ファインダ変数:
      • RuleNumber; string.
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string; ルール階層を作成したユーザー。
    • CreationDate; string; 階層が作成された日付。
    • 説明;文字列;ルールの説明。
    • EnabledFlag; boolean;ルールが有効かどうかを示します。
    • EndDate; string; ルールが非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。
    • LastUpdateDate; string; 階層が最後に更新された日付。
    • LastUpdateLogin; string; 階層を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; 階層を最後に更新したユーザー。
    • Name; string;ルールの名前。
    • NumberOfWinners; integer; 一致基準およびランクに基づいて勝つことができるルールの数。 この値は、クレジット割当および関係者割当ルール・タイプに適用されます。
    • OrganizationId; integer;ビジネス・ユニットの一意の識別子。
    • ParentRuleId; integer; 親ルールの一意の識別子。 この値は、親ルールのルール識別子にデフォルト設定されます。
    • ParentRuleName; string;親ルールの名前。
    • ParentRuleNumber; string;親ルールの一意の識別子。
    • Rank; integer;ルールのプリファレンス。 この値は、割当中に他の優勢ルール間の関係を破る場合に便利です。 ランク番号が最も小さいルールは、同じ階層レベルの他のウィナー・ルールよりも優先されます。 この値は、分類、クレジットおよび関係者割当ルール・タイプに適用されます。
    • RuleId; integer;ルールの一意の識別子。 この値は作成アクション中に生成されます。
    • RuleNumber; string;ルールの一意の識別子。 この値は、作成処理中にシステム生成またはユーザー指定にできます。
    • RuleTypeId; integer; ルール・タイプの一意の識別子。
    • StartDate; string; ルールがアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : incentiveCompensationRuleHierarchies
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : incentiveCompensationRuleHierarchies-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 64
    ルール階層を作成したユーザー。
  • 読取り専用: true
    階層が作成された日付。
  • タイトル: Description
    最大長: 1000
    ルールの説明。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: true
    ルールが有効かどうかを示します。
  • タイトル: End Date
    ルールが非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。
  • 読取り専用: true
    階層が最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    階層を最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    階層を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 160
    ルールの名前。
  • タイトル: Number of Winners
    デフォルト値: 1
    一致基準およびランクに基づいて獲得できるルールの数。 この値は、クレジット割当および関係者割当ルール・タイプに適用されます。
  • タイトル: Business Unit
    ビジネス・ユニットの一意の識別子。
  • タイトル: Parent
    親ルールの一意の識別子。 この値は、親ルールのルール識別子にデフォルト設定されます。
  • タイトル: Name
    読取り専用: true
    最大長: 160
    親ルールの名前。
  • タイトル: Rule Number
    読取り専用: true
    最大長: 30
    親ルールの一意の識別子。
  • Qualifying Criteria
    タイトル: Qualifying Criteria
    資格取得基準リソースを使用して、分類および与信処理でトランザクションがどのように照合されるかを作成および表示します。 「設定およびメンテナンス」作業領域の表および列の構成タスクを使用して、分類、直接クレジットおよび関係者割当ルールの資格取得基準属性としてアプリケーション表の列を使用できるようにします。 付加フレックスフィールドに基づいて独自のクオリファイアを定義することもできます。
  • タイトル: Rank
    ルールのプリファレンス。 この値は、割当中に他の優勢ルール間の関係を破る場合に便利です。 ランク番号が最も小さいルールは、同じ階層レベルの他のウィナー・ルールよりも優先されます。 この値は、分類、クレジットおよび関係者割当ルール・タイプに適用されます。
  • Rule Assignments
    タイトル: Rule Assignments
    ルール割当リソースは、照合トランザクションのクレジット受領者の作成、表示、更新または削除に、ルールが成功した場合に使用されます。 分類では、照合するトランザクションにクレジット・カテゴリが追加され、参加者ロール割当ルールでは、適格なロールが一致する関係者に割り当てられます。 間接クレジットの作成には、積上ルールとチーム・ルールのルール割当が使用されます。
  • 読取り専用: true
    ルールの一意の識別子。 この値は作成アクション中に生成されます。
  • タイトル: Rule Number
    最大長: 30
    ルールの一意の識別子。 この値は、作成処理中にシステム生成またはユーザー指定にできます。
  • Rules
    タイトル: Rules
    ルール・リソースは、ルール階層の子ノードの作成、表示、更新または削除に使用されます。 ルールはルール階層の構成要素を形成し、有効日が設定されます。
  • タイトル: Rule Type
    ルール・タイプの一意の識別子。
  • タイトル: Start Date
    ルールがアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。
ネストされたスキーマ : 適格基準
タイプ: array
タイトル: Qualifying Criteria
資格取得基準リソースを使用して、分類および与信処理でトランザクションがどのように照合されるかを作成および表示します。 「設定およびメンテナンス」作業領域の表および列の構成タスクを使用して、分類、直接クレジットおよび関係者割当ルールの資格取得基準属性としてアプリケーション表の列を使用できるようにします。 付加フレックスフィールドに基づいて独自のクオリファイアを定義することもできます。
ソースを表示
ネストされたスキーマ : ルール割当
タイプ: array
タイトル: Rule Assignments
ルール割当リソースは、照合トランザクションのクレジット受領者の作成、表示、更新または削除に、ルールが成功した場合に使用されます。 分類では、照合するトランザクションにクレジット・カテゴリが追加され、参加者ロール割当ルールでは、適格なロールが一致する関係者に割り当てられます。 間接クレジットの作成には、積上ルールとチーム・ルールのルール割当が使用されます。
ソースを表示
ネストされたスキーマ : ルール
タイプ: array
タイトル: Rules
ルール・リソースは、ルール階層の子ノードの作成、表示、更新または削除に使用されます。 ルールはルール階層の構成要素を形成し、有効日が設定されます。
ソースを表示
ネストされたスキーマ : incentiveCompensationRuleHierarchies-QualifyingCriteria-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 適格属性値
タイプ: array
タイトル: Qualifying Attribute Values
属性値リソースと、次と等しい、類似などの演算子は、ルールの適格基準の作成、表示、更新または削除に使用されます。
ソースを表示
ネストされたスキーマ : incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-response
タイプ: object
ソースを表示
  • タイトル: Operator
    最大長: 30
    デフォルト値: EQUAL_TO
    次と等しい、類似、次の間にあるなどの比較演算子。 受け入れられる値のリストは、参照タイプCN_RS_COMPARISON_OPERATORSで定義されます。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。
  • 読取り専用: true
    最大長: 64
    適格属性値を作成したユーザー。
  • 読取り専用: true
    適格属性値が作成された日付。
  • タイトル: Character High Value
    最大長: 360
    文字属性の上限値。 この値は、資格取得条件が自由形式テキストで、演算子が範囲内にある場合に適用されます。
  • タイトル: High Value Number
    数値属性の上限値。 この値は、資格取得条件が数値で、演算子が次の間にあるの場合に適用できます。
  • 読取り専用: true
    適格属性値が最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    資格該当属性値を最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    適格属性値を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Character Low Value
    最大長: 360
    文字属性の下限値。 この値は、資格取得条件がテキスト(自由形式)の場合に適用されます。
  • 最大長: 360
    資格取得基準値の参照コード。 この値は、トランザクション・タイプなど、適格基準が参照値セットに基づいている場合に適用されます。
  • 属性値の一意の識別子。 資格取得基準が、クレジット・カテゴリなどのユーザー定義オブジェクト値セットに基づいている場合に適用されます。
  • タイトル: Low Value Number
    数値属性の下限値。 この値は、資格取得条件が数値で、演算子が次の間にあるの場合に適用できます。
  • ビジネス・ユニットの一意の識別子。
  • ルール属性の一意の識別子。
  • 読取り専用: true
    ルール属性値の一意の識別子。
ネストされたスキーマ : incentiveCompensationRuleHierarchies-RuleAssignments-item-response
タイプ: object
ソースを表示
  • タイトル: Name
    割り当てられたオブジェクトの一意の識別子。
  • 読取り専用: true
    割り当てられたオブジェクトの名前。
  • タイトル: Type
    最大長: 30
    関係者、ロール、チーム、グループ、適格カテゴリなど、割当のタイプ。
  • 読取り専用: true
    最大長: 64
    ルール割当を作成したユーザー。
  • 読取り専用: true
    ルール割当が作成された日付。
  • タイトル: End Date
    ルール割当が非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。
  • タイトル: Receive direct credit
    最大長: 1
    デフォルト値: false
    グループのメンバーが他のグループ・メンバー・ダイレクト・クレジットのクレジットを取得するかどうかを示します。 この値は、積上ルール・タイプとアナリスト階層ルール・タイプに適用されます。
  • 読取り専用: true
    ルール割当が最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    ルール割当を最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    ルール割当を最後に更新したユーザーのログイン。
  • Links
  • ビジネス・ユニットの一意の識別子。
  • タイトル: Revenue Type
    最大長: 30
    デフォルト値: REVENUE
    収益や非収益など、生成されたクレジットのタイプ。 この値は、クレジットおよび積上ルール・タイプに適用されます。 受け入れられる値のリストは、参照タイプCN_RS_REVENUE_TYPEで定義されます。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。
  • タイトル: Role
    関係者に関連付けられたロールの一意の識別子。 この値は、割り当てられたオブジェクト・タイプが関係者である場合に適用されます。
  • タイトル: Name
    読取り専用: true
    最大長: 60
    ルールに割り当てられた関係者に関連付けられたロールの名前。
  • タイトル: Roll Up to Parents
    最大長: 1
    デフォルト値: false
    貸方受け側に対して積上クレジットが生成されるかどうかを示します。 この値は、与信ルール・タイプに適用されます。
  • 読取り専用: true
    ルール割当の一意の識別子。 この値は作成アクション中に生成されます。
  • タイトル: Parent
    ルールの一意の識別子。
  • タイトル: Split Percent
    デフォルト値: 100
    貸方金額を計算するためにトランザクション金額に対して適用されるパーセント数値。 この値は、与信ルール・タイプに適用されます。
  • タイトル: Start Date
    ルール割当がアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。
  • タイトル: Summarize rollups
    最大長: 1
    デフォルト値: false
    参加者が、要約された直接クレジットまたは個々の直接クレジットを間接クレジットとして受け取るかどうかを示します。 この値は、クレジットおよび積上ルール・タイプに適用されます。
ネストされたスキーマ : incentiveCompensationRuleHierarchies-Rules-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 64
    ルール階層を作成したユーザー。
  • 読取り専用: true
    階層が作成された日付。
  • タイトル: Description
    最大長: 1000
    ルールの説明。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: true
    ルールが有効かどうかを示します。
  • タイトル: End Date
    ルールが非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。
  • 読取り専用: true
    階層が最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    階層を最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    階層を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 160
    ルールの名前。
  • タイトル: Number of Winners
    デフォルト値: 1
    一致基準およびランクに基づいて獲得できるルールの数。 この値は、クレジット割当および関係者割当ルール・タイプに適用されます。
  • タイトル: Business Unit
    ビジネス・ユニットの一意の識別子。
  • タイトル: Parent
    親ルールの一意の識別子。 この値は、親ルールのルール識別子にデフォルト設定されます。
  • タイトル: Name
    読取り専用: true
    最大長: 160
    親ルールの名前。
  • タイトル: Rule Number
    読取り専用: true
    最大長: 30
    親ルールの一意の識別子。
  • タイトル: Rank
    ルールのプリファレンス。 この値は、割当中に他の優勢ルール間の関係を破る場合に便利です。 ランク番号が最も小さいルールは、同じ階層レベルの他のウィナー・ルールよりも優先されます。 この値は、分類、クレジットおよび関係者割当ルール・タイプに適用されます。
  • 読取り専用: true
    ルールの一意の識別子。 この値は作成アクション中に生成されます。
  • タイトル: Rule Number
    最大長: 30
    ルールの一意の識別子。 この値は、作成処理中にシステム生成またはユーザー指定にできます。
  • タイトル: Rule Type
    ルール・タイプの一意の識別子。
  • タイトル: Start Date
    ルールがアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。
「トップに戻る」