機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 予測
  4. 予測項目

すべての予測アイテムの取得

get

/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/ForecastItemDetail

リクエスト

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

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 指定した参加者IDのすべての売上予想アイテム・レコードを検索します。
      ファインダ変数:
      • ForecastItemId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AdjustPeriodId; integer; 予測期間の一意の識別子。
    • AdjustmentType; string;作成された予測調整のタイプ。 予測は、予測アイテム・レベルまたは予測要約レベルのいずれかで調整できます。
    • BUOrgId; integer;ビジネス・ユニット組織の一意の識別子。
    • カテゴリ、文字列、予測アイテム・カテゴリは、予測アイテムが更新タイプか新規タイプかを示します。
    • CorporateCurrencyCode; string; 予測に関連付けられている企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CorporateUnadjustedDownsideAmount; number。企業通貨での最悪ケースの収益アイテム金額。
    • CorporateUnadjustedRevenueAmount; number;収益アイテム金額(企業通貨)。
    • CorporateUnadjustedUpsideAmount; number。企業通貨でのベスト・ケース収益アイテム金額。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • CurrentStageId; integer; 商談に関連付けられている現在の営業ステージの一意の識別子。
    • CustomerPartyId; integer;収益アイテムに関連付けられた顧客の一意の識別子。
    • EffectiveDate; string;収益アイテムが有効になる日付。
    • ForecastHeaderId; integer; 予測の一意の識別子。
    • ForecastItemId; integer; 予測アイテムの一意の識別子。
    • ForecastOverrideCode; string;基準の予測上書きコード。
    • InventoryItemId; integer; 製品の作成時に生成される在庫アイテムの一意の識別子。
    • InventoryOrgId; integer; 製品の作成時に生成される在庫組織の一意の識別子。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • OpportunityId; integer;売上アイテムに関連付けられた商談の一意の識別子。
    • OpportunityName; string;商談の名前。
    • OpportunityStatusCode; string;商談のステータス。
    • OwnerName; string;収益アイテム所有者の名前。
    • OwnerResourceId; integer;収益所有者の一意の識別子。
    • OwnerResourceOrgId; integer;収益所有者の組織の一意の識別子。
    • PartnerPartOrgPartyId; integer;パートナ・パーティ組織の一意の識別子。
    • PartnerSourceNumber; string; パートナのソース番号。
    • PartyUniqueName; string; 商談に関連付けられている販売アカウントの名前。
    • PrimaryTerritoryId; integer;収益アイテムに関連付けられたプライマリ・テリトリの一意の識別子。
    • PrimaryTerritoryVersionId; integer;収益アイテムに関連付けられたプライマリ・テリトリ・バージョンの一意の識別子。
    • ProductGroupId; integer; 製品グループの一意の識別子。
    • ProductName; string;製品名。
    • 数量、数値、収益アイテムの数量。
    • RecurTypeCode; string; 商談が繰り返されるかどうかを示すコード。
    • RevenueAmount; number;収益アイテムに関連付けられた収益金額。
    • RevenueId; integer; 予測アイテムに関連付けられた収益アイテムの一意の識別子。
    • RevenueStatusCode; string;収益アイテムのステータス。
    • RevenueTerritoryId; integer;収益テリトリの一意の識別子。 この属性は、マネージャが売上品目を部下の予測にプルした場合にのみ移入されます。
    • UnadjustedQuantity; number;未調整数量の値。
    • UnitPrice; number;収益アイテムの単価。
    • UserLastUpdateDate; string;ユーザーが最後にレコードを更新した日付。
    • WinProbability; integer;収益アイテムの受注確度の値。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

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

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての予測アイテムを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts/463773/child/ForecastItemDetail

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
"items": [1]
 
0:  
{
"ForecastItemId": 300100018228655
"ForecastHeaderId": 300100018228533
"OpportunityId": 300100015891902
"RevenueId": 300100015891943
"CustomerPartyId": 999997550776400
"OpportunityName": "Jpeter_test_Opty"
"RevenueAmount": 155074
"WinProbability": 90
"RevenueStatusCode": "OPEN"
"UnitPrice": 4561
"EffectiveDate": "2013-04-16"
"OpportunityStatusCode": "OPEN"
"BUOrgId": 887
"PrimaryTerritoryId": 300100012891911
"PrimaryTerritoryVersionId": 300100015404051
"Quantity": 34
"ProductGroupId": 999997826070646
"OwnerResourceId": 100010037456643
"RecurTypeCode": "NONRECUR"
"AdjustPeriodId": 300100018228563
"CorporateUnadjustedRevenueAmount": 155074
...
}
「トップに戻る」