機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 報酬プラン
  4. 割当済関係者

すべての割当済参加者の取得

get

/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments

リクエスト

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

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PlanDirectAssignmentsFinder : 指定された主キーを持つ直接割当てを検索します。
      ファインダ変数:
      • PlanRoleAssignmentsFinder : 指定された主キーを持つロール割当てを検索します。
        ファインダ変数:
        • PrimaryKey : 指定された主キーを持つ割当てを検索します。
          ファインダ変数:
          • SrpCompPlanId; integer;報酬プランの一意の識別子。
      • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
      • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
        • AcceptanceStatus; string;公開済参加者報酬プラン文書のステータス。 受理可能な値のリストが参照CN_SRP_APPR_STATUSに定義されています。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。 受入ステータスは、ビジネス・ユニットのプラン承認および受入ワークフロー使用可能属性がいいえに設定されている場合、更新できます。 設定およびメンテナンスのパラメータの管理タスクを使用して、属性値をレビューおよび更新します。
        • AnalystId; integer;関係者に割り当てられたアナリストの一意の識別子。
        • AnalystName; string; 関係者に割り当てられたアナリストの名前。
        • AssignmentType; string; 参加者が報酬プランに直接割り当てられるか、ロールを介して割り当てられるかなど、アサイメントのタイプ。 許容可能な値のリストは、参照CN_PARTICIPANT_PLN_ASSIGN_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
        • CompensationPlanId; integer;基本報酬プランの一意の識別子。
        • CreatedBy; string; 報酬プラン割当を作成したユーザー。
        • CreationDate; string;報酬プラン割当が作成された日時。
        • EndDate; string; 報酬プラン割当が非アクティブになる日付。
        • LastUpdateDate; string;報酬プラン割当が最後に更新された日時。
        • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン詳細。
        • LastUpdatedBy; string; 報酬プラン割当を最後に更新したユーザー。
        • ParticipantId; integer;参加者の一意の識別子。
        • ParticipantName; string;参加者の名前。
        • ParticipantPlanNumber; string;参加者プランの代替キー識別子。
        • ParticipantType; string;参加者のタイプ。 この属性は、参加者が管理者であるか、ツールの更新を担当しているか、営業チーム・メンバーであり、販売実績を取得できるかを示します。 取り得る値は、管理者の場合はANALYST、営業チーム・メンバーの場合はPARTICIPANTです。 受理可能な値のリストは、参照CN_PARTICIPANT_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
        • PersonNumber; string; 企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。 国別識別子コンポーネントとの関連はありません。
        • RoleId; integer;インセンティブ報酬ロールの一意の識別子。
        • RoleName; string;インセンティブ報酬ロールの名前。
        • SrpCompPlanId; integer;報酬プランの一意の識別子。
        • StartDate; string; 報酬プラン割当がアクティブになる日付。
      • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
      ヘッダー・パラメータ
      • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
      • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

      トップに戻る

      応答

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

      デフォルトのレスポンス

      次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
      ヘッダー
      • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
      • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
      本文( )
      ルート・スキーマ : compensationPlans-CompensationPlanAssignments
      タイプ: object
      ソースを表示
      ネストされたスキーマ : アイテム
      タイプ: array
      タイトル: Items
      コレクション内のアイテム。
      ソースを表示
      ネストされたスキーマ : compensationPlans-CompensationPlanAssignments-item-response
      タイプ: object
      ソースを表示
      • タイトル: Acceptance Status
        最大長: 30
        デフォルト値: ACCEPTED
        公開済関係者報酬プラン文書のステータス。 受理可能な値のリストが参照CN_SRP_APPR_STATUSに定義されています。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。 受入ステータスは、ビジネス・ユニットのプラン承認および受入ワークフロー使用可能属性がいいえに設定されている場合、更新できます。 設定およびメンテナンスのパラメータの管理タスクを使用して、属性値をレビューおよび更新します。
      • タイトル: Analyst
        読取り専用: true
        関係者に割り当てられたアナリストの一意の識別子。
      • タイトル: Name
        読取り専用: true
        最大長: 360
        関係者に割り当てられたアナリストの名前。
      • タイトル: Assignment Type
        最大長: 30
        参加者が報酬プランに直接割り当てられるか、ロールを介して割り当てられるかなど、アサイメントのタイプ。 許容可能な値のリストは、参照CN_PARTICIPANT_PLN_ASSIGN_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
      • タイトル: Compensation Plan
        基本報酬プランの一意の識別子です。
      • 読取り専用: true
        最大長: 64
        報酬プラン割当を作成したユーザー。
      • 読取り専用: true
        報酬プラン割当が作成された日時。
      • タイトル: End Date
        報酬プラン割当が非アクティブになる日付。
      • 読取り専用: true
        報酬プラン割当が最後に更新された日時。
      • 読取り専用: true
        最大長: 64
        報酬プラン割当を最後に更新したユーザー。
      • 読取り専用: true
        最大長: 32
        レコードを最後に更新したユーザーのログイン詳細。
      • Links
      • タイトル: Participant Name
        関係者の一意の識別子。
      • タイトル: Name
        読取り専用: true
        最大長: 360
        参加者の名前。
      • タイトル: Participant Plan Number
        最大長: 30
        参加者プランの代替キー識別子。
      • タイトル: Type
        読取り専用: true
        最大長: 60
        デフォルト値: PARTICIPANT
        参加者のタイプ。 この属性は、参加者が管理者であるか、ツールの更新を担当しているか、営業チーム・メンバーであり、販売実績を取得できるかを示します。 取り得る値は、管理者の場合はANALYST、営業チーム・メンバーの場合はPARTICIPANTです。 受理可能な値のリストは、参照CN_PARTICIPANT_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
      • タイトル: Person Number
        読取り専用: true
        最大長: 30
        企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。 国別識別子コンポーネントとの関連はありません。
      • タイトル: Name
        読取り専用: true
        インセンティブ報酬ロールの一意の識別子。
      • タイトル: Name
        読取り専用: true
        最大長: 60
        インセンティブ報酬ロールの名前。
      • 報酬プランの一意の識別子。
      • タイトル: Start Date
        報酬プラン割当がアクティブになる日付。
      • 読取り専用: true
        プラン文書へのリンク。 プラン文書には、関係者に割り当てられた報酬プランに関する詳細が含まれています。 これは、設定およびメンテナンスのパラメータの管理タスクを使用してプラン承認機能が有効になっている場合にのみ使用できます。 参加者のプランが承認のために送信されると、プラン文書が生成されます。
      「トップに戻る」