1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Plan Definitions
  5. Plan Forecast Profiles

Get all plan forecast profiles

get

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

Request

Path Parameters
  • 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=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the plan forecast profile according to the value that identifies the plan forecast profile.
      Finder Variables
      • TransactionId; integer; Value that uniquely identifies the plan forecast profile.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AnalysisSet; integer; Analysis set identifier that holds the set of measures and dimension members.
    • CreatedBy; string; User who created the plan forecast profile.
    • CreationDate; string; Date when the plan forecast profile was originally created.
    • EngRunDate; string; Last net change run date and time for the forecasting engine by plan.
    • ForecastBuckets; integer; Number of forecast buckets defined for the plan forecast profile.
    • ForecastEndDate; string; End date of the forecast for the plan forecast profile.
    • ForecastProfieName; string; Name for forecast profile.
    • ForecastProfileDescription; string; Description forecast profile.
    • ForecastProfileId; integer; Unique identifier of the forecasting profile.
    • ForecastProfileOrder; integer; Position number in the forecast list of the forecast profiles.
    • ForecastStartDate; string; 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; Last bucket for the forecasting profile in the historical date range.
    • HistoryStartDate; string; 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; 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 when the user most recently updated the plan forecast profile.
    • LastUpdateLogin; string; Last time the user logged into the system.
    • LastUpdatedBy; string; User who most recently updated the plan forecast profile.
    • LockedFuturePeriods; number; Number of forecasting buckets from the plan start date for which the forecast is fixed.
    • ObjectVersionNumber; integer; Plan version number.
    • OutputMeasure; string; 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; 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; Stores the last run date of the global proportions and prediction status for engine.
    • TransactionId; integer; Unique transaction identifier.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planOptions-PlanForecastProfile-item-response
Type: object
Show Source
Back to Top