Jump to

• Request
• Response

Update a period adjustment for a forecast

patch

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

Request

Path Parameters

• FcstAdjustPeriodId(required): integer(int64)
  The unique identifier of the forecast adjustment period.
• ForecastParticipantId(required): integer(int64)
  The unique identifier of the participant associated with the territory forecast.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustedForecast: number
  The value of the revenue for the territory after adjustments.
• NewAdjustedForecast: number
  The net new forecast value of the territory after adjustments.
• NewUnadjustedForecast: number
  The value of the unadjusted territory forecast for net new.
• PeriodName: string
  Title: Adjustment Period

  Maximum Length: 15

  The name of the forecast adjustment period.
• RenewalAdjustedForecast: number
  The renewal forecast value of the territory after adjustments.
• RenewalUnadjustedForecast: number
  The value of the unadjusted territory forecast for renewals.
• UnadjustedForecast: number
  The value of the unadjusted territory forecast.

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : territoryForecasts-forecastAdjustmentPeriods-item-response

Type: object

Show Source

• AdjustedForecast: number
  The value of the revenue for the territory after adjustments.
• AdjustmentComment: string
  Read Only: true

  Maximum Length: 360

  The additional comments entered while making the adjustment.
• AdjustmentReason: string
  Read Only: true

  Maximum Length: 360

  The code indicating the reason for adjusting the forecast.
• FcstAdjustmentId: integer (int64)
  Read Only: true

  The unique identifier of the adjustment made to the territory forecast.
• FcstAdjustPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the forecast adjustment period.
• FcstHeaderId: integer (int64)
  Title: Forecast Header ID

  Read Only: true

  The unique identifier of the forecast.
• FcstParticipantId: integer (int64)
  Title: Participant ID

  Read Only: true

  The unique identifier of the territory forecast participant.
• LastAdjustedDate: string (date)
  Read Only: true

  The date when the territory forecast was last adjusted.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewAdjustedForecast: number
  The net new forecast value of the territory after adjustments.
• NewUnadjustedForecast: number
  The value of the unadjusted territory forecast for net new.
• PeriodName: string
  Title: Adjustment Period

  Maximum Length: 15

  The name of the forecast adjustment period.
• RenewalAdjustedForecast: number
  The renewal forecast value of the territory after adjustments.
• RenewalUnadjustedForecast: number
  The value of the unadjusted territory forecast for renewals.
• TerritoryId: integer (int64)
  Title: Territory ID

  Read Only: true

  The unique identifier of the territory.
• UnadjustedForecast: number
  The value of the unadjusted territory forecast.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the user has access to update the record.

{
    "type":"object",
    "properties":{
        "AdjustedForecast":{
            "type":"number",
            "description":"The value of the revenue for 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
        },
        "AdjustmentReason":{
            "maxLength":360,
            "type":"string",
            "description":"The code indicating the reason for adjusting the forecast.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "LastAdjustedDate":{
            "type":"string",
            "description":"The date when the territory forecast was last adjusted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NewAdjustedForecast":{
            "type":"number",
            "description":"The net new 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
        },
        "PeriodName":{
            "title":"Adjustment Period",
            "maxLength":15,
            "type":"string",
            "description":"The name of the forecast adjustment period.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalAdjustedForecast":{
            "type":"number",
            "description":"The renewal forecast value of the territory after adjustments.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalUnadjustedForecast":{
            "type":"number",
            "description":"The value of the unadjusted territory forecast for renewals.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Back to Top