機械翻訳について

すべてのルールの取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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-Rules
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : 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です。
「トップに戻る」