1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Plans

Get details of all plans

get

/fscmRestApi/resources/11.13.18.05/plans

Request

Query Parameters
  • 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 a plan based on the unique identifier of the plan.
      Finder Variables
      • PlanId; integer; Value that uniquely identifies the plan.
  • 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:
    • Approved; integer; Contains one of the following values: 1 or null. If 1, then the plan is approved. If null, then the plan isn't approved. The default value is null.
    • AutoReleaseRp; integer; Contains one of the following values: 1 or 2. If 1, then release planning recommendations. If 2, then don't release. The default value is 2.
    • BaseCompileDesignator; string; Name of the base plan that this plan was copied from.
    • BasePlanId; integer; ID of the base plan that this plan was copied from.
    • CalSsQuantEndItems; integer; Contains one of the following values: 1 or 2. If 1, then calculate a new safety stock level for each end item when running the plan. If 2, then don't do this calculation.
    • CompileDesignator; string; Name of the plan.
    • CreatedBy; string; User who created the plan.
    • CreationDate; string; Date when the user created the plan.
    • DailyCutoffBucket; integer; Date when the day buckets ends in a planning horizon.
    • DataCompletionDate; string; Date on which the snapshot process in the plan run completed.
    • DemandPlanCompletionDate; string; Date and time when demand planning finished running the plan.
    • DemandPlanStartDate; string; Date and time when demand planning started running the plan.
    • Description; string; Description of the plan.
    • EnableArchive; integer; Contains one of the following values: 1 or 2. If 1, then archive measure values in the plan. If 2, then don't archive these values. The default value is 2.
    • EnableWelcomePage; integer; Indicates whether plan is enabled for the welcome page. Valid Values: 1:True and 2:False.
    • ForecastTimeLevel; integer; Forecasting time level code used in the plan. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_TIME_LEVEL. Valid values are 1, 2, 3, or 4. This attribute doesn't have a default value.
    • ForecastTimeLevelMeaning; string; Forecasting time level name used in the plan. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_TIME_LEVEL. Valid values are 1 - Days, 2 - Weeks, 3 - Periods, or 4 - Months. This attribute doesn't have a default value.
    • ForecastingCalendar; string; Calendar used in the plan for forecasting.
    • HasRun; integer; Contains one of the following values:1,0,or Empty. If 1, then the most recent plan run finished successfully. If 0, then the most recent plan run failed. If Empty, then the application hasn't run the plan. This attribute has no default value.
    • LastApprovedBy; string; User who performed the most recent approval on the plan.
    • LastApprovedDate; string; Date the user most recently approved the plan.
    • LastRunDate; string; Date the plan ran successfully most recently.
    • LastUpdateDate; string; Date the user most recently updated the plan.
    • LastUpdateLogin; string; Date the user most recently updated the plan.
    • LastUpdatedBy; string; User who performed the most recent plan update.
    • Loaded; integer; Contains one of the following values: 1, 2 or 3. If 1, then the plan is loaded in memory. If 2, then the plan isn't loaded in memory for demand plans. If 3, then the plan isn't loaded in memory for replenishment plans. This attribute doesn't have a default value.
    • LoadedMeaning; string; Contains one of the following values: Yes, No, or NA. If Yes, then the plan is loaded in memory. If No, then the plan isn't loaded in memory for demand plans. If NA, then the plan isn't loaded in memory for replenishment plans. This attribute doesn't have a default value.
    • MeasureCatalog; string; Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
    • MeasureCatalogBicc; integer; Name of the measure catalog used in BICC integration.
    • MeasureCatalogId; integer; Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
    • NotesCount; integer; Value that represents the number of notes created for a plan.
    • OSNObjectPublished; integer; Contains one of the following values: 1 or 2. If 1, then the plan is published in Oracle Social Network. If 2, then the plan isn't published in Oracle Social Network. The default value is 2.
    • ObjectVersionNumber; integer; Implements optimistic locking by incrementing this number each time the row is updated. At the start and end of a transaction, the number is compared to detect if another session has updated the row since it was last queried.
    • PlanApprovalStatusMeaning; string; Contains one of the following values: Approved or null. If Approved, then the plan is approved. If null, then the plan isn't approved. The default value is null.
    • PlanCompletionDate; string; Date and time the plan run was completed.
    • PlanId; integer; Value that uniquely identifies the plan.
    • PlanOwner; string; Name of the user who owns the plan.
    • PlanOwnerName; string; Name of the user who owns the plan.
    • PlanPrivilegeMeaning; string; Access type of the plan. If it's public, then all users can access the plan. If it's private, only the plan owner or users that the plan references can access the plan.
    • PlanStartDate; string; Start date of the plan.
    • PlanTimeLevel; integer; Planning time level code used in the plan. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_MFG, ORA_MSC_TIME_LEVELS_FISCAL, and ORA_MSC_TIME_LEVELS_WTM. Valid values are 1, 2, 3, 4, 5, 6, and 7. This attribute doesn't have a default value.
    • PlanTimeLevelMeaning; string; Planning time level name used in the plan. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_MFG, ORA_MSC_TIME_LEVELS_FISCAL, and ORA_MSC_TIME_LEVELS_WTM. Valid values are Day, Week, Period Month, Quarter, Year, and Hybrid Time Level. This attribute doesn't have a default value.
    • PlanType; integer; Type of plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE. Valid values include 1, 2, 3, 4, and 5. This attribute doesn't have a default value.
    • PlanTypeMeaning; string; Type of plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE. Valid values include 1 - Demand Plan, 2 - Supply Plan, 3 - Demand and Supply Plan, 4 - Sales and Operations Plan, and 5 - Replenishment Plan. This attribute doesn't have a default value.
    • PlanningMode; integer; Mode used for supply planning. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MODE. Valid values are 1, 2, and 3. If 1, then the supply planning mode is constrained. If 2, then supply planning mode is unconstrained. If 3, then supply planning mode is aggregated. This attribute doesn't have a default value.
    • PrivatePlan; integer; Contains one of the following values: 1 or 2. If 1, then the access type of the plan is public. If 2, then the access type of the plan is private. Only the plan owner or users that the plan references can view a private plan. The default value is 1. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS.
    • RecalculateSafetyStock; integer; Contains one of the following values: 1 or 2. If 1, then recalculate safety stock quantity the next time the plan runs. If 2, then don't recalculate.
    • ReferencePlanForExecution; integer; Indicates whether the current plan is used as a reference plan for execution systems.
    • Release; integer; Contains one of the following values: 1 or null. If 1, then plan recommendations are released from the plan. If null, then plan recommendations aren't released from plan.
    • SaveToDb; integer; Contains one of the following values: 2, 3 and null. If 2, then plan is saved without calculating totals, 3 indicates plan is saved calculating totals. Null will be plans where calculating totals during save isn't applicable. Note - this is default flushed as 2 currently, and not used in any process. However, this is still updated and retained since there can be customers who would be using this for custom flows.
    • Saved; integer; Contains one of the following values : 0 and 3. If 0, then plan is run with interactive mode and saved to the database. If 3 , plan is run with batch mode and saved to the database.
    • SopLoadFromDemandPlan; integer; Loads measure values from demand plan to shipments forecast.
    • SrInstanceCode; string; Reference code of the source application instance for an organization included in the plan scope.
    • SrInstanceId; integer; Value identifier of the source application instance of an organization included in plan scope.
    • Status; integer; Status of most recently completed plan run. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE. This attribute doesn't have a default value.
    • StatusMeaning; string; Status of most recently completed plan run. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE. This attribute doesn't have a default value.
    • SupplyPlanningModeMeaning; string; Mode used for supply planning. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MODE. Valid values are 1, 2, or 3. If 1, then the supply planning mode is constrained. If 2, then supply planning mode is unconstrained. If 3, then the supply planning mode is aggregated. This attribute doesn't have a default value.
    • WorkAreaType; integer; Value that identifies the associated work area type.
  • 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 : plans
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : plans-item-response
Type: object
Show Source
  • Contains one of the following values: 1 or null. If 1, then the plan is approved. If null, then the plan isn't approved. The default value is null.
  • Contains one of the following values: 1 or 2. If 1, then release planning recommendations. If 2, then don't release. The default value is 2.
  • Title: Copied From
    Maximum Length: 30
    Name of the base plan that this plan was copied from.
  • ID of the base plan that this plan was copied from.
  • Contains one of the following values: 1 or 2. If 1, then calculate a new safety stock level for each end item when running the plan. If 2, then don't do this calculation.
  • Title: Name
    Maximum Length: 255
    Name of the plan.
  • Maximum Length: 64
    User who created the plan.
  • Date when the user created the plan.
  • Date when the day buckets ends in a planning horizon.
  • Date on which the snapshot process in the plan run completed.
  • Title: Last Run Date
    Date and time when demand planning finished running the plan.
  • Read Only: true
    Date and time when demand planning started running the plan.
  • Title: Description
    Maximum Length: 100
    Description of the plan.
  • Title: Enable for archiving
    Read Only: true
    Contains one of the following values: 1 or 2. If 1, then archive measure values in the plan. If 2, then don't archive these values. The default value is 2.
  • Read Only: true
    Indicates whether plan is enabled for the welcome page. Valid Values: 1:True and 2:False.
  • Title: Forecasting Calendar
    Read Only: true
    Maximum Length: 22
    Calendar used in the plan for forecasting.
  • Title: Forecasting Time Level
    Read Only: true
    Forecasting time level code used in the plan. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_TIME_LEVEL. Valid values are 1, 2, 3, or 4. This attribute doesn't have a default value.
  • Title: Forecasting Time Level
    Read Only: true
    Maximum Length: 80
    Forecasting time level name used in the plan. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_TIME_LEVEL. Valid values are 1 - Days, 2 - Weeks, 3 - Periods, or 4 - Months. This attribute doesn't have a default value.
  • Contains one of the following values:1,0,or Empty. If 1, then the most recent plan run finished successfully. If 0, then the most recent plan run failed. If Empty, then the application hasn't run the plan. This attribute has no default value.
  • Title: Last Approved By
    Maximum Length: 64
    User who performed the most recent approval on the plan.
  • Title: Last Approved Date
    Date the user most recently approved the plan.
  • Title: Last Run Date
    Date the plan ran successfully most recently.
  • Title: Last Updated Date
    Date the user most recently updated the plan.
  • Title: Last Updated By
    Maximum Length: 64
    User who performed the most recent plan update.
  • Maximum Length: 32
    Date the user most recently updated the plan.
  • Links
  • Title: Loaded
    Read Only: true
    Contains one of the following values: 1, 2 or 3. If 1, then the plan is loaded in memory. If 2, then the plan isn't loaded in memory for demand plans. If 3, then the plan isn't loaded in memory for replenishment plans. This attribute doesn't have a default value.
  • Title: Loaded
    Read Only: true
    Maximum Length: 255
    Contains one of the following values: Yes, No, or NA. If Yes, then the plan is loaded in memory. If No, then the plan isn't loaded in memory for demand plans. If NA, then the plan isn't loaded in memory for replenishment plans. This attribute doesn't have a default value.
  • Title: Measure Catalog
    Read Only: true
    Maximum Length: 250
    Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
  • Name of the measure catalog used in BICC integration.
  • Read Only: true
    Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
  • Title: Notes
    Read Only: true
    Value that represents the number of notes created for a plan.
  • Implements optimistic locking by incrementing this number each time the row is updated. At the start and end of a transaction, the number is compared to detect if another session has updated the row since it was last queried.
  • Title: Social
    Read Only: true
    Contains one of the following values: 1 or 2. If 1, then the plan is published in Oracle Social Network. If 2, then the plan isn't published in Oracle Social Network. The default value is 2.
  • Title: Approval Status
    Maximum Length: 80
    Contains one of the following values: Approved or null. If Approved, then the plan is approved. If null, then the plan isn't approved. The default value is null.
  • Title: Last Run Date
    Date and time the plan run was completed.
  • Value that uniquely identifies the plan.
  • Title: Supply Planning Mode
    Mode used for supply planning. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MODE. Valid values are 1, 2, and 3. If 1, then the supply planning mode is constrained. If 2, then supply planning mode is unconstrained. If 3, then supply planning mode is aggregated. This attribute doesn't have a default value.
  • Title: Owner
    Maximum Length: 64
    Name of the user who owns the plan.
  • Title: Owner
    Maximum Length: 100
    Name of the user who owns the plan.
  • Title: Access
    Maximum Length: 80
    Access type of the plan. If it's public, then all users can access the plan. If it's private, only the plan owner or users that the plan references can access the plan.
  • Start date of the plan.
  • Title: Planning Time Level
    Read Only: true
    Planning time level code used in the plan. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_MFG, ORA_MSC_TIME_LEVELS_FISCAL, and ORA_MSC_TIME_LEVELS_WTM. Valid values are 1, 2, 3, 4, 5, 6, and 7. This attribute doesn't have a default value.
  • Title: Planning Time Level
    Read Only: true
    Maximum Length: 80
    Planning time level name used in the plan. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_MFG, ORA_MSC_TIME_LEVELS_FISCAL, and ORA_MSC_TIME_LEVELS_WTM. Valid values are Day, Week, Period Month, Quarter, Year, and Hybrid Time Level. This attribute doesn't have a default value.
  • Type of plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE. Valid values include 1, 2, 3, 4, and 5. This attribute doesn't have a default value.
  • Title: Type
    Maximum Length: 80
    Type of plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE. Valid values include 1 - Demand Plan, 2 - Supply Plan, 3 - Demand and Supply Plan, 4 - Sales and Operations Plan, and 5 - Replenishment Plan. This attribute doesn't have a default value.
  • Title: Access
    Contains one of the following values: 1 or 2. If 1, then the access type of the plan is public. If 2, then the access type of the plan is private. Only the plan owner or users that the plan references can view a private plan. The default value is 1. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS.
  • Contains one of the following values: 1 or 2. If 1, then recalculate safety stock quantity the next time the plan runs. If 2, then don't recalculate.
  • Title: Reference Plan for Fulfillment
    Read Only: true
    Indicates whether the current plan is used as a reference plan for execution systems.
  • Contains one of the following values: 1 or null. If 1, then plan recommendations are released from the plan. If null, then plan recommendations aren't released from plan.
  • Contains one of the following values : 0 and 3. If 0, then plan is run with interactive mode and saved to the database. If 3 , plan is run with batch mode and saved to the database.
  • Contains one of the following values: 2, 3 and null. If 2, then plan is saved without calculating totals, 3 indicates plan is saved calculating totals. Null will be plans where calculating totals during save isn't applicable. Note - this is default flushed as 2 currently, and not used in any process. However, this is still updated and retained since there can be customers who would be using this for custom flows.
  • Loads measure values from demand plan to shipments forecast.
  • Title: Source System
    Read Only: true
    Maximum Length: 255
    Reference code of the source application instance for an organization included in the plan scope.
  • Title: Source System
    Read Only: true
    Value identifier of the source application instance of an organization included in plan scope.
  • Title: Status
    Status of most recently completed plan run. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE. This attribute doesn't have a default value.
  • Maximum Length: 80
    Status of most recently completed plan run. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE. This attribute doesn't have a default value.
  • Title: Supply Planning Mode
    Maximum Length: 80
    Mode used for supply planning. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MODE. Valid values are 1, 2, or 3. If 1, then the supply planning mode is constrained. If 2, then supply planning mode is unconstrained. If 3, then the supply planning mode is aggregated. This attribute doesn't have a default value.
  • Read Only: true
    Value that identifies the associated work area type.
Back to Top