機械翻訳について

すべてのテリトリ予測の取得

get

/crmRestApi/resources/11.13.18.05/territoryForecasts

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • CurrentForecast : すべてのアクティブな売上予想レコードを検索します。
      ファインダ変数:
      • FilterByParticipantId : 指定された参加者識別子を持つテリトリ予測レコードを検索します。
        ファインダ変数:
        • ForecastParticipantId; integer;予測参加者の一意の識別子。
      • MyForecast : 指定したユーザーのすべての売上予想レコードを検索します。
        ファインダ変数:
        • TrStatus; string; TrStatusに指定できる値は、ACTIVE、PASTおよびFUTUREです。 指定されたユーザーの売上予想レコードは、指定されたテリトリ売上予想状況の値に基づいてフィルタされます。
      • PrimaryKey : 主キー別にテリトリ予測レコードを検索します。
        ファインダ変数:
        • ForecastParticipantId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
      • ClosedAmt; number;テリトリ予測のクローズ済売上金額。
      • CreatedBy; string; レコードを作成したユーザー。
      • CreationDate; string;レコードが作成された日付。
      • DueDate; string;予測の期日。
      • EndDate; string;予測の終了日。
      • FcstStatusQualifierCode; string; 予測テリトリが未発行、発行済または否認済かどうかを示すステータス・コード。
      • ForecastHeaderId; integer; 予測の一意の識別子。
      • ForecastName; string;予測の名前。
      • ForecastParticipantId; integer;テリトリ予測に関連付けられた関係者の一意の識別子。
      • ForecastSeqNum; integer; 様々な予測を正しい順序でソートする数値。
      • ForecastType; string;予測のタイプ。 使用可能な値は次のとおりです: 収益およびオーバーレイ。
      • LastUpdateDate; string; レコードが最後に更新された日付。
      • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
      • LastUpdatedBy; string; レコードを最後に更新したユーザー。
      • 内容;文字列;予測のステータス。 使用可能な値は次のとおりです: 送信済み、未送信、拒否済み。
      • ノート、文字列、予測要約調整コメント。
      • OwnerResourceId; integer;テリトリを所有するパーティの一意の識別子。
      • ParentTerritoryId; integer;親テリトリの一意の識別子。
      • ParentTerritoryOwnerResourceId; integer; 親テリトリ所有者の一意の識別子。
      • PeriodName; string;予測調整期間の表示名。
      • PipelineAmt; number;現在の予測期間と同じ時間枠内にクローズするように設定されたオープン商談売上の合計金額。
      • StartDate; string;予測の開始日。
      • StatusCode; string;予測のステータス・コード。 使用可能な値は次のとおりです: SUBMITTED、UNSUBMITTEDおよびREJECTED。
      • SubmittedBy; string; 予測を発行したユーザーの名前。
      • SubmittedOn; string;予測が発行された日付。
      • TerritoryHierarchyFreezeDate; string;テリトリ階層が確定される日付。 期間の予測は、その予測期間に対してテリトリ階層が凍結された後にのみ編集できます。
      • TerritoryId; integer;テリトリの一意の識別子。
      • TerritoryLevel; number;テリトリ階層内のテリトリのレベル。
      • TerritoryName; string;予測テリトリの名前。
      • TerritoryVersionId; integer;テリトリ・バージョンの一意の識別子。
      • UserLastUpdateDate; string; ユーザーが商談を最後に更新した日付。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

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

    レスポンス本文の例

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

    {
    "items": 
    [20]
     
    0:  
    {
    "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
    ...
    }
    
    
    「トップに戻る」