予測アイテムの取得
get
/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/ForecastItemDetail/{ForecastItemDetailUniqID}
リクエスト
パス・パラメータ
- ForecastItemDetailUniqID(required): string
これは、予測アイテム・リソースの複合キーを構成し、予測アイテムのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、予測アイテムの特定のインスタンスに移動してハッシュ・キーを取得するために、予測アイテム・コレクション・リソースを問い合せる必要があります。
- ForecastParticipantId(required): integer(int64)
テリトリ予測に関連付けられた関係者の一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Effective-Of:
このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた
= 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、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の値は、解析時に正の整数が生成されるように文字列である必要があります。のリストです。 - Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : territoryForecasts-ForecastItemDetail-item-response
タイプ:
ソースを表示
object
-
AdjustedForecast: number
タイトル:
Adjusted Forecast
修正後の収益アイテムの値。 -
AdjustedQuantity: number
タイトル:
Adjusted Quantity
修正済数量の値です。 -
AdjustmentType: string
タイトル:
Adjustment Type
読取り専用:true
最大長:30
作成された予測調整のタイプです。 予測は、予測アイテム・レベルまたは予測要約レベルのいずれかで調整できます。 -
AdjustPeriodId: integer (int64)
タイトル:
Adjustment Period ID
予測期間の一意の識別子。 -
BestCaseAdjustedForecast: number
タイトル:
Adjusted Best Case
調整後の収益アイテムの最良ケース値。 -
BUOrgId: integer (int64)
ビジネス・ユニット組織の一意の識別子。
-
Category: string
タイトル:
Category
読取り専用:true
予測アイテム・カテゴリは、予測アイテムが更改タイプか新規タイプかを示します。 -
CorporateCurrencyCode: string
タイトル:
Currency
最大長:30
予測に関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CorporateUnadjustedDownsideAmount: number
タイトル:
Unadjusted Worst Case
企業通貨での最悪のケース収益アイテム金額。 -
CorporateUnadjustedRevenueAmount: number
タイトル:
Unadjusted Forecast
企業通貨での収益アイテム金額。 -
CorporateUnadjustedUpsideAmount: number
タイトル:
Unadjusted Best Case
企業通貨での最良ケース収益アイテム金額。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
CurrentStageId: integer (int64)
タイトル:
Sales Stage
商談に関連付けられている現在の営業ステージの一意の識別子。 -
CustomerPartyId: integer (int64)
タイトル:
Customer
収益アイテムに関連付けられた顧客の一意の識別子。 -
EffectiveDate: 文字列(日付)
タイトル:
Close Date
収益アイテムが有効になる日付。 -
ForecastHeaderId: integer (int64)
タイトル:
Forecast Header ID
売上予想の一意の識別子。 -
ForecastItemId: integer (int64)
タイトル:
ForecastItem
予測アイテムの一意の識別子。 -
ForecastOverrideCode: string
タイトル:
Include in Forecast
最大長:30
基準の予測上書きコードです。 -
InventoryItemId: integer (int64)
タイトル:
Product ID
読取り専用:true
製品の作成時に生成される在庫品目の一意の識別子。 -
InventoryOrgId: integer (int64)
タイトル:
Inventory Organization ID
製品の作成時に生成される在庫組織の一意の識別子。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OpportunityId: integer (int64)
タイトル:
Opportunity ID
売上アイテムに関連付けられた商談の一意の識別子。 -
OpportunityName: string
タイトル:
Opportunity
最大長:275
商談の名前。 -
OpportunityStatusCode: string
タイトル:
Opportunity Status
最大長:30
商談のステータス。 -
OwnerName: string
読取り専用:
true
最大長:360
売上アイテム所有者の名前。 -
OwnerResourceId: integer (int64)
タイトル:
Credit Receiver ID
収益所有者の一意の識別子。 -
OwnerResourceOrgId: integer (int64)
タイトル:
Resource Organization ID
収益所有者の組織の一意の識別子。 -
PartnerPartOrgPartyId: integer (int64)
タイトル:
Partner Organization ID
パートナ・パーティ組織の一意の識別子。 -
PartnerSourceNumber: string
タイトル:
Primary Source Number
最大長:30
パートナのソース番号。 -
PartyUniqueName: string
タイトル:
Account
読取り専用:true
最大長:900
商談に関連付けられている販売アカウントの名前。 -
PrimaryTerritoryId: integer (int64)
タイトル:
Primary Territory ID
売上品目に関連付けられたプライマリ・テリトリの一意の識別子。 -
PrimaryTerritoryVersionId: integer (int64)
タイトル:
Primary Territory Version ID
売上品目に関連付けられたプライマリ・テリトリ・バージョンの一意の識別子。 -
ProductGroupId: integer (int64)
タイトル:
Product Group ID
製品グループの一意の識別子。 -
ProductName: string
タイトル:
Product Name
製品名。 -
数量: number
タイトル:
Quantity
収益アイテムの数量。 -
RecurTypeCode: string
タイトル:
Recurrence Type Code
最大長:30
商談が繰返しであるかどうかを示すコード。 -
RevenueAmount: number
タイトル:
Revenue
収益アイテムに関連付けられた収益金額。 -
RevenueId: integer (int64)
タイトル:
Revenue ID
予測アイテムに関連付けられた売上アイテムの一意の識別子。 -
RevenueStatusCode: string
タイトル:
Status
最大長:30
売上アイテムのステータス。 -
RevenueTerritoryId: integer (int64)
収益テリトリの一意の識別子。 この属性は、マネージャが売上品目を部下の予測にプルした場合にのみ移入されます。
-
UnadjustedQuantity: number
タイトル:
Unadjusted Quantity
デフォルト値:0
未調整数量の値です。 -
UnitPrice: number
タイトル:
Estimated Price
収益アイテムの単価です。 -
UpdateFlag: boolean
読取り専用:
true
レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。 -
UserLastUpdateDate: string (date-time)
読取り専用:
true
ユーザーがレコードを最後に更新した日付。 -
WinProbability: 整数(int32)
タイトル:
Win Probability
売上品目の受注確度値。 -
WorstCaseAdjustedForecast: number
タイトル:
Adjusted Worst Case
調整後の収益アイテムの最悪のケース値。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、予測アイテムを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts/463773/child/ForecastItemDetail/300100018228655
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ "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 ... }