Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

予測アイテムの更新

patch

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

リクエスト

パス・パラメータ

ForecastItemDetailUniqID(required): string

これは、予測アイテム・リソースの複合キーを構成し、予測アイテムのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、予測アイテムの特定のインスタンスに移動してハッシュ・キーを取得するために、予測アイテム・コレクション・リソースを問い合せる必要があります。
ForecastParticipantId(required): integer(int64)

テリトリ予測に関連付けられた関係者の一意の識別子。

ヘッダー・パラメータ

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

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

AdjustedForecast: number

タイトル: Adjusted Forecast

修正後の収益アイテムの値。
AdjustedQuantity: number

タイトル: Adjusted Quantity

修正済数量の値です。
AdjustPeriodId: integer (int64)

タイトル: Adjustment Period ID

予測期間の一意の識別子。
BestCaseAdjustedForecast: number

タイトル: Adjusted Best Case

調整後の収益アイテムの最良ケース値。
BUOrgId: integer (int64)

ビジネス・ユニット組織の一意の識別子。
CorporateUnadjustedDownsideAmount: number

タイトル: Unadjusted Worst Case

企業通貨での最悪のケース収益アイテム金額。
CorporateUnadjustedRevenueAmount: number

タイトル: Unadjusted Forecast

企業通貨での収益アイテム金額。
CorporateUnadjustedUpsideAmount: number

タイトル: Unadjusted Best Case

企業通貨での最良ケース収益アイテム金額。
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

基準の予測上書きコードです。
InventoryOrgId: integer (int64)

タイトル: Inventory Organization ID

製品の作成時に生成される在庫組織の一意の識別子。
OpportunityId: integer (int64)

タイトル: Opportunity ID

売上アイテムに関連付けられた商談の一意の識別子。
OpportunityName: string

タイトル: Opportunity

最大長: 275

商談の名前。
OpportunityStatusCode: string

タイトル: Opportunity Status

最大長: 30

商談のステータス。
OwnerResourceId: integer (int64)

タイトル: Credit Receiver ID

収益所有者の一意の識別子。
OwnerResourceOrgId: integer (int64)

タイトル: Resource Organization ID

収益所有者の組織の一意の識別子。
PartnerPartOrgPartyId: integer (int64)

タイトル: Partner Organization ID

パートナ・パーティ組織の一意の識別子。
PartnerSourceNumber: string

タイトル: Primary Source Number

最大長: 30

パートナのソース番号。
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

収益アイテムの単価です。
WinProbability: 整数(int32)

タイトル: Win Probability

売上品目の受注確度値。
WorstCaseAdjustedForecast: number

タイトル: Adjusted Worst Case

調整後の収益アイテムの最悪のケース値。

{
    "type":"object",
    "properties":{
        "AdjustPeriodId":{
            "title":"Adjustment Period ID",
            "type":"integer",
            "description":"The unique identifier of the forecast period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CorporateUnadjustedDownsideAmount":{
            "title":"Unadjusted Worst Case",
            "type":"number",
            "description":"The worst case revenue item amount in corporate currency.",
            "nullable":true
        },
        "OwnerResourceOrgId":{
            "title":"Resource Organization ID",
            "type":"integer",
            "description":"The unique identifier of the revenue owner's organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartnerPartOrgPartyId":{
            "title":"Partner Organization ID",
            "type":"integer",
            "description":"The unique identifier of the partner party organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The product name.",
            "nullable":true
        },
        "RevenueId":{
            "title":"Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the revenue item associated with the forecast item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CurrentStageId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The unique identifier of the current sales stage associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RevenueAmount":{
            "title":"Revenue",
            "type":"number",
            "description":"The revenue amount associated with the revenue item.",
            "nullable":true
        },
        "CustomerPartyId":{
            "title":"Customer",
            "type":"integer",
            "description":"The unique identifier of the customer associated with the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OpportunityStatusCode":{
            "title":"Opportunity Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the opportunity.",
            "nullable":true
        },
        "OpportunityId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UnadjustedQuantity":{
            "title":"Unadjusted Quantity",
            "type":"number",
            "description":"The value of the unadjusted quantity.",
            "nullable":true,
            "default":0
        },
        "PrimaryTerritoryId":{
            "title":"Primary Territory ID",
            "type":"integer",
            "description":"The unique identifier of the primary territory associated with the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorstCaseAdjustedForecast":{
            "title":"Adjusted Worst Case",
            "type":"number",
            "description":"The worst case value of the revenue item after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerResourceId":{
            "title":"Credit Receiver ID",
            "type":"integer",
            "description":"The unique identifier of the revenue owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartnerSourceNumber":{
            "title":"Primary Source Number",
            "maxLength":30,
            "type":"string",
            "description":"The source number of the partner.",
            "nullable":true
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustedQuantity":{
            "title":"Adjusted Quantity",
            "type":"number",
            "description":"The value of the adjusted quantity.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization that is generated during product creation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the revenue item.",
            "nullable":true
        },
        "BestCaseAdjustedForecast":{
            "title":"Adjusted Best Case",
            "type":"number",
            "description":"The best case value of the revenue item after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "CorporateUnadjustedRevenueAmount":{
            "title":"Unadjusted Forecast",
            "type":"number",
            "description":"The revenue item amount in corporate currency.",
            "nullable":true
        },
        "AdjustedForecast":{
            "title":"Adjusted Forecast",
            "type":"number",
            "description":"The value of the revenue item after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "OpportunityName":{
            "title":"Opportunity",
            "maxLength":275,
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "UnitPrice":{
            "title":"Estimated Price",
            "type":"number",
            "description":"The unit price of the revenue item.",
            "nullable":true
        },
        "ForecastItemId":{
            "title":"ForecastItem",
            "type":"integer",
            "description":"The unique identifier of the forecast item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":30,
            "type":"string",
            "description":"Forecast Override code for criteria.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CorporateUnadjustedUpsideAmount":{
            "title":"Unadjusted Best Case",
            "type":"number",
            "description":"The best case revenue item amount in corporate currency.",
            "nullable":true
        },
        "ForecastHeaderId":{
            "title":"Forecast Header ID",
            "type":"integer",
            "description":"The unique identifier of the forecast.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WinProbability":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The win probability value of the revenue item.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            }
        },
        "PrimaryTerritoryVersionId":{
            "title":"Primary Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the primary territory version associated with the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RevenueStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the revenue item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurTypeCode":{
            "title":"Recurrence Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating if the opportunity is recurring.",
            "nullable":true
        },
        "BUOrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RevenueTerritoryId":{
            "type":"integer",
            "description":"The unique identifier of the revenue territory. This attribute is populated only when a revenue item is pulled into a subordinate forecast by the manager.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the revenue item becomes effective.",
            "format":"date",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

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

調整後の収益アイテムの最悪のケース値。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CorporateUnadjustedDownsideAmount":{
            "title":"Unadjusted Worst Case",
            "type":"number",
            "description":"The worst case revenue item amount in corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerPartOrgPartyId":{
            "title":"Partner Organization ID",
            "type":"integer",
            "description":"The unique identifier of the partner party organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The product name.",
            "nullable":true,
            "x-queryable":true
        },
        "CorporateCurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"The corporate currency code associated with the forecast. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date when the user last updated the record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerPartyId":{
            "title":"Customer",
            "type":"integer",
            "description":"The unique identifier of the customer associated with the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OpportunityStatusCode":{
            "title":"Opportunity Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the opportunity.",
            "nullable":true,
            "x-queryable":true
        },
        "WorstCaseAdjustedForecast":{
            "title":"Adjusted Worst Case",
            "type":"number",
            "description":"The worst case value of the revenue item after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwnerResourceId":{
            "title":"Credit Receiver ID",
            "type":"integer",
            "description":"The unique identifier of the revenue owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Product ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item that is generated during product creation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization that is generated during product creation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OpportunityName":{
            "title":"Opportunity",
            "maxLength":275,
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "ForecastItemId":{
            "title":"ForecastItem",
            "type":"integer",
            "description":"The unique identifier of the forecast item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorporateUnadjustedUpsideAmount":{
            "title":"Unadjusted Best Case",
            "type":"number",
            "description":"The best case revenue item amount in corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "WinProbability":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The win probability value of the revenue item.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "PrimaryTerritoryVersionId":{
            "title":"Primary Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the primary territory version associated with the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustPeriodId":{
            "title":"Adjustment Period ID",
            "type":"integer",
            "description":"The unique identifier of the forecast period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the revenue item owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "type":"string",
            "description":"Forecast item category denotes whether the forecast item is of type renewal or new.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerResourceOrgId":{
            "title":"Resource Organization ID",
            "type":"integer",
            "description":"The unique identifier of the revenue owner's organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueId":{
            "title":"Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the revenue item associated with the forecast item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyUniqueName":{
            "title":"Account",
            "maxLength":900,
            "type":"string",
            "description":"The name of the sales account associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentStageId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The unique identifier of the current sales stage associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueAmount":{
            "title":"Revenue",
            "type":"number",
            "description":"The revenue amount associated with the revenue item.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OpportunityId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnadjustedQuantity":{
            "title":"Unadjusted Quantity",
            "type":"number",
            "description":"The value of the unadjusted quantity.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "PrimaryTerritoryId":{
            "title":"Primary Territory ID",
            "type":"integer",
            "description":"The unique identifier of the primary territory associated with the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerSourceNumber":{
            "title":"Primary Source Number",
            "maxLength":30,
            "type":"string",
            "description":"The source number of the partner.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustedQuantity":{
            "title":"Adjusted Quantity",
            "type":"number",
            "description":"The value of the adjusted quantity.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the revenue item.",
            "nullable":true,
            "x-queryable":true
        },
        "BestCaseAdjustedForecast":{
            "title":"Adjusted Best Case",
            "type":"number",
            "description":"The best case value of the revenue item after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "CorporateUnadjustedRevenueAmount":{
            "title":"Unadjusted Forecast",
            "type":"number",
            "description":"The revenue item amount in corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustedForecast":{
            "title":"Adjusted Forecast",
            "type":"number",
            "description":"The value of the revenue item after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of forecast adjustment that was created. A forecast can be adjusted either at the forecast item level or at the forecast summary level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Estimated Price",
            "type":"number",
            "description":"The unit price of the revenue item.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":30,
            "type":"string",
            "description":"Forecast Override code for criteria.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ForecastHeaderId":{
            "title":"Forecast Header ID",
            "type":"integer",
            "description":"The unique identifier of the forecast.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the revenue item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecurTypeCode":{
            "title":"Recurrence Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating if the opportunity is recurring.",
            "nullable":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueTerritoryId":{
            "type":"integer",
            "description":"The unique identifier of the revenue territory. This attribute is populated only when a revenue item is pulled into a subordinate forecast by the manager.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the revenue item becomes effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts/7414679/child/ForecastItemDetail/300100093651349

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"AdjustedQuantity": 100
}

レスポンス本文の例

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

{
"ForecastItemId": 300100093651349
"ForecastHeaderId": 300100093651293
"OpportunityId": 300100090774946
"RevenueId": 300100090774951
"CustomerPartyId": 999997550776400
"OpportunityName": "ZSF_Auto_FUSE_fd591182741"
"RevenueAmount": 250000
"WinProbability": 90
"RevenueStatusCode": "OPEN"
"EffectiveDate": "2016-04-16"
"OpportunityStatusCode": "OPEN"
"BUOrgId": 5186
"PrimaryTerritoryId": 300100012891886
"PrimaryTerritoryVersionId": 300100026843435
"ProductGroupId": 999997826070652
"OwnerResourceId": 300100027483620
"RecurTypeCode": "NONRECUR"
"AdjustPeriodId": 300100093651311
"CorporateUnadjustedRevenueAmount": 250000
"CorporateUnadjustedDownsideAmount": 0
"CorporateUnadjustedUpsideAmount": 250000
"PartyUniqueName": "CUSTOMER_101791834 (Redwood City, US)"
"CorporateCurrencyCode": "USD"
"CurrentStageId": 100000012430007
"AdjustedForecast": 250000
"ProductName": "Agile Applications"
"BestCaseAdjustedForecast": 250000
"WorstCaseAdjustedForecast": 0
"OwnerName": "ZSF Sales_Rep3"
"UnadjustedQuantity": 0
"AdjustedQuantity": 100
...
}

「トップに戻る」