機械翻訳について

テリトリ予測の取得

get

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

リクエスト

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

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : territoryForecasts-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 調整期間
タイプ: array
タイトル: Adjustment Periods
予測調整期間リソースは、テリトリ予測に適用された期間調整を表示および更新するために使用されます。
ソースを表示
ネストされたスキーマ : 予測アイテム
タイプ: array
タイトル: Forecast Items
予測アイテム・リソースは、予測に関連付けられたアイテムを表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : 予測製品
タイプ: array
タイトル: Forecast Products
予測製品リソースは、予測に関連付けられた製品を表示および更新するために使用されます。 予測製品リソースには、製品別に分類された予測が表示されます。
ソースを表示
ネストされたスキーマ : 売上品目
タイプ: array
タイトル: Revenue Items
売上品目リソースは、テリトリに関連付けられた予測に含まれていない売上品目を表示するために使用されます。
ソースを表示
ネストされたスキーマ : territoryForecasts-forecastAdjustmentPeriods-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : territoryForecasts-ForecastItemDetail-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : territoryForecasts-forecastProducts-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 製品調整期間
タイプ: array
タイトル: Product Adjustment Periods
予測製品調整期間リソースを使用して、予測製品に適用された期間調整を表示および更新します。
ソースを表示
ネストされたスキーマ : territoryForecasts-forecastProducts-forecastProductAdjustmentPeriods-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : territoryForecasts-unforecastedPipeline-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

レスポンス本文の例

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

{
"ForecastParticipantId": 463773
"ForecastHeaderId": 300100018228533
"StatusCode": "UNSUBMITTED"
"DueDate": "2013-01-12"
"StartDate": "2013-04-01"
"ForecastName": "Q2-2013 - 2013/01/12"
"TerritoryHierarchyFreezeDate": "2013-01-11"
"Meaning": "Unsubmitted"
"TerritoryLevel": 4
"TerritoryId": 300100012312306
"TerritoryVersionId": 300100015404040
"TerritoryName": "ZSF_Territory_US West"
"OwnerResourceId": 100010037456217
"ForecastType": "REVENUE"
"ForecastParticipationCode": "REVENUE_AND_NONREVENUE"
"ParentTerritoryOwnerResourceId": 100010037456757
"FcstStatusQualifierCode": "PAST"
...
}

「トップに戻る」