1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Sales and Operations Plans
  5. Runs

Create runs

post

/fscmRestApi/resources/11.13.18.05/salesAndOperationsPlans/{PlanId}/child/Runs

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=
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Contains one of the following values: true or false. If true, then archive the plan before the next plan run. If false, then don't archive. The default value is false. Note that you can archive a plan only if you enable it for archiving. Use the Enable for Archiving attribute in one of the work areas for supply chain planning to enable it.
  • Date and time when the plan run completed.
  • Value that uniquely identifies the process.
  • Maximum Length: 64
    Login that the user used when launching the process.
  • Contains one of the following values: true or false. If true, then include the forecast bookings profile when running the plan. If false, then don't include this profile. The default value is false.
  • List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
  • Contains one of the following values: true or false. If true, then include the forecast shipments profile when running the plan. If false, then don't include this profile. The default value is false.
  • Value that uniquely identifies the scheduled process.
  • Text of the error messages, if any, that occurred when running the scheduled process.
  • Specifies whether data is to be refreshed or not. Valid values are 1 or 3. If 1, then all data is refreshed. If 3, then data isn't refreshed. The default value is 1.
  • Contains one of the following values: true or false. If true, then run the demand planning engine when running a plan. If false, then don't run the demand planning engine when running a plan. The default value is true.
  • Value that uniquely identifies the plan.
  • Contains one of the following values: true or false. If true, then run supply planning when running a plan. If false, then don't run supply planning. The default value is true.
  • Date and time to start the scheduled process.
  • Status of the plan run. Valid values include 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.
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 : salesAndOperationsPlans-Runs-item-response
Type: object
Show Source
  • Contains one of the following values: true or false. If true, then archive the plan before the next plan run. If false, then don't archive. The default value is false. Note that you can archive a plan only if you enable it for archiving. Use the Enable for Archiving attribute in one of the work areas for supply chain planning to enable it.
  • Date and time when the plan run completed.
  • Value that uniquely identifies the process.
  • Maximum Length: 64
    Login that the user used when launching the process.
  • Contains one of the following values: true or false. If true, then include the forecast bookings profile when running the plan. If false, then don't include this profile. The default value is false.
  • List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
  • Contains one of the following values: true or false. If true, then include the forecast shipments profile when running the plan. If false, then don't include this profile. The default value is false.
  • Value that uniquely identifies the scheduled process.
  • Links
  • Text of the error messages, if any, that occurred when running the scheduled process.
  • Specifies whether data is to be refreshed or not. Valid values are 1 or 3. If 1, then all data is refreshed. If 3, then data isn't refreshed. The default value is 1.
  • Contains one of the following values: true or false. If true, then run the demand planning engine when running a plan. If false, then don't run the demand planning engine when running a plan. The default value is true.
  • Value that uniquely identifies the plan.
  • Contains one of the following values: true or false. If true, then run supply planning when running a plan. If false, then don't run supply planning. The default value is true.
  • Date and time to start the scheduled process.
  • Status of the plan run. Valid values include 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.
Back to Top

Examples

This example describes how to create one plan execution.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
servername/fscmRestApi/resources/version/salesAndOperationsPlans/PlanId/child/Runs"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates. 

{
	"Mode": "1",
	"PlanSupplyFlag": true,
	"PlanDemandFlag": true,
	"ForecastProfiles": "Forecast Shipments,Forecast Bookings",
	"ArchivePlanFlag": false
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "PlanId": 300100085385771,
    "ExecutionId": 300100141384568,
    "Status": null,
    "JobId": 115419,
    "StartDate": null,
    "EndDate": null,
    "ExecutionUser": null,
    "PlanDemandFlag": "false",
    "PlanSupplyFlag": "true",
    "Mode": "1",
    "Message": null,
    "ForecastBookingsFlag": "false",
    "ForecastShipmentsFlag": "true",
    "ForecastProfiles": "Forecast Shipments,Forecast Bookings",
    "ArchivePlanFlag": "false",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesAndOperationsPlans/300100085385771/child/Runs/300100141384568",
            "name": "Runs",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesAndOperationsPlans/300100085385771/child/Runs/300100141384568",
            "name": "Runs",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/salesAndOperationsPlans/300100085385771",
            "name": "demandAndSupplyPlans",
            "kind": "item"
        }
    ]
}
Back to Top