Jump to

• Request
• Response

Update one plan forecast profile

patch

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanForecastProfile/{TransactionId}

Request

Path Parameters

• PlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• TransactionId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• AnalysisSet: integer (int64)
  Analysis set identifier that holds the set of measures and dimension members.
• AnalysisSetClob: string (byte)
  Analysis set stored by the forecasting profile.
• EngRunDate: string (date-time)
  Last net change run date and time for the forecasting engine by plan.
• ForecastProfileId: integer (int64)
  Unique identifier of the forecasting profile.
• ForecastProfileOrder: integer (int32)
  Position number in the forecast list of the forecast profiles.
• ForecastStartDate: string (date)
  First forecast date for the forecasting profile by plan.
• HistoricalBuckets: number
  Number of historical buckets in days considered by a forecasting profile.
• HistoricalOffset: integer
  Specifies the number of historical time buckets by which the history end date should be shifted backward for forecast tuning and out-of-sample testing. When this value is specified, the history start date is also shifted backward by the specified number of historical buckets, and the forecast end date is adjusted accordingly.
• HistoryEndDate: string (date)
  Last bucket for the forecasting profile in the historical date range.
• HypertuningSetting: number
  Holds the corresponding plan's population percent value to be used in the hyperparameters tuning calculation in the selected forecasting profile.Value controls the percentage of the plan population for which hyperparameter tuning is done during forecast generation. Values can be any percent between O and 100. 0% means no tuning. 100% means tuning on all plan's population.
• IsAutomaticTuningEnabled: number
  Value that indicates whether the tuning of hyperparameters is enabled for the plan. The default value is taken from the HypertuneSamplePercent forecasting parameter.
• LockedFuturePeriods: number
  Number of forecasting buckets from the plan start date for which the forecast is fixed.
• OutputOptions: number
  Value that indicates how the results of the hyperparameter tuning are saved in the output measures. The default value is taken from the HypertuneOutputMode forecasting parameter.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanningAdvisorNotify: number
  Value controls whether notifications are provided through the Planning Advisor when better forecasting results are available because of hyperparameter tuning.
• ProportRunDate: string (date-time)
  Stores the last run date of the global proportions and prediction status for engine.
• TransactionId: integer (int64)
  Unique transaction identifier.

{
    "type":"object",
    "properties":{
        "ProportRunDate":{
            "type":"string",
            "description":"Stores the last run date of the global proportions and prediction status for engine.",
            "format":"date-time",
            "nullable":true
        },
        "PlanningAdvisorNotify":{
            "type":"number",
            "description":"Value controls whether notifications are provided through the Planning Advisor when better forecasting results are available because of hyperparameter tuning.",
            "nullable":true
        },
        "HistoricalBuckets":{
            "type":"number",
            "description":"Number of historical buckets in days considered by a forecasting profile.",
            "nullable":true
        },
        "ForecastProfileId":{
            "type":"integer",
            "description":"Unique identifier of the forecasting profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ForecastProfileOrder":{
            "type":"integer",
            "description":"Position number in the forecast list of the forecast profiles.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "HistoryEndDate":{
            "type":"string",
            "description":"Last bucket for the forecasting profile in the historical date range.",
            "format":"date",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AnalysisSetClob":{
            "type":"string",
            "description":"Analysis set stored by the forecasting profile.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "HypertuningSetting":{
            "type":"number",
            "description":"Holds the corresponding plan's population percent value to be used in the hyperparameters tuning calculation in the selected forecasting profile.Value controls the percentage of the plan population for which hyperparameter tuning is done during forecast generation. Values can be any percent between O and 100. 0% means no tuning. 100% means tuning on all plan's population.",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "OutputOptions":{
            "type":"number",
            "description":"Value that indicates how the results of the hyperparameter tuning are saved in the output measures. The default value is taken from the HypertuneOutputMode forecasting parameter.",
            "nullable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Unique transaction identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ForecastStartDate":{
            "type":"string",
            "description":"First forecast date for the forecasting profile by plan.",
            "format":"date",
            "nullable":true
        },
        "HistoricalOffset":{
            "type":"integer",
            "description":"Specifies the number of historical time buckets by which the history end date should be shifted backward for forecast tuning and out-of-sample testing. When this value is specified, the history start date is also shifted backward by the specified number of historical buckets, and the forecast end date is adjusted accordingly.",
            "nullable":true
        },
        "IsAutomaticTuningEnabled":{
            "type":"number",
            "description":"Value that indicates whether the tuning of hyperparameters is enabled for the plan. The default value is taken from the HypertuneSamplePercent forecasting parameter.",
            "nullable":true
        },
        "LockedFuturePeriods":{
            "type":"number",
            "description":"Number of forecasting buckets from the plan start date for which the forecast is fixed.",
            "nullable":true
        },
        "EngRunDate":{
            "type":"string",
            "description":"Last net change run date and time for the forecasting engine by plan.",
            "format":"date-time",
            "nullable":true
        },
        "AnalysisSet":{
            "type":"integer",
            "description":"Analysis set identifier that holds the set of measures and dimension members.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ForecastProfileId"
                ]
            }
        }
    }
}

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 : planOptions-PlanForecastProfile-item-response

Type: object

Show Source

• AnalysisSet: integer (int64)
  Analysis set identifier that holds the set of measures and dimension members.
• AnalysisSetClob: string (byte)
  Analysis set stored by the forecasting profile.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the plan forecast profile.
• CreationDate: string (date-time)
  Read Only: true

  Date when the plan forecast profile was originally created.
• EngRunDate: string (date-time)
  Last net change run date and time for the forecasting engine by plan.
• ForecastBuckets: integer
  Read Only: true

  Number of forecast buckets defined for the plan forecast profile.
• ForecastEndDate: string (date)
  Read Only: true

  End date of the forecast for the plan forecast profile.
• ForecastProfieName: string
  Read Only: true

  Maximum Length: 255

  Name for forecast profile.
• ForecastProfileDescription: string
  Read Only: true

  Maximum Length: 255

  Description forecast profile.
• ForecastProfileId: integer (int64)
  Unique identifier of the forecasting profile.
• ForecastProfileOrder: integer (int32)
  Position number in the forecast list of the forecast profiles.
• ForecastStartDate: string (date)
  First forecast date for the forecasting profile by plan.
• HistoricalBuckets: number
  Number of historical buckets in days considered by a forecasting profile.
• HistoricalOffset: integer
  Specifies the number of historical time buckets by which the history end date should be shifted backward for forecast tuning and out-of-sample testing. When this value is specified, the history start date is also shifted backward by the specified number of historical buckets, and the forecast end date is adjusted accordingly.
• HistoryEndDate: string (date)
  Last bucket for the forecasting profile in the historical date range.
• HistoryStartDate: string (date)
  Read Only: true

  Value that indicates the start date of the history for the plan forecast profile.
• HypertuningSetting: number
  Holds the corresponding plan's population percent value to be used in the hyperparameters tuning calculation in the selected forecasting profile.Value controls the percentage of the plan population for which hyperparameter tuning is done during forecast generation. Values can be any percent between O and 100. 0% means no tuning. 100% means tuning on all plan's population.
• InputMeasure: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the input measure identifier for the plan forecast profile.
• IsAutomaticTuningEnabled: number
  Value that indicates whether the tuning of hyperparameters is enabled for the plan. The default value is taken from the HypertuneSamplePercent forecasting parameter.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the plan forecast profile.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the plan forecast profile.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last time the user logged into the system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockedFuturePeriods: number
  Number of forecasting buckets from the plan start date for which the forecast is fixed.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Plan version number.
• OutputMeasure: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the output measure identifier for the plan forecast profile.
• OutputOptions: number
  Value that indicates how the results of the hyperparameter tuning are saved in the output measures. The default value is taken from the HypertuneOutputMode forecasting parameter.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanningAdvisorNotify: number
  Value controls whether notifications are provided through the Planning Advisor when better forecasting results are available because of hyperparameter tuning.
• ProportRunDate: string (date-time)
  Stores the last run date of the global proportions and prediction status for engine.
• TransactionId: integer (int64)
  Unique transaction identifier.

{
    "type":"object",
    "properties":{
        "ProportRunDate":{
            "type":"string",
            "description":"Stores the last run date of the global proportions and prediction status for engine.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAdvisorNotify":{
            "type":"number",
            "description":"Value controls whether notifications are provided through the Planning Advisor when better forecasting results are available because of hyperparameter tuning.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan forecast profile was originally created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastProfileDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description forecast profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryStartDate":{
            "type":"string",
            "description":"Value that indicates the start date of the history for the plan forecast profile.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastEndDate":{
            "type":"string",
            "description":"End date of the forecast for the plan forecast profile.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalysisSetClob":{
            "type":"string",
            "description":"Analysis set stored by the forecasting profile.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "HypertuningSetting":{
            "type":"number",
            "description":"Holds the corresponding plan's population percent value to be used in the hyperparameters tuning calculation in the selected forecasting profile.Value controls the percentage of the plan population for which hyperparameter tuning is done during forecast generation. Values can be any percent between O and 100. 0% means no tuning. 100% means tuning on all plan's population.",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "OutputOptions":{
            "type":"number",
            "description":"Value that indicates how the results of the hyperparameter tuning are saved in the output measures. The default value is taken from the HypertuneOutputMode forecasting parameter.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastProfieName":{
            "maxLength":255,
            "type":"string",
            "description":"Name for forecast profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoricalOffset":{
            "type":"integer",
            "description":"Specifies the number of historical time buckets by which the history end date should be shifted backward for forecast tuning and out-of-sample testing. When this value is specified, the history start date is also shifted backward by the specified number of historical buckets, and the forecast end date is adjusted accordingly.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Plan version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "InputMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the input measure identifier for the plan forecast profile.",
            "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"
            }
        },
        "EngRunDate":{
            "type":"string",
            "description":"Last net change run date and time for the forecasting engine by plan.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AnalysisSet":{
            "type":"integer",
            "description":"Analysis set identifier that holds the set of measures and dimension members.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ForecastProfileId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the plan forecast profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoricalBuckets":{
            "type":"number",
            "description":"Number of historical buckets in days considered by a forecasting profile.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastProfileId":{
            "type":"integer",
            "description":"Unique identifier of the forecasting profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the plan forecast profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastProfileOrder":{
            "type":"integer",
            "description":"Position number in the forecast list of the forecast profiles.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ForecastBuckets":{
            "type":"integer",
            "description":"Number of forecast buckets defined for the plan forecast profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryEndDate":{
            "type":"string",
            "description":"Last bucket for the forecasting profile in the historical date range.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OutputMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the output measure identifier for the plan forecast profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Unique transaction identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ForecastStartDate":{
            "type":"string",
            "description":"First forecast date for the forecasting profile by plan.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IsAutomaticTuningEnabled":{
            "type":"number",
            "description":"Value that indicates whether the tuning of hyperparameters is enabled for the plan. The default value is taken from the HypertuneSamplePercent forecasting parameter.",
            "nullable":true,
            "x-queryable":true
        },
        "LockedFuturePeriods":{
            "type":"number",
            "description":"Number of forecasting buckets from the plan start date for which the forecast is fixed.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan forecast profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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