REST API for Oracle Supply Chain Management Cloud

Create runs

post

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

Request

Path Parameters

PlanId(required): integer

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:

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ActionParams: string

List of entities to be refreshed. A comma separates each value. Valid values are 2: Demand history and measures, 3: Forecasts, 4: Sales orders, and 6: Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.
ApproveDemandPlanFlag: boolean

Contains one of the following values: 1 or 2. If 1, then automatically approve the demand forecast after running the plan. If 2, then don't approve.
ArchivePlanFlag: boolean

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.
CausalFactorsFlag: boolean

Contains one of the following values: true or false. If true, then include details of the causal factors that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the causal factor group creates.
EndDate: string (date-time)

Date and time when the plan run completed.
ExecutionId: integer (int64)

Value that uniquely identifies the process.
ExecutionUser: string

Maximum Length: 64

Login that the user used when launching the process.
ForceRunFlag: boolean

Contains one of the following values: true or false. If true, then run the plan regardless of the current plan status. If false, then run the plan only if the plan is ready to run. The default value is false.
ForecastBookingsFlag: boolean

Contains one of the following values: 1 or 2. If 1, then include the forecast bookings profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
ForecastMethodsFlag: boolean

Contains one of the following values: true or false. If true, then include details of the forecast methods that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the forecast method creates.
ForecastProfiles: string

List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
ForecastShipmentsFlag: boolean

Contains one of the following values: 1 or 2. If 1, then include the forecast shipments profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
JobId: integer (int64)

Value that uniquely identifies the scheduled process.
Message: string

Text of the error messages, if any, that occurred when running the scheduled process.
Mode: string

Specifies whether data is to be refreshed or not. Contains one of the following values: 1, 2, or 3. If 1, then all data is refreshed. If 2, then only selected entities are refreshed. If 3, then data isn't refreshed. The default value is 1.
PlanDemandFlag: boolean

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.
PlanId: integer

Value that uniquely identifies the plan.
PlanSupplyFlag: boolean

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.
RecalculateSafetyStockFlag: boolean

Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.
SavePlanToDb: string

This attribute isn't currently used.
StartDate: string (date-time)

Date and time to start the scheduled process.
Status: integer (int32)

Status of the 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"integer",
            "description":"Status of the 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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "PlanDemandFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "CausalFactorsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then include details of the causal factors that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the causal factor group creates.",
            "nullable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error messages, if any, that occurred when running the scheduled process.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":false
        },
        "Mode":{
            "type":"string",
            "description":"Specifies whether data is to be refreshed or not. Contains one of the following values: 1, 2, or 3. If 1, then all data is refreshed. If 2, then only selected entities are refreshed. If 3, then data isn't refreshed. The default value is 1.",
            "nullable":true
        },
        "SavePlanToDb":{
            "type":"string",
            "description":"This attribute isn't currently used.",
            "nullable":true
        },
        "RecalculateSafetyStockFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date and time when the plan run completed.",
            "format":"date-time",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date and time to start the scheduled process.",
            "format":"date-time",
            "nullable":true
        },
        "PlanSupplyFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "ForecastBookingsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: 1 or 2. If 1, then include the forecast bookings profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.",
            "nullable":true
        },
        "ApproveDemandPlanFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: 1 or 2. If 1, then automatically approve the demand forecast after running the plan. If 2, then don't approve.",
            "nullable":true
        },
        "ExecutionUser":{
            "maxLength":"64",
            "type":"string",
            "description":"Login that the user used when launching the process.",
            "nullable":false
        },
        "ForecastMethodsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then include details of the forecast methods that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the forecast method creates.",
            "nullable":true
        },
        "ForecastProfiles":{
            "type":"string",
            "description":"List of forecast profiles that the plan run uses. A comma separates each forecast profile name.",
            "nullable":true
        },
        "ForceRunFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then run the plan regardless of the current plan status. If false, then run the plan only if the plan is ready to run. The default value is false.",
            "nullable":true
        },
        "ActionParams":{
            "type":"string",
            "description":"List of entities to be refreshed. A comma separates each value. Valid values are 2: Demand history and measures, 3: Forecasts, 4: Sales orders, and 6: Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.",
            "nullable":true
        },
        "ArchivePlanFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "ForecastShipmentsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: 1 or 2. If 1, then include the forecast shipments profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.",
            "nullable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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.

Root Schema : demandAndSupplyPlans-Runs-item-response

Type: object

Show Source

ActionParams: string

List of entities to be refreshed. A comma separates each value. Valid values are 2: Demand history and measures, 3: Forecasts, 4: Sales orders, and 6: Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.
ApproveDemandPlanFlag: boolean

Contains one of the following values: 1 or 2. If 1, then automatically approve the demand forecast after running the plan. If 2, then don't approve.
ArchivePlanFlag: boolean

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.
CausalFactorsFlag: boolean

Contains one of the following values: true or false. If true, then include details of the causal factors that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the causal factor group creates.
EndDate: string (date-time)

Date and time when the plan run completed.
ExecutionId: integer (int64)

Value that uniquely identifies the process.
ExecutionUser: string

Maximum Length: 64

Login that the user used when launching the process.
ForceRunFlag: boolean

Contains one of the following values: true or false. If true, then run the plan regardless of the current plan status. If false, then run the plan only if the plan is ready to run. The default value is false.
ForecastBookingsFlag: boolean

Contains one of the following values: 1 or 2. If 1, then include the forecast bookings profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
ForecastMethodsFlag: boolean

Contains one of the following values: true or false. If true, then include details of the forecast methods that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the forecast method creates.
ForecastProfiles: string

List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
ForecastShipmentsFlag: boolean

Contains one of the following values: 1 or 2. If 1, then include the forecast shipments profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
JobId: integer (int64)

Value that uniquely identifies the scheduled process.
links: array Links

Title: Links

The link relations associated with the resource instance.
Message: string

Text of the error messages, if any, that occurred when running the scheduled process.
Mode: string

Specifies whether data is to be refreshed or not. Contains one of the following values: 1, 2, or 3. If 1, then all data is refreshed. If 2, then only selected entities are refreshed. If 3, then data isn't refreshed. The default value is 1.
PlanDemandFlag: boolean

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.
PlanId: integer

Value that uniquely identifies the plan.
PlanSupplyFlag: boolean

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.
RecalculateSafetyStockFlag: boolean

Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.
SavePlanToDb: string

This attribute isn't currently used.
StartDate: string (date-time)

Date and time to start the scheduled process.
Status: integer (int32)

Status of the 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"integer",
            "description":"Status of the 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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "PlanDemandFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CausalFactorsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then include details of the causal factors that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the causal factor group creates.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error messages, if any, that occurred when running the scheduled process.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "Mode":{
            "type":"string",
            "description":"Specifies whether data is to be refreshed or not. Contains one of the following values: 1, 2, or 3. If 1, then all data is refreshed. If 2, then only selected entities are refreshed. If 3, then data isn't refreshed. The default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "SavePlanToDb":{
            "type":"string",
            "description":"This attribute isn't currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "RecalculateSafetyStockFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date and time when the plan run completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date and time to start the scheduled process.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PlanSupplyFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastBookingsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: 1 or 2. If 1, then include the forecast bookings profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.",
            "nullable":true,
            "x-queryable":true
        },
        "ApproveDemandPlanFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: 1 or 2. If 1, then automatically approve the demand forecast after running the plan. If 2, then don't approve.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionUser":{
            "maxLength":"64",
            "type":"string",
            "description":"Login that the user used when launching the process.",
            "nullable":false,
            "x-queryable":true
        },
        "ForecastMethodsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then include details of the forecast methods that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the forecast method creates.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastProfiles":{
            "type":"string",
            "description":"List of forecast profiles that the plan run uses. A comma separates each forecast profile name.",
            "nullable":true,
            "x-queryable":true
        },
        "ForceRunFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then run the plan regardless of the current plan status. If false, then run the plan only if the plan is ready to run. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParams":{
            "type":"string",
            "description":"List of entities to be refreshed. A comma separates each value. Valid values are 2: Demand history and measures, 3: Forecasts, 4: Sales orders, and 6: Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ArchivePlanFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastShipmentsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: 1 or 2. If 1, then include the forecast shipments profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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."
        }
    }
}

Examples

This example describes how to create runs.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/PlanId/child/Runs"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplyPlans/300100556447065/child/Runs"

Example Request Body

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

{
 "Mode": 3
}

Example Response Body

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

{
    "PlanId": 300100556447065,
    "ExecutionId": 300100556444873,
    "Status": null,
    "JobId": 260074,
    "StartDate": null,
    "EndDate": null,
    "ExecutionUser": null,
    "Mode": "3",
    "SavePlanToDb": null,
    "ActionParams": null,
    "ForceRunFlag": "false",
    "Message": null,
    "ArchivePlanFlag": "false",
    "RecalculateSafetyStockFlag": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100556447065/child/Runs/300100556444873",
            "name": "Runs",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100556447065/child/Runs/300100556444873",
            "name": "Runs",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100556447065",
            "name": "supplyPlans",
            "kind": "item"
        }
    ]
}