機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 報酬見積インサイト

すべての計算シミュレーションの取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • OptyFinder商談ファインダを含むコレクションを検索します。
      ファインダ変数
      • OptyId; integer;ソース・オブジェクト識別子。 商談見積の場合、これは商談識別子になります。
      • OptyNumber; string;ソース・オブジェクト番号。 商談見積の場合、これは商談番号になります。
    • PrimaryKey指定した主キーを持つコレクションを検索します。
      ファインダ変数
      • SimulationId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AsynchronousRequestId; integer; 計算シミュレーションを非同期で実行するために使用されるジョブの一意の識別子。
    • CalculationCurrencyCode; string;計算通貨コード。
    • CreatedBy; string; 計算シミュレーションを作成したユーザー。
    • CreationDate; string;計算シミュレーションが作成された日時。
    • CurrentEarningsSumCalculation; number;計算シミュレーションの前に、参加者がすでに獲得した計算通貨での支給の合計。
    • CurrentEarningsSumFunctional; number;計算シミュレーションの前に、参加者がすでに獲得している機能通貨での支給の合計。
    • CurrentEarningsSumHome; number;計算シミュレーションの前に、参加者がすでに獲得したホーム通貨での支給の合計。
    • EndPayPeriodId; integer;この計算シミュレーションにおける支給の支給期間識別子の最大値。
    • ErrorCode; string; 計算シミュレーションがエラーまたは警告ステータスで終了すると、この値はエラー・タイプを示します。
    • GainSumCalculation; number;計算シミュレーション中に計算された計算通貨での利益の合計。
    • GainSumFunctional; number;計算シミュレーション中に計算された機能通貨での利益の合計。
    • GainSumHome; number;計算シミュレーション中に計算されたホーム通貨での利益の合計。
    • HomeCurrencyCode; string;参加者のホーム通貨コード。
    • LastUpdateDate; string;計算シミュレーションが最後に更新された日時。
    • LastUpdateLogin; string;計算シミュレーションを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string;計算シミュレーションを最後に更新したユーザー。
    • OrgId; integer;シミュレーションに関連付けられたビジネス・ユニットの一意の識別子。
    • ParticipantId; integer;シミュレーションが作成された関係者の一意の識別子。
    • ParticipantName; string;シミュレーションが作成された参加者の名前。
    • PartyNumber; string;シミュレーションが作成された参加者のパーティ番号。
    • ProcessAuditId; integer; プロセス監査ログの検索に使用されるプロセス監査の一意の識別子。
    • ProcessingDate; string;シミュレーションが処理された日付。
    • ProcessingStatus; string;シミュレーション・プロセスのステータス。
    • SimulationId; integer;計算シミュレーションの一意の識別子。
    • SimulationName; string; 計算シミュレーションを識別するためのわかりやすい任意の名前。
    • SourceObjectId; integer;シミュレーションが作成されたオブジェクトのシステム識別子。
    • SourceObjectNumber; string;シミュレーションが作成されたオブジェクトのユーザーが指定した識別子。 商談ベースのシミュレーションの場合、これは商談番号になります。
    • SourceObjectType; string;シミュレーションが作成されたオブジェクトのタイプ。
    • StartPayPeriodId; integer;この計算シミュレーションの支給項目の最下位支払期間識別子。
    • UpdateQueued; string; 処理するキューに同じ名前の新しいシミュレーションがあることを示します。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : incentiveCompensationEstimationInsights
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : incentiveCompensationEstimationInsights-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : プラン・コンポーネント別見積要約
タイプ: array
タイトル: Estimation Summary by Plan Components
計算シミュレーション・リソースは、シミュレーション結果をプラン・コンポーネント別に表示するために使用されます。
ソースを表示
ネストされたスキーマ : incentiveCompensationEstimationInsights-SummaryByPlanComponent-item-response
タイプ: object
ソースを表示
トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行して、すべての計算シミュレーションを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "items": [
        {
            "SimulationId": 10034,
            "SimulationName": "300100052468154_300100562426638",
            "SourceObjectType": "opportunities",
            "SourceObjectId": 300100562426638,
            "SourceObjectNumber": "CDRM_128503",
            "ParticipantId": 19001,
            "ParticipantName": "Stephanie Rodriquez",
            "PartyNumber": "CDRM_91767",
            "OrgId": 204,
            "ProcessingDate": "2022-12-07T00:59:37+00:00",
            "ProcessingStatus": "ORA_CN_ERROR",
            "ErrorCode": "ORA_CN_CLASSIFICATION",
            "CurrentEarningsSumCalculation": null,
            "CurrentEarningsSumFunctional": null,
            "CurrentEarningsSumHome": null,
            "GainSumCalculation": null,
            "GainSumFunctional": null,
            "GainSumHome": null,
            "CalculationCurrencyCode": null,
            "HomeCurrencyCode": null,
            "StartPayPeriodId": null,
            "EndPayPeriodId": null,
            "ProcessAuditId": null,
            "AsynchronousRequestId": 113248,
            "CreationDate": "2022-12-07T00:59:20+00:00",
            "CreatedBy": "OIC_MGR_OPERATIONS",
            "LastUpdateDate": "2022-12-07T00:59:20+00:00",
            "LastUpdatedBy": "OIC_MGR_OPERATIONS",
            "LastUpdateLogin": "EF32F6361D0B9F77E0536902F40A94FC",
            "UpdateQueued": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034",
                    "name": "incentiveCompensationEstimationInsights",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034",
                    "name": "incentiveCompensationEstimationInsights",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034/child/SummaryByPlanComponent",
                    "name": "SummaryByPlanComponent",
                    "kind": "collection"
                }
            ]
        },
        {
            "SimulationId": 10041,
            "SimulationName": "300100052468154_300100562444658",
            "SourceObjectType": "opportunities",
            "SourceObjectId": 300100562444658,
            "SourceObjectNumber": "CDRM_128508",
            "ParticipantId": 19001,
            "ParticipantName": "Stephanie Rodriquez",
            "PartyNumber": "CDRM_91767",
            "OrgId": 204,
            "ProcessingDate": "2022-12-07T00:59:36+00:00",
            "ProcessingStatus": "ORA_CN_ERROR",
            "ErrorCode": "ORA_CN_CLASSIFICATION",
            "CurrentEarningsSumCalculation": null,
            "CurrentEarningsSumFunctional": null,
            "CurrentEarningsSumHome": null,
            "GainSumCalculation": null,
            "GainSumFunctional": null,
            "GainSumHome": null,
            "CalculationCurrencyCode": null,
            "HomeCurrencyCode": null,
            "StartPayPeriodId": null,
            "EndPayPeriodId": null,
            "ProcessAuditId": null,
            "AsynchronousRequestId": 113249,
            "CreationDate": "2022-12-07T00:59:20+00:00",
            "CreatedBy": "OIC_MGR_OPERATIONS",
            "LastUpdateDate": "2022-12-07T00:59:20+00:00",
            "LastUpdatedBy": "OIC_MGR_OPERATIONS",
            "LastUpdateLogin": "EF32F6361D0B9F77E0536902F40A94FC",
            "UpdateQueued": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10041",
                    "name": "incentiveCompensationEstimationInsights",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10041",
                    "name": "incentiveCompensationEstimationInsights",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10041/child/SummaryByPlanComponent",
                    "name": "SummaryByPlanComponent",
                    "kind": "collection"
                }
            ]
        }
    ],
..
}
「トップに戻る」