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

Get all plans

get

/fscmRestApi/resources/11.13.18.05/supplyChainPlans

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 Find plans according to the plan identifier.
      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:
    • ArchiveTimeHierarchy; integer; Time hierarchy that the application uses to archive the plan.
    • ArchiveTimeLevel; integer; Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.
    • BasePlanId; integer; Value that uniquely identifies the base plan.
    • BasePlanName; string; Name of the base plan that this plan was copied from.
    • CreatedBy; string; User who created the plan.
    • CreationDate; string; Date when the user created the plan.
    • CutoffDate; string; End date of the planning horizon when planning no longer plans demand or supply.
    • DeleteArchive; integer; Contains one of the following values: 1 or 2. If 1, then delete plan archives that were created before the most recent days to keep during the next plan run. If 2, then don't delete plan archives. The default value is 2.
    • 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.
    • EnableForArchiving; 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.
    • EnableMultithreading; integer; Contains one of the following values: 1 or 2. If 1, then use multithreading when planning supply. If 2, then don't use multithreading. The default value is 1.
    • HasRun; integer; Contains one of the following values. 1: the most recent plan run finished successfully, 0: the most recent plan run failed, or Empty: the application hasn't run the plan. This attribute doesn't have a default value.
    • LastUpdateDate; string; Date when the user most recently updated the plan.
    • LastUpdatedBy; string; User who performed the most recent update on the plan.
    • LoadedStatus; integer; Contains one of the following values: 1 or null. If 1, then the plan is loaded in memory. If null, then the plan isn't loaded in memory. This attribute doesn't have a default value.
    • MeasureCatalogForArchival; integer; Measure catalog that the application uses to archive the plan.
    • MostRecentDaysToKeep; integer; Number of days to keep the archive. The application deletes each archive that's older than the current date minus Most Recent Days to Keep when it creates a new archive.
    • Owner; string; Name of the user who owns the plan.
    • PlanAccess; integer; Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then 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.
    • PlanCompletionDate; string; Date and time when supply planning finished running the plan.
    • PlanHorizonStartDate; string; Date when the plan starts planning demand and supply.
    • PlanId; integer; Value that uniquely identifies the plan.
    • PlanName; string; Name of the plan.
    • PlanStartDate; string; Date and time when supply planning started running the plan.
    • PlanStatus; integer; Status of the plan run that most recently completed. 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.
    • PlanType; integer; Type of plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE. Valid values include Demand Plan, Supply Plan, or Demand and Supply Plan. This attribute doesn't have a default value.
    • ReleaseByUserOnly; integer; Contains one of the following values: 1 or 2. If 1, then only orders within the plan that were marked for release by the user submitting the release plan scheduled process will be released. If 2, then the release plan scheduled process will release all orders that have been marked for release. The default value is 2.
    • SavedOption; integer; This attribute isn't currently used.
    • ShortPlanId; integer; Short value that identifies the plan.
    • SupplyPlanningMode; 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, or 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.
  • 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 : supplyChainPlans
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplyChainPlans-item-response
Type: object
Show Source
Nested Schema : Archives
Type: array
Title: Archives
The Archives resource manages the details that you use to archive a plan. You can use this resource to archive any plan.
Show Source
Nested Schema : Deletes
Type: array
Title: Deletes
The Deletes resource manages the deletion of a plan.
Show Source
Nested Schema : Duplicates
Type: array
Title: Duplicates
The Duplicates resource manages the details that you use to copy a plan. You can use this resource to copy any plan.
Show Source
Nested Schema : Load Measures Jobs
Type: array
Title: Load Measures Jobs
The Load Measures Jobs resource loads measures and copies selected measure data between plans or within a plan.
Show Source
Nested Schema : Metadata Extracts
Type: array
Title: Metadata Extracts
The Metadata Extracts resource gets metadata of business objects from Oracle Supply Chain Planning Cloud applications to enable integration with Oracle Business Intelligence Cloud Connector.
Show Source
Nested Schema : Planning Tables
Type: array
Title: Planning Tables
The Planning Tables resource manages the definition of each pivot table in the Oracle Supply Chain Planning Cloud applications.
Show Source
Nested Schema : Publish Data
Type: array
Title: Publish Data
The Publish Data resource manages the publish details of a plan.
Show Source
Nested Schema : Refresh Measures Jobs
Type: array
Title: Refresh Measures Jobs
The Refresh Measures Jobs resource refreshes data for collected measures in a plan.
Show Source
Nested Schema : Releases
Type: array
Title: Releases
The Releases resource manages the releasing of orders to the source system.
Show Source
Nested Schema : supplyChainPlans-Archives-item-response
Type: object
Show Source
Nested Schema : supplyChainPlans-Deletes-item-response
Type: object
Show Source
Nested Schema : supplyChainPlans-Duplicates-item-response
Type: object
Show Source
  • Determines the plan data to copy. Valid values include 1: copy only plan options, 2: copy plan with reference to base plan, or 3: copy all plan data with no reference to base plan. The default value is 2. A list of accepted values is defined in the lookup type ORA_MSC_COPY_PLAN_TYPES.
  • Status of the scheduled process that duplicates the plan. Valid values include 0: success, 1: in progress, or 2: error. This attribute doesn't have a default value.
  • Date and time when the scheduled process finished running.
  • Value that uniquely identifies the scheduled process.
  • Value that uniquely identifies the scheduled process.
  • Maximum Length: 64
    Sign in that the user used when starting the scheduled process.
  • Contains one of the following values: true or false. If true, then include archives when copying plan data without a reference to base plan. If false, then don't copy archives. The default value is false.
  • Links
  • Contains one of the following values: true or false. If true, then load the plan after the copy finishes. If false, then don't load. The default value is false.
  • Text of the error message that occurred when running the scheduled process.
  • Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then 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.
  • List of users granted access to the new plan that the duplication process created. A comma separates each value.
  • Description of the new plan that the duplication process creates.
  • Value that uniquely identifies the new plan that the duplication process creates.
  • Maximum Length: 255
    List of users granted restricted access to a plan that the duplication process created. A comma separates each value.
  • Name of the new plan that the duplication process creates.
  • Owner of the new plan that the duplication process creates.
  • Plan action that calls the scheduled process. Value for duplicate action is 4: duplicate.
  • Value that uniquely identifies the plan.
  • Date and time when the scheduled process started to run.
Nested Schema : supplyChainPlans-LoadMeasuresJobs-item-response
Type: object
Show Source
Nested Schema : supplyChainPlans-MetadataExtracts-item-response
Type: object
Show Source
  • Columns
    Title: Columns
    The Columns resource gets metadata for columns of the business objects from Oracle Supply Chain Planning Cloud applications to enable integration with Oracle Business Intelligence Cloud Connector.
  • Read Only: true
    Maximum Length: 88
    Value that uniquely identifies the data store that represents a business object.
  • Read Only: true
    Maximum Length: 88
    Name of the data store that represents a business object.
  • Links
Nested Schema : Columns
Type: array
Title: Columns
The Columns resource gets metadata for columns of the business objects from Oracle Supply Chain Planning Cloud applications to enable integration with Oracle Business Intelligence Cloud Connector.
Show Source
Nested Schema : supplyChainPlans-MetadataExtracts-Columns-item-response
Type: object
Show Source
  • Read Only: true
    Maximum length of the column that represents a specific attribute, member value, or a measure expressed as an integer.
  • Read Only: true
    Maximum Length: 128
    Data type of the column that represents a specific attribute, member value or a measure. This can contain values like NUMBER, VARCHAR, DATE, and so on.
  • Read Only: true
    Maximum Length: 5
    Contains one of the following values: true or false. If true, then the column contains the last update date. If false, then column doesn't contain the last update date.
  • Read Only: true
    Maximum Length: 5
    Contains one of the following values: true or false. If true, then the column is part of the natural key. If false, then the column isn't part of the natural key.
  • Read Only: true
    Maximum Length: 5
    Contains one of the following values: true or false. If true, then the column is part of the primary key. If false, then column isn't part of a primary key.
  • Read Only: true
    Maximum Length: 128
    Label of the column that represents a specific attribute, member value, or a measure.
  • Links
  • Read Only: true
    Maximum Length: 128
    Name of the column that represents a specific attribute, member value, or a measure.
  • Read Only: true
    Maximum precision of the column that represents a specific attribute, member value, or a measure expressed as an integer.
  • Read Only: true
    Scale of the column that represents a specific attribute, member value, or a measure expressed as an integer.
  • Read Only: true
    Maximum Length: 128
    Name of the database table that contains the data of the business object for export.
Nested Schema : supplyChainPlans-PlanningTables-item-response
Type: object
Show Source
Nested Schema : Planning Table Data
Type: array
Title: Planning Table Data
The Planning Table Data resource manages the data from each pivot table defined in the Oracle Supply Chain Planning Cloud applications.
Show Source
Nested Schema : supplyChainPlans-PlanningTables-Data-item-response
Type: object
Show Source
  • Value that uniquely identifies the scheduled process for update. This attribute is used only for the POST operation and only when the UpdateMode is Batch.
  • Value that uniquely identifies a set of filter criteria. The filter criteria is used for both query and update of pivot table data. The filter criteria is expressed as a base-64 encoded string of filter conditions using any level members of the pivot table.
  • Links
  • Text of the error message from the table query.
  • Status of the POST Data API query. Contains one of the following values. 0: success, 1: warning, or 2: error.
  • Hierarchy members and measure values that the pivot table contains. The text separates each unique combination of hierarchy member and measure values, and a comma separates each measure value.
  • List of hierarchy level names and the list of measure names that the pivot table contains. A comma separates each value.
  • Names of the hierarchies that the pivot table contains. A comma separates each value.
  • Read Only: true
    Value that uniquely identifies the pivot table.
  • Method used to update the data. Valid values are Interactive and Batch. The default value is Interactive. In the interactive mode, the POST operation is performed synchronously and in batch mode, it's performed asynchronously using a scheduled process. The scheduled process job identifier is returned in the response message. This attribute isn't used in the GET operation.
Nested Schema : supplyChainPlans-PublishData-item-response
Type: object
Show Source
Nested Schema : supplyChainPlans-RefreshMeasuresJobs-item-response
Type: object
Show Source
Nested Schema : supplyChainPlans-Releases-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all plan details.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/supplyChainPlans"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "items" : [ {
    "MeasureCatalogForArchival": 1926
    "MostRecentDaysToKeep": 4,
    "ArchiveTimeHierarchy": 1,
    "ArchiveTimeLevel": 1,
    "BasePlanId": 300100071618784,
    "PlanName": "RI-Plan -B515",
...
  }, {
...
  } ],
...
}
Back to Top