機械翻訳について

すべての未予測収益アイテムを取得

get

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

リクエスト

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

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • PrimaryKey : テリトリに関連付けられた予測に含まれていないすべての売上品目を検索します。
      ファインダ変数:
      • RevnId; integer;収益アイテムの一意の識別子。
    • RevnNumberRowFinder : 一意の公開識別子を持つ収益明細を検索します。
      ファインダ変数:
      • RevnNumber; string;収益明細の一意の公開識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ActualCloseDate; string;収益明細がクローズされた日付。
    • BUOrgId; integer; 商談を所有するビジネス・ユニットの一意の識別子。
    • CalculatedLineRevnAmtInCorpCur; number。企業通貨に換算された商談売上金額。
    • CloseReasonCode; string;収益を獲得または失う理由。
    • CommitFlag; boolean;売上明細を予測に使用するかどうかを示します。 値がTrueの場合は、売上明細を予測に使用する必要があります。 デフォルト値は「False」です。
    • CompetitorPartyName; string;プライマリ競合相手の名前。 商談用です。
    • ConflictId; integer;切断されたモバイル: この値は、異なるデータベース(モバイル・データベースまたはサーバー)で重複が作成される場合に、行の一意性を保証するために使用されます。
    • CurrStgId; integer; 商談の営業ステージの一意の識別子。
    • CustomerRegistryId; string; 商談に関連付けられた販売アカウントの顧客登録識別子。
    • 説明;文字列;ユーザーが指定した売上に関連する製品の説明。
    • DownsideAmount; number;商談の売上の最小金額。
    • EffectiveDate; string;子収益がクローズする日付。 デフォルト値は商談のクローズ日です。
    • ForecastOverrideCode; string; 収益予測を上書きするかどうかを示すコード。 有効な値は、ALWAYS、NEVERおよびCRITERIAです。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • Name1; string;テリトリの名前。
    • OpportunityCreationDate; string; 基礎となる商談が作成された日時。
    • OpportunityCurrencyCode; string; 商談金額の基になる通貨。
    • OpportunityOwnerPartyName; string;商談所有者の名前。
    • OpportunityOwnerResourcePartyId; integer;商談所有者の一意の識別子。
    • OptyEffectiveDate; string;商談の予想クローズ日。
    • OptyId; integer;商談の一意の識別子。
    • OptyLastUpdateDate; string; 基礎となる商談が最後に更新された日付。
    • OptyNumber; string; パートナに関連付けられた商談の代替キー識別子。
    • OrganizationId; integer; 製品が属する組織の一意の識別子。
    • OwnerPartyNumber; string;商談所有者の代替識別子。
    • PartOrgPartyName; string; 子売上に関連付けられたプライマリ・パートナの名前。
    • PartyName2; string;このパーティの名前
    • PrimaryCompetitorPartyNumber;文字列;プライマリ競合相手パーティID。
    • PrimaryContactPartyId; integer;プライマリ担当者の一意の識別子。
    • PrimaryContactPartyName; string;プライマリ担当者の名前。
    • PrimaryFlag; boolean;収益がプライマリ収益かどうかを示します。 値がTrueの場合、売上はすべての子売上のプライマリ売上になります。 デフォルト値は「False」です。
    • PrimaryOrganizationName; string; この商談が属するビジネス・ユニットの名前。
    • PrimaryPartnerCompanyNumber; string;プライマリ・パートナの代替識別子。
    • ProdGroupName; string;収益に関連付けられた製品グループの名前。
    • ProductGroupReferenceNumber; string;製品グループ識別子。
    • ProductType; string;アイテムや製品グループなど、売上明細の製品タイプ。
    • 数量、数値、この商談の製品数量。
    • RecordSet; string;収益明細セット機能で使用される収益カテゴリ。
    • RecurTypeCode; string; 明細が標準収益明細か固定収益明細かを示すコード。
    • ResourcePartyId; integer;収益所有者の一意の識別子。
    • RevnAmount; number;この商談から得た収益の金額。
    • RevnAmountCurcyCode;文字列。この商談の売上を計算するために使用される通貨を示すコード。
    • RevnId; integer; 商談の売上の一意の識別子。
    • RevnLastUpdateDate; string; 売上明細が最後に更新された日時。
    • RevnNumber; string; 子売上のユーザー編集可能な一意の識別子。 デフォルト値は収益識別子です。
    • SalesChannelCd; string;商談の販売チャネル。
    • SalesCreditTypeCode; String; 販売実績のタイプを示すコード(目標や割当なしなど)。
    • SplitPercent; number;分割収益の割合。
    • SplitTypeCode; string; 分割が収益か非収益かを示すコード。
    • StatusCd; string;収益ステータス・コード。
    • StatusCode; string; 子売上のステータスの一意のコード。
    • SumRevnDownsideAmt; number;最悪のケースの量。
    • SumRevnUpsideAmt; number;最適なケースの量。
    • SummaryRevnAmt; number;収益金額。
    • SummaryRevnAmtInCorpCur; number。企業通貨に換算された収益金額。
    • TerrOwnerPartyName; string; この売上品目のプライマリ・テリトリ所有者。
    • TerrOwnerResourceId; integer;この売上品目のプライマリ・テリトリ所有者識別子。
    • TimeFilter; string;行に関連付けられた時間フィルタ。
    • UnitPrice; number;製品の見積単価。
    • UpsideAmount; number;商談の最大売上金額。
    • WinProb; integer;商談を成約させる推定確度。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

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

例:

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

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts/1897628/child/unforecastedPipeline?onlyData=true

レスポンス本文の例

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

{
  "items" : [ {
    "RevnId" : 300100090407978,
    "TargetPartyId" : 999997550776400,
    "CustomerAccountId" : null,
    "BUOrgId" : 5186,
    "Comments" : null,
    "CommitFlag" : false,
    "CostAmount" : 0,
    "ResourcePartyId" : 300100027483620,
    "DownsideAmount" : 0,
    "ExpectAmount" : 12500,
    "MarginAmount" : 0,
    "OptyId" : 300100090387685,
    "UnitPrice" : null,
    "InventoryItemId" : null,
    "InventoryOrgId" : null,
    "Quantity" : 10,
    "RevnAmount" : 125000,
    "RevnAmountCurcyCode" : "USD",
    "TypeCode" : null,
    "UpsideAmount" : 125000,
    "WinProb" : 10,
    "UOMCode" : null,
    "ExpectDlvryDate" : null,
    "CreatedBy" : "ZSF_Sales_Rep3",
    "CreationDate" : "2016-07-29T14:59:21-07:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2016-09-19T01:53:42-07:00",
    "LastUpdateLogin" : "38CC162B2E17133AE05394D0F00AB723",
    "Description" : null,
    "OrganizationId" : null,
    "PrimaryFlag" : false,
    "RevnNumber" : "CDRM_99567",
    "ProdGroupId" : 999997826070652,
    "ProdGroupName" : "Agile Applications",
    "RecurFrequencyCode" : "NONE",
    "RecurEndDate" : null,
    "RecurParentRevnId" : null,
    "RecurNumberPeriods" : null,
    "RecurQuantity" : null,
    "RecurUnitPrice" : null,
    "RecurRevnAmount" : null,
    "RecurTypeCode" : "NONRECUR",
    "RecurStartDate" : null,
    "SalesCreditTypeCode" : "QUOTA",
    "SplitParentRevnId" : 300100090387706,
    "SplitPercent" : 100,
    "SplitTypeCode" : "DETAILCHILDSPLIT",
    "StatusCode" : "OPEN",
    "EffectiveDate" : "2016-10-16",
    "CloseReasonCode" : null,
    "PrCmptPartyId" : null,
    "RecurPeriodOrEndDateCode" : "EndAfter",
    "ActualCloseDate" : null,
    "PrTerritoryVersionId" : 300100026843435,
    "ConversionRate" : 1,
    "ConversionRateType" : "Corporate",
    "OwnerDealExpirationDate" : null,
    "OwnerDealProtectedDate" : null,
    "OwnerLockAsgnFlag" : false,
    "Name1" : "ZSF_Territory_USWest1",
    "ForecastOverrideCode" : "CRITERIA",
    "ItemNumber" : null,
    "ItemNumberInternal" : null,
    "ProductType" : "Group",
    "NqSplitAllocTypeCode" : null,
    "RecurDownsideAmount" : null,
    "RecurUpsideAmount" : null,
    "CrmCurcyCode" : "USD",
    "CrmConversionRateType" : "Corporate",
    "CrmConversionRate" : 1,
    "RevnCategoryCode" : null,
    "OptyLeadId" : null,
    "SalesChannelCd" : "ZPM_DIRECT_CHANNEL_TYPES",
    "PrPartOrgPartyId" : null,
    "PartEngagementTypeCd" : null,
    "CreditRcptPartOrgPartyId" : null,
    "PartOrgPartyId" : null,
    "PartOrgPartyName" : null,
    "ParentRevnId" : null,
    "RevnLineTypeCode" : "STANDARD_REVN",
    "RevnSequenceNumber" : null,
    "TerrOwnerOrganizationId" : 300100027657573,
    "EffectiveStartDate" : "2013-08-23",
    "EffectiveEndDate" : "4712-12-31",
    "SalesAccountId" : 999997550776400,
    "Discount" : null
  }, {
    "RevnId" : 300100090867466,
    "TargetPartyId" : 999997550776400,
    "CustomerAccountId" : null,
    "BUOrgId" : 5186,
    "Comments" : null,
    "CommitFlag" : false,
    "CostAmount" : 0,
    "ResourcePartyId" : 300100027483620,
    "DownsideAmount" : 0,
    "ExpectAmount" : 12500,
    "MarginAmount" : 0,
    "OptyId" : 300100090867461,
    "UnitPrice" : null,
    "InventoryItemId" : null,
    "InventoryOrgId" : null,
    "Quantity" : 10,
    "RevnAmount" : 125000,
    "RevnAmountCurcyCode" : "USD",
    "TypeCode" : null,
    "UpsideAmount" : 125000,
    "WinProb" : 10,
    "UOMCode" : null,
    "ExpectDlvryDate" : null,
    "CreatedBy" : "ZSF_Sales_Rep3",
    "CreationDate" : "2016-08-10T13:06:52-07:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2016-09-19T01:53:42-07:00",
    "LastUpdateLogin" : "39BD982CDA200C65E05394D0F00A4A4A",
    "Description" : null,
    "OrganizationId" : null,
    "PrimaryFlag" : false,
    "RevnNumber" : "CDRM_152488",
    "ProdGroupId" : 999997826070652,
    "ProdGroupName" : "Agile Applications",
    "RecurFrequencyCode" : "NONE",
    "RecurEndDate" : null,
    "RecurParentRevnId" : null,
    "RecurNumberPeriods" : null,
    "RecurQuantity" : null,
    "RecurUnitPrice" : null,
    "RecurRevnAmount" : null,
    "RecurTypeCode" : null,
    "RecurStartDate" : null,
    "SalesCreditTypeCode" : "QUOTA",
    "SplitParentRevnId" : null,
    "SplitPercent" : 100,
    "SplitTypeCode" : "NONE",
    "StatusCode" : "OPEN",
    "EffectiveDate" : "2016-10-16",
    "CloseReasonCode" : null,
    "PrCmptPartyId" : null,
    "RecurPeriodOrEndDateCode" : "EndAfter",
    "ActualCloseDate" : null,
    "PrTerritoryVersionId" : 300100026843435,
    "ConversionRate" : 1,
    "ConversionRateType" : "Corporate",
    "OwnerDealExpirationDate" : null,
    "OwnerDealProtectedDate" : null,
    "OwnerLockAsgnFlag" : false,
    "Name1" : "ZSF_Territory_USWest1",
    "ForecastOverrideCode" : "CRITERIA",
    "ItemNumber" : null,
    "ItemNumberInternal" : null,
    "ProductType" : "Group",
    "NqSplitAllocTypeCode" : "PROPORTIONAL",
    "RecurDownsideAmount" : null,
    "RecurUpsideAmount" : null,
    "CrmCurcyCode" : "USD",
    "CrmConversionRateType" : "Corporate",
    "CrmConversionRate" : 1,
    "RevnCategoryCode" : null,
    "OptyLeadId" : null,
    "SalesChannelCd" : "ZPM_DIRECT_CHANNEL_TYPES",
    "PrPartOrgPartyId" : null,
    "PartEngagementTypeCd" : null,
    "CreditRcptPartOrgPartyId" : null,
    "PartOrgPartyId" : null,
    "PartOrgPartyName" : null,
    "ParentRevnId" : null,
    "RevnLineTypeCode" : "STANDARD_REVN",
    "RevnSequenceNumber" : null,
    "TerrOwnerOrganizationId" : 300100027657573,
    "EffectiveStartDate" : "2013-08-23",
    "EffectiveEndDate" : "4712-12-31",
    "SalesAccountId" : 999997550776400,
    "Discount" : null
  }
「トップに戻る」