機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

予測の期間調整の更新

patch

/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastAdjustmentPeriods/{FcstAdjustPeriodId}

リクエスト

パス・パラメータ

• FcstAdjustPeriodId(required): integer(int64)
  予測調整期間の一意の識別子。
• ForecastParticipantId(required): integer(int64)
  テリトリ予測に関連付けられた関係者の一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• AdjustedForecast: number
  調整後のテリトリの収益の値。
• NewAdjustedForecast: number
  調整後のテリトリの正味新規予測値。
• NewUnadjustedForecast: number
  純新規の未調整テリトリ予測の値。
• PeriodName: string
  タイトル: Adjustment Period

  最大長: 15

  予測調整期間の名前。
• RenewalAdjustedForecast: number
  調整後のテリトリの更改予測値。
• RenewalUnadjustedForecast: number
  更改の未調整テリトリ予測の値。
• UnadjustedForecast: number
  未調整のテリトリ予測の値。

{
    "type":"object",
    "properties":{
        "RenewalAdjustedForecast":{
            "type":"number",
            "description":"The renewal forecast value of the territory after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "NewUnadjustedForecast":{
            "type":"number",
            "description":"The value of the unadjusted territory forecast for net new.",
            "nullable":true,
            "x-queryable":false
        },
        "NewAdjustedForecast":{
            "type":"number",
            "description":"The net new forecast value of the territory after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodName":{
            "title":"Adjustment Period",
            "maxLength":15,
            "type":"string",
            "description":"The name of the forecast adjustment period.",
            "nullable":true
        },
        "AdjustedForecast":{
            "type":"number",
            "description":"The value of the revenue for the territory after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "UnadjustedForecast":{
            "type":"number",
            "description":"The value of the unadjusted territory forecast.",
            "nullable":true
        },
        "RenewalUnadjustedForecast":{
            "type":"number",
            "description":"The value of the unadjusted territory forecast for renewals.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

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

本文( )

ルート・スキーマ : territoryForecasts-forecastAdjustmentPeriods-item-response

タイプ: object

ソースを表示

• AdjustedForecast: number
  調整後のテリトリの収益の値。
• AdjustmentComment: string
  読取り専用: true

  最大長: 360

  調整中に入力された追加コメント。
• AdjustmentReason: string
  読取り専用: true

  最大長: 360

  予測を調整する事由を示すコード。
• FcstAdjustmentId: integer (int64)
  読取り専用: true

  テリトリ予測に対して行われた修正の一意の識別子。
• FcstAdjustPeriodId: integer (int64)
  読取り専用: true

  予測調整期間の一意の識別子。
• FcstHeaderId: integer (int64)
  タイトル: Forecast Header ID

  読取り専用: true

  売上予想の一意の識別子。
• FcstParticipantId: integer (int64)
  タイトル: Participant ID

  読取り専用: true

  テリトリ予測関係者の一意の識別子。
• LastAdjustedDate: 文字列(日付)
  読取り専用: true

  テリトリ予測が最後に調整された日付。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NewAdjustedForecast: number
  調整後のテリトリの正味新規予測値。
• NewUnadjustedForecast: number
  純新規の未調整テリトリ予測の値。
• PeriodName: string
  タイトル: Adjustment Period

  最大長: 15

  予測調整期間の名前。
• RenewalAdjustedForecast: number
  調整後のテリトリの更改予測値。
• RenewalUnadjustedForecast: number
  更改の未調整テリトリ予測の値。
• TerritoryId: integer (int64)
  タイトル: Territory ID

  読取り専用: true

  テリトリの一意の識別子。
• UnadjustedForecast: number
  未調整のテリトリ予測の値。
• UpdateFlag: boolean
  読取り専用: true

  レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。

{
    "type":"object",
    "properties":{
        "TerritoryId":{
            "title":"Territory ID",
            "type":"integer",
            "description":"The unique identifier of the territory.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FcstHeaderId":{
            "title":"Forecast Header ID",
            "type":"integer",
            "description":"The unique identifier of the forecast.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RenewalAdjustedForecast":{
            "type":"number",
            "description":"The renewal forecast value of the territory after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentComment":{
            "maxLength":360,
            "type":"string",
            "description":"The additional comments entered while making the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustedForecast":{
            "type":"number",
            "description":"The value of the revenue for the territory after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "UnadjustedForecast":{
            "type":"number",
            "description":"The value of the unadjusted territory forecast.",
            "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
        },
        "NewUnadjustedForecast":{
            "type":"number",
            "description":"The value of the unadjusted territory forecast for net new.",
            "nullable":true,
            "x-queryable":false
        },
        "LastAdjustedDate":{
            "type":"string",
            "description":"The date when the territory forecast was last adjusted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FcstAdjustPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the forecast adjustment period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FcstParticipantId":{
            "title":"Participant ID",
            "type":"integer",
            "description":"The unique identifier of the territory forecast participant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReason":{
            "maxLength":360,
            "type":"string",
            "description":"The code indicating the reason for adjusting the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NewAdjustedForecast":{
            "type":"number",
            "description":"The net new forecast value of the territory after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodName":{
            "title":"Adjustment Period",
            "maxLength":15,
            "type":"string",
            "description":"The name of the forecast adjustment period.",
            "nullable":true,
            "x-queryable":true
        },
        "FcstAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the adjustment made to the territory forecast.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RenewalUnadjustedForecast":{
            "type":"number",
            "description":"The value of the unadjusted territory forecast for renewals.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

タイプ: 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/2339551/child/forecastAdjustmentPeriods/300100090740298

リクエスト本文の例

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

{"AdjustedForecast":100}

レスポンス本文の例

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

{
"FcstAdjustPeriodId": 300100090740298
"PeriodName": "40-16"
"AdjustedForecast": 100
"FcstParticipantId": 2339551
"TerritoryId": 300100012891886
"FcstHeaderId": 300100090740278
"UnadjustedForecast": 0
"AdjustmentReason": null
"AdjustmentComment": null
"LastAdjustedDate": "2016-08-02"
"FcstAdjustmentId": 300100090802865
"UpdateFlag": true
}

「トップに戻る」