Get one plan

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}

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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : supplyPlans-item-response
Type: object
Show Source
  • Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative item structure or alternative work definition to create each planned order. If 2, then don't allow alternatives.
  • Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative supplier or source organization to create each planned order. If 2, then don't allow alternatives.
  • Analyzing Late Demands
    Title: Analyzing Late Demands
    The root cause for the lateness of an end demand.
  • Maximum Length: 255
    List of demand order types to which the NumberOfDaysForDemandCutoff attribute applies. A comma separates each value. Valid values are 1029: Forecast, 1030: Sales order, and 1008: Manual demand. If the value is null, then no order types are considered for demand cutoff. The default value is null. This attribute is only used if the NumberOfDaysForDemandCutoff attribute is populated.
  • Contains one of the following values: 1 or 2. If 1, then calculate the safety stock for an item and organization combination using policy level overrides. If 2, then don't use policy level overrides when calculating the safety stock. The default value is 2.
  • Contains one of the following values: 1 or 2. If 1, then archive the plan before the next run starts. Note that you can archive the plan only if you enable it for archiving. If 2, then don't archive.
  • Time hierarchy that the application uses to archive the plan.
  • Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.
  • Name of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain when running the plan. You can use the Manage Assignment Sets page in one of the work areas for supply chain planning to set the values you can use with this attribute.
  • 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.
  • Number of time buckets, such as three weeks or two months. This attribute allows a sales order demand to consume forecast demand even if the forecast demand is up to the specified number of time buckets earlier than the sales order demand.
  • Maximum Length: 22
    Abbreviation that identifies the supply planning calendar.
  • Contains one of the following values: 1 or 2. If 1, then apply capacity constraints on all resources. If 2, then apply capacity constraints only on bottleneck resources. A list of accepted values is defined in the lookup type ORA_MSC_CAP_CONST_RESOURCES.
  • Number of compression days that the application can use to release each planned order.
  • Contains one of the following values: 1 or 2. If 1, then keep the consumption process inside of the consumption bucket for each forecast or sales order. If 2, then don't keep it inside the bucket.
  • This attribute isn't currently used.
  • Level of time to use when consuming the forecast such as day, week, or month.
  • Maximum Length: 22
    Calendar to use when consuming the forecast.
  • Number of days after the plan start date when consumption details will be written. Consumption detail records are written for sales orders and transfer order demands that have a due date before the plan start date plus theses number of days after the plan start date.
  • Contains one of the following values: 1 or 2. If 1, then the plan enforces resource and supplier capacity constraints only for critical resources and item suppliers in constrained plans. If 2, then it enforces resources and supplier capacity constraints for bottleneck resources and all item suppliers.
  • End date of the planning horizon when planning no longer plans demand or supply.
  • Date used when planning sales orders. A list of accepted values is defined in the lookup type ORA_MSC_SCHEDULE_DEMANDS_BY.
  • Demand Exceptions
    Title: Demand Exceptions
    Order-based exceptions for demands when only demand-related exceptions are generated by planning. For example, the exception Demand at Risk Due to Insufficient Lead Time for demands that are at risk when they're pegged to supplies with insufficient lead time in the plan.
  • This attribute isn't currently used.
  • This attribute isn't currently used.
  • Collection of demand schedules that the scope of the plan includes. A comma separates each value. Values include Demand Schedule Name, Description, Demand Schedule Type, Demand Plan Output Measure, and Ship to Consumption Level. A set of parentheses encloses each set of demand schedules.
  • Contains one of the following values: 1 or 2. If 1, then use a demand time fence. Ignore forecast demand and consider only sales order demand when calculating the demand requirement. If 2, then don't use a demand time fence. A time fence specifies a boundary between different time frames in the planning horizon. It defines a short time frame that a planning restriction can use to minimize costly disruption on the shop floor and in the supplier schedule.
  • Contains one of the following values: 1 or 2. If 1, then in-transit supplies aren't treated as firmed supplies. If 2, then in-transit supplies are treated as firmed supplies. The default value is 2.
  • Contains one of the following values: 1 or 2. If 1, then archive the plan measures through the archive plan option. If 2, then don't archive measures.
  • Contains one of the following values: 1 or 2. If 1, then the plan enforces lead time constraints for in-transit supplies. If 2, then the plan can compress lead time constraints for in-transit supplies.
  • Contains one of the following values: 1 or 2. If 1, then the plan enforces resource capacity constraints in constrained plans and doesn't overload the resource. If 2, then the plan can overload the resource.
  • Contains one of the following values: 1 or 2. If 1, then the plan enforces supplier capacity constraints in constrained plans and doesn't overload the supplier capacity. If 2, then the plan can overload the supplier capacity.
  • Exception set that the plan references. The exception set determines the exception types that the plan creates.
  • Abbreviation that identifies the time bucket type for the first set of supply planning buckets. Valid values vary based on the supply planning calendar type. If the supply planning calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the supply planning calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the supply planning calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
  • Read Only: true
    Maximum Length: 40
    Meaning associated with the FirstPlanningBucketCode attribute.
  • Number of supply planning buckets to create for the first set of supply planning time buckets. For example, if the FirstPlanningBucketName attribute is Day, this would be the number of daily supply planning buckets that are created when the plan is run.
  • Forecast accuracy measure that the plan uses to calculate safety stock. Contains one of the following values. 1: Mean Absolute Deviation, 2: Mean Absolute Percentage Error, or 3: intermittent. A list of accepted values is defined in the lookup type ORA_MSC_FORECAST_ERROR_TYPE.
  • Number of time buckets, such as three weeks or two months. This attribute allows a sales order demand to consume forecast demand even if the forecast demand is up to the specified number of time buckets later than the sales order demand.
  • This attribute isn't currently used.
  • Contains one of the following values. 1: the most recent plan run finished successfully, or 0: the most recent plan run failed, or Empty: the application hasn't run the plan.
  • Number of days that planning uses to calculate average daily demand.
  • Contains one of the following values: 1 or 2. If 1, then items with no demand other than safety stock are included in the plan. If 2, then items with no demand other than safety stock aren't included in the plan.
  • Contains one of the following values: 1 or 2. If 1, then items with existing supplies, but no demands planned in the supply plan are also included in the plan. If 2, then items with existing supplies, but no demands aren't included in the plan. The default value is 2.
  • Contains one of the following values: 1 or 2. If 1, then the plan is enabled for production monitoring alerts. If 2, then the plan doesn't provide production monitoring alerts.
  • Item Exceptions
    Title: Item Exceptions
    The order-based exceptions for items where only item related exceptions are generated by planning. For example, an exception such as Items below Safety Stock where an exception for items that are below a safety stock level are calculated by the plan.
  • Read Only: true
    Date when the user most recently updated the plan.
  • Links
  • Contains one of the following values: 1 or 2. If 1, then the application loaded the plan into memory. If 2, then the application didn't load the plan into memory.
  • Maximum percent difference to allow between the safety stock quantity in one interval and the next interval.
  • Measure catalog that the application uses to archive the plan.
  • Minimum percent difference to allow between the safety stock quantity in one interval and the next interval.
  • The number of days after the demand date that the demand can be satisfied. This attribute doesn't have a default value.
  • This attribute isn't currently used.
  • Collection of organization names and descriptions that the scope of the plan includes. A comma separates the organization name from the description. A set of parentheses encloses each organization name and description.
  • Safety stock levels that planning can override when the plan runs. Contains one of the following values. 1: all, 2: all except for user defined, or 3: none. A list of accepted values is defined in the lookup type MSC_SAFETY_OVERWRITE.
  • Number of time buckets, such as three weeks or two months. This attribute determines the time period earlier than the plan start date to use as a threshold for copying past due demands into a plan.
  • Level of time to use to determine whether to include a past due demand in a plan such as day, week, or month.
  • Maximum Length: 22
    Calendar to use to determine which past due demands to include in the plan.
  • Number of time buckets, such as three weeks or two months. This attribute determines the time period earlier than the plan start date to use as a threshold for copying past due forecasts into a plan.
  • Number of time buckets, such as three weeks or two months. This attribute determines the time period earlier than the plan start date to use as a threshold for copying past due open sales orders into a plan.
  • Number of time buckets, such as three weeks or two months. This attribute determines the time period earlier than the plan start date to use as a threshold for copying past due shipped sales orders into a plan.
  • Date when the plan starts planning demand and supply.
  • Value that uniquely identifies the plan.
  • List of level values in the item hierarchy to include in the scope of the plan. A comma separates each value.
  • Title: Name
    Maximum Length: 30
    Name of the plan.
  • Planning Demands
    Title: Planning Demands
    The Planning Demands resource manages the demand orders and forecasts that are part of the plan.
  • Planning Supplies
    Title: Planning Supplies
    The Planning Supplies resource manages the supply orders such as work orders and purchase orders that are part of the plan.
  • Contains one of the following values: 1 or 2. If 1, then don't create planned orders within the planning time fence. If 2, then create planned orders.
  • List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.
  • 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.
  • Name of the policy assignment set used in calculating the safety stock. Only applicable when the ApplyPolicyOverrides attribute is 1.
  • List of price lists to consider in the plan. A comma separates each value.
  • Group-by option to use when releasing a planned buy order. Contains one of the following values. 1: all, 2: item, 3: buyer, 4: planner, 5: supplier, 7: category, or 8: location. A list of accepted values is defined in the lookup type ORA_MSC_REQ_LOAD_GROUP_OPT.
  • Resource Exceptions
    Title: Resource Exceptions
    Order-based exceptions for resources generated by planning. For example, the exception Resource Capacity Constraints is generated for resources that are constrained by capacity for planning supplies.
  • Resources
    Title: Resources
    The Resources resource manages the collected resources used as input for the Oracle Supply Chain Planning Cloud solution.
  • Runs
    Title: Runs
    The Runs resource manages run details about supply plan. You can use this resource to run supply plans.
  • Contains one of the following values: 1 or 2. If 1, then smooth safety stock quantity for each item, including items that use the Not MRP Planned safety stock method. If 2, then smooth safety stock quantity for each item that uses the Days of Cover safety stock method.
  • Demand plan that contains the forecast and forecast error measures that the plan uses to calculate safety stock.
  • Contains one of the following values: 1 or 2. If 1, then use the quantity of the calculated safety stock to update collected data. If 2, then don't update collected data.
  • Abbreviation that identifies the time bucket type for the second set of supply planning buckets. Valid values vary based on the supply planning calendar type. If the supply planning calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the supply planning calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the supply planning calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
  • Read Only: true
    Maximum Length: 40
    Meaning associated with the SecondPlanningBucketCode attribute.
  • Number of supply planning buckets to create for the second set of supply planning time buckets. For example, if the SecondPlanningBucketName attribute is Week, this would be the number of weekly supply planning buckets created when the plan is run.
  • Simulation set that planning uses when the plan runs. A simulation set is a set of adjustments that you make to inputs that affect the plan. You can use them to test different business scenarios, such as increasing the available resource capacity.
  • Supplier Exceptions
    Title: Supplier Exceptions
    Order-based exceptions for suppliers, generated by planning. For example, the exception Supplier Capacity Constraints is generated for the item supplier and supplier site combination which is constrained by the capacity for planning supplies.
  • Supply Exceptions
    Title: Supply Exceptions
    Order-based exceptions for supplies when only supply-related exceptions are generated by planning. For example, the exception Orders to be Rescheduled Out for supplies is generated for supplies that have been rescheduled to a date later than their prior due date based on the earliest pegged demands date in the plan.
  • Maximum Length: 250
    List of parameters to override supply engine default behavior. They use the following format: {PARAMETER1}={VALUE1}#{PARAMETER2}={VALUE2}. The number symbol is used to separate each parameter.
  • Specify items to plan during supply planning. Contains one of the following values. 1: all items, 2: demand planned items and sales orders, 5: demand planned items and work-in-process components, 6: demand planned items, or 7: demand planned items, work-in-process components, and sales orders. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_ITEMS.
  • Read Only: true
    Maximum Length: 40
    Name associated with the supply planning calendar.
  • Group-by option to use when releasing a planned transfer order. Contains one of the following values. 1: all, 2: source, destination, and ship date, or 3: source, destination, shipping method, and ship date. A list of accepted values is defined in the lookup type ORA_MSC_TRAN_LOAD_GROUP_OPT.
  • Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative resource to create each planned order. If 2, then don't allow alternative.
  • Contains one of the following values: 1 or 2. If 1, then perform end-item substitution. If 2, then don't perform end-item substitution. The default value is 2.
  • Plan option used to specify whether the planning percentages used for the forecast explosion process in supply planning are from demand planning or the Oracle Product Model: Valid values are 1 or 2. If 1, then planning uses planning percentages from demand planning. If 2, then planning uses planning percentages from the Oracle Product Model.
  • Plan option that enables users to apply different planning percentages for options in an option class to calculate dependent demand. Contains one of the following values: 1 or 2. If 1, then planning allows using different planning percentages for options in an option class. If 2, then planning doesn't allow using different planning percentages for options in an option class.
Nested Schema : Analyzing Late Demands
Type: array
Title: Analyzing Late Demands
The root cause for the lateness of an end demand.
Show Source
Nested Schema : Demand Exceptions
Type: array
Title: Demand Exceptions
Order-based exceptions for demands when only demand-related exceptions are generated by planning. For example, the exception Demand at Risk Due to Insufficient Lead Time for demands that are at risk when they're pegged to supplies with insufficient lead time in the plan.
Show Source
Nested Schema : Item Exceptions
Type: array
Title: Item Exceptions
The order-based exceptions for items where only item related exceptions are generated by planning. For example, an exception such as Items below Safety Stock where an exception for items that are below a safety stock level are calculated by the plan.
Show Source
Nested Schema : Planning Demands
Type: array
Title: Planning Demands
The Planning Demands resource manages the demand orders and forecasts that are part of the plan.
Show Source
Nested Schema : Planning Supplies
Type: array
Title: Planning Supplies
The Planning Supplies resource manages the supply orders such as work orders and purchase orders that are part of the plan.
Show Source
Nested Schema : Resource Exceptions
Type: array
Title: Resource Exceptions
Order-based exceptions for resources generated by planning. For example, the exception Resource Capacity Constraints is generated for resources that are constrained by capacity for planning supplies.
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The Resources resource manages the collected resources used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Runs
Type: array
Title: Runs
The Runs resource manages run details about supply plan. You can use this resource to run supply plans.
Show Source
Nested Schema : Supplier Exceptions
Type: array
Title: Supplier Exceptions
Order-based exceptions for suppliers, generated by planning. For example, the exception Supplier Capacity Constraints is generated for the item supplier and supplier site combination which is constrained by the capacity for planning supplies.
Show Source
Nested Schema : Supply Exceptions
Type: array
Title: Supply Exceptions
Order-based exceptions for supplies when only supply-related exceptions are generated by planning. For example, the exception Orders to be Rescheduled Out for supplies is generated for supplies that have been rescheduled to a date later than their prior due date based on the earliest pegged demands date in the plan.
Show Source
Nested Schema : supplyPlans-AnalyzingLateDemands-item-response
Type: object
Show Source
Nested Schema : supplyPlans-DemandExceptions-item-response
Type: object
Show Source
  • Title: Action Taken
    Read Only: true
    Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
  • Title: Available Lead Time
    Read Only: true
    Number that represents the available lead time of the supply in the exception.
  • Title: Category
    Read Only: true
    Maximum Length: 4000
    Category of the demand's item in the exception. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.
  • Title: Constrained Date
    Read Only: true
    Value that represents the constrained date of the resource or the supplier capacity in the exception.
  • Title: Currency
    Read Only: true
    Maximum Length: 4000
    Code for the currency of the demand's organization in the exception.
  • Title: Customer
    Read Only: true
    Maximum Length: 4000
    Name of the customer in the demand in the exception.
  • Read Only: true
    Value that uniquely identifies the customer in the exception.
  • Title: Customer Site
    Read Only: true
    Maximum Length: 4000
    Name of the customer site in the demand in the exception.
  • Read Only: true
    Value that uniquely identifies the customer site in the exception.
  • Title: Days Late
    Read Only: true
    Number that represents the number of days a demand is satisfied late or a supply pegged to a demand is late or number of days a demand is past due. Based on the exception, the days late provides the details.
  • Title: Demand Class
    Read Only: true
    Maximum Length: 4000
    Demand class associated with the demand in the exception.
  • Read Only: true
    Value that uniquely identifies the demand in the exception.
  • Title: Demand Line Number
    Read Only: true
    Maximum Length: 250
    Line number of the demand in the exception.
  • Title: Demand Order Number
    Read Only: true
    Maximum Length: 4000
    Order number of the demand in the exception.
  • Title: Demand Order Type
    Read Only: true
    Maximum Length: 4000
    Type of order of the demand in the exception. For example, the type of demand order could be a sales order or a forecast.
  • Title: Demand Quantity
    Read Only: true
    Quantity of the demand in the exception.
  • Title: Demand Satisfied Date
    Read Only: true
    Date in the exception when the demand quantity is completely satisfied.
  • Read Only: true
    Value that uniquely identifies the department or the work center of a resource in the exception.
  • Title: Exception
    Read Only: true
    Maximum Length: 120
    Name of an exception.
  • Read Only: true
    Value that uniquely identifies the demand exception detail.
  • Read Only: true
    Number that uniquely identifies an exception.
  • Title: Exception Value
    Read Only: true
    Number that represents the value of the delay, or the value of the unplanned portion, or the value of the demand quantity, or a part of the demand quantity in the exception.
  • Read Only: true
    Value that uniquely identifies the demand's item in the exception.
  • Title: Item
    Read Only: true
    Maximum Length: 4000
    Name of the item in the demand in the exception.
  • Title: Item Description
    Read Only: true
    Maximum Length: 4000
    Description of the item in the demand in the exception.
  • Title: Last Update Date
    Read Only: true
    Date when the exception detail was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the exception detail.
  • Links
  • Title: Maturity Date
    Read Only: true
    Date of maturity of the supply pegged to the demand in the exception.
  • Title: MTQ Supply Date
    Read Only: true
    The supply date of the minimum transfer quantity (MTQ) of the supply pegged to the demand in the exception
  • Title: Notes
    Read Only: true
    Contains information created or updated for an exception detail represented as notes.
  • Title: Order Date
    Read Only: true
    Date of the demand in the exception.
  • Title: Order Value
    Read Only: true
    Order value of the demand in the exception.
  • Title: Organization
    Read Only: true
    Maximum Length: 4000
    Name of the demand's organization in the exception.
  • Read Only: true
    Value that uniquely identifies the demand's organization in the exception.
  • Title: Partial Planned Quantity
    Read Only: true
    Partial planned quantity of the demand in the exception.
  • Title: Pegged Quantity
    Read Only: true
    Pegged quantity of the supply to the demand in the exception.
  • Read Only: true
    Value that uniquely identifies the plan in which exception is generated.
  • Title: Planner
    Read Only: true
    Maximum Length: 4000
    Name of the planner associated with the demand's item in the exception.
  • Title: Planner Description
    Read Only: true
    Maximum Length: 4000
    Description of the planner associated with the demand's item in the exception.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 10 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 11 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 12 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 13 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 14 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 15 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 3 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 4 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 5 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 6 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 7 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 8 associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 9 associated with the demand in the exception in an attribute-based plan.
  • Title: Priority
    Read Only: true
    Priority of the demand in the exception.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the project group associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the project associated with the demand in the exception in an attribute-based plan.
  • Title: Quantity Mismatch
    Read Only: true
    Number that represents the unsatisfied quantity of the demand in the exception.
  • Title: Quantity Satisfied by Demand Date
    Read Only: true
    Number that represents the quantity of the demand satisfied by the demand order date in the exception.
  • Title: Required Lead Time
    Read Only: true
    Number that represents the lead time required by the supply pegged to the demand in the exception.
  • Title: Resource Code
    Read Only: true
    Maximum Length: 4000
    Name of the resource in the demand exception.
  • Read Only: true
    Value that uniquely identifies the resource in the demand exception.
  • Title: Resource Organization
    Read Only: true
    Maximum Length: 4000
    Name of the organization of the resource in the demand exception.
  • Title: Start Date
    Read Only: true
    Start date in the demand exception. For example, the plan start date in the Late Replenishment for Sales Order exception.
  • Title: Supplier
    Read Only: true
    Maximum Length: 4000
    Name of the supplier in the demand exception.
  • Read Only: true
    Value that uniquely identifies the supplier in the demand exception.
  • Title: Supplier Item
    Read Only: true
    Maximum Length: 4000
    Supplier item in the demand exception.
  • Title: Supplier Item Description
    Read Only: true
    Maximum Length: 4000
    Supplier item description in the demand exception.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 4000
    Name of the supplier site in the demand exception.
  • Read Only: true
    Value that uniquely identifies the supplier site in the demand exception.
  • Title: Supply Due Date
    Read Only: true
    Due date of the supply in the demand exception.
  • Title: Supply Item
    Read Only: true
    Maximum Length: 4000
    Name of the supply's item pegged to the demand in the demand exception.
  • Title: Supply Item Description
    Read Only: true
    Maximum Length: 4000
    Description of the supply's item pegged to the demand in the demand exception.
  • Title: Supply Line Number
    Read Only: true
    Maximum Length: 50
    Line number of the supply in the demand exception.
  • Title: Supply Order Demand Due Date
    Read Only: true
    Due date of the supply order demand in the demand exception.
  • Title: Supply Order Number
    Read Only: true
    Maximum Length: 240
    Order number of the supply in the demand exception.
  • Title: Supply Order Type
    Read Only: true
    Maximum Length: 4000
    Type of order of the supply in the demand exception. For example, a planned order or a work order.
  • Title: Supply Organization
    Read Only: true
    Maximum Length: 4000
    Name of the supply organization in the demand exception.
  • Title: Supply Quantity
    Read Only: true
    Number that represents the quantity of the supply in the demand exception.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the task associated with the demand in the exception in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the supply in the demand exception.
  • Title: Work Center
    Read Only: true
    Maximum Length: 4000
    Name of the work center of the resource in the demand exception.
Nested Schema : supplyPlans-ItemExceptions-item-response
Type: object
Show Source
  • Title: Action Taken
    Read Only: true
    Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
  • Title: Category
    Read Only: true
    Maximum Length: 4000
    Category of the item in the exception. the category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.
  • Title: Currency
    Read Only: true
    Maximum Length: 4000
    Code for the currency of the demand's organization in the exception.
  • Title: Days of Excess
    Read Only: true
    Number of days of excess inventory calculated by the plan in an item with excess inventory exception.
  • Title: Days of Shortage
    Read Only: true
    Number of days of shortage of supply for an item calculated by the plan in an items with a shortage exception.
  • Title: Exception
    Read Only: true
    Maximum Length: 34
    Name of an exception.
  • Read Only: true
    Value that uniquely identifies the item exception detail.
  • Read Only: true
    Number that uniquely identifies an exception.
  • Title: Exception Quantity
    Read Only: true
    Number that represents the quantity of supply in an item exception. This represents the shortage quantity in the item with a shortage exception, the quantity below safety sock in items below safety stock, the quantity of excess in item with excess inventory exception, and the expired quantity in items with expired lot exception.
  • Read Only: true
    Value that uniquely identifies the item stored item exception.
  • Title: Expiration Date
    Read Only: true
    Date of expiration of an on hand lot in items with expired lot exceptions.
  • Title: From Date
    Read Only: true
    Effective start date of an exception detail calculated by the plan.
  • Read Only: true
    Value that uniquely identifies the item in the exception.
  • Title: Item
    Read Only: true
    Maximum Length: 4000
    Name of the item in the exception.
  • Title: Item Description
    Read Only: true
    Maximum Length: 4000
    Description of the item in the demand in the exception.
  • Title: Last Update Date
    Read Only: true
    Date when the exception detail was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the exception detail.
  • Links
  • Title: Lot Number
    Read Only: true
    Maximum Length: 80
    Name of the lot of the on hand in an exception detail.
  • Title: Notes
    Read Only: true
    Contains information created or updated for an exception detail represented as notes.
  • Title: Organization
    Read Only: true
    Maximum Length: 4000
    Name of the organization of an item for which an exception was calculated by the plan.
  • Read Only: true
    Value that uniquely identifies the organization of an item in the exception
  • Read Only: true
    Value that uniquely identifies the plan in which exception is generated.
  • Title: Planner
    Read Only: true
    Maximum Length: 10
    Name of the planner associated with the item in the exception.
  • Title: Planner Description
    Read Only: true
    Maximum Length: 4000
    Description of the planner associated with the item in the exception.
  • Title: Projected Available Balance
    Read Only: true
    Number that represents the projected available balance of the item in the exception.
  • Title: Safety Stock Target
    Read Only: true
    Number that represents the target level of the safety stock for an item in an organization in the exception.
  • Title: Subinventory
    Read Only: true
    Maximum Length: 80
    Name of the subinventory of on hand for an item in exception.
  • Title: To Date
    Read Only: true
    Effective end date of an exception detail calculated by the plan.
  • Title: Value of Shortage
    Read Only: true
    Name that represents the value of the shortage quantity of supply for an item that's in an exception.
Nested Schema : supplyPlans-PlanningDemands-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 80
    Value that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values include None, Cancel, Reschedule in, Reschedule out, Release, Release reservation, and Reschedule and release reservation. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
  • Read Only: true
    Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS.
  • Title: Asset
    Read Only: true
    Maximum Length: 80
    Number that identifies the asset associated with a maintenance work order.
  • Value that uniquely identifies the sequence in which a component is used within an operation.
  • Name of the item type. Valid values include 1: Model, 2: Option Class, 3: Planning, 4: Standard, and 5: Product Family. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE.
  • Title: Bucket Type
    Read Only: true
    Maximum Length: 7
    Time bucket used for forecast demands. Valid values include Day, Month, Period, or Week. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_GREGORIAN and ORA_MSC_TIME_LEVELS_MFG.
  • Title: Buyer
    Read Only: true
    Name of the buyer associated with the item.
  • Title: Category
    Read Only: true
    Maximum Length: 4000
    Name of the category to which the item is assigned.
  • Title: Component Quantity Issued
    Read Only: true
    Quantity of a component issued to a work order.
  • Read Only: true
    Maximum Length: 64
    User who created the order.
  • Read Only: true
    Date when the user created the order.
  • Title: Customer
    Maximum Length: 4000
    Name of the customer associated with the sales order or forecast.
  • Value that uniquely identifies the customer.
  • Title: Customer Site
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Value that uniquely identifies the customer site.
  • Title: Days Late
    Read Only: true
    Number of days that the demand is late.
  • Title: Days Past Due
    Read Only: true
    Number of days that the demand date is in the past.
  • Read Only: true
    Maximum Length: 34
    Classification of demand used to track and consume different types of demand. Review and update the value for this attribute using the Manage Demand Classes task.
  • Title: Demand Class
    Maximum Length: 400
    Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS.
  • Title: Order Priority
    Priority of the demand.
  • Title: Destination Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the destination organization of an order.
  • Read Only: true
    Monetary value associated with the end demand.
  • End Pegged Supplies
    Title: End Pegged Supplies
    The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand.
  • Read Only: true
    Maximum Length: 100
    Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination.
  • Title: Firm Date
    Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
  • Title: Firm Status
    Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Firm Quantity
    Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Read Only: true
    Maximum Length: 200
    Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Fulfillment Line
    Read Only: true
    Fulfillment line number associated with a sales order.
  • Title: Implement Date
    Date when the order is implemented.
  • Title: Implement Demand Class
    Maximum Length: 30
    Demand class associated with the order that will be used when the order is released.
  • Title: Implemented Quantity
    Cumulative quantity that has been released to date.
  • Title: Implement Firm
    Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.
  • Read Only: true
    Maximum Length: 200
    Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Implement Quantity
    Order quantity for the released order.
  • Title: Implement Ship Date
    Date when the order is shipped.
  • Maximum Length: 30
    Value that identifies the shipping method used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Implement Shipping Method
    Maximum Length: 400
    Value that indicates the shipping method used to ship the order when the order is released, or is a concatenation of carrier name, method of transportation, and service level used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Implement Source Organization
    Read Only: true
    Maximum Length: 100
    Source organization for the released order.
  • Value that uniquely identifies the item.
  • Title: Item
    Maximum Length: 300
    Name of the item associated with the demand.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item associated with the demand.
  • Read Only: true
    Date when the demand was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the demand.
  • Title: Latest Acceptable Date
    Read Only: true
    Date beyond which the demand line must not be promised.
  • Title: Line Number
    Read Only: true
    Maximum Length: 100
    Line number associated with the demand.
  • Links
  • Title: Lot
    Read Only: true
    Maximum Length: 80
    Lot number associated with an expired on-hand lot.
  • Read Only: true
    Maximum Length: 200
    Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Value that indicates the release status of the order. Valid values are 1: Marked For Release, 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
  • Title: Material Available Date
    Read Only: true
    Date when the total quantity is available.
  • Read Only: true
    Text of the error message, if any, encountered when creating or updating a demand.
  • Value that uniquely identifies the mode of transportation used to ship a demand line from the ship-from organization or drop ship supplier to the customer site. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_MODE_OF_TRANSPORT.
  • Title: Need-by Date
    Read Only: true
    Date by when the demand quantity is needed.
  • Title: Old Due Date
    Read Only: true
    Date when the demand quantity was originally due. This attribute value is extracted from the source application.
  • Title: Order Date Type
    Read Only: true
    Maximum Length: 4000
    Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include Ship date or Arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
  • Read Only: true
    Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include: 1 where customer has specified a requested ship date or 2 where customer has specified a requested arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
  • Title: Order Number
    Read Only: true
    Maximum Length: 4000
    Order number associated with the sales order.
  • Title: Order Quantity
    Read Only: true
    Quantity associated with the demand.
  • Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Order Type
    Maximum Length: 4000
    Value that indicates the type of order such as sales order or forecast. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Organization
    Maximum Length: 49
    Name of the organization associated with the order.
  • Value that uniquely identifies the organization.
  • Title: Organization Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone of the organization associated with the demand.
  • Read Only: true
    Maximum Length: 100
    Abbreviation that identifies the base currency of the organization.
  • Title: Original Item Quantity
    Read Only: true
    Demand quantity of the original item, which may be different from the order quantity, if substitution is allowed.
  • Title: Original Need-by Date
    Read Only: true
    Date when the order is needed. This value is extracted from the source application.
  • Title: Original Order Quantity
    Read Only: true
    Quantity associated with the order. This value is extracted from the source application.
  • Title: Override Demand Priority
    Override priority of end demands such as sales order, forecast, and manual demand.
  • Title: Parent Model
    Read Only: true
    Maximum Length: 200
    Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option.
  • Pegged Supplies
    Title: Pegged Supplies
    The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand.
  • Value that uniquely identifies the plan.
  • Title: Planned Arrival Date
    Read Only: true
    Date when the item will arrive. The attribute value is calculated using the suggested ship date, carrier calendar, in-transit lead time, and the receiving calendar.
  • Title: Planner
    Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Title: Planner Description
    Read Only: true
    Maximum Length: 100
    Description of the planner responsible for the item.
  • Planning Attributes
    Title: Planning Attributes
    The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
  • Title: Make or Buy
    Read Only: true
    Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Maximum Length: 4000
    Value that identifies the project group.
  • Maximum Length: 4000
    Value that identifies the project.
  • Title: Promised Arrival Date
    Read Only: true
    Date when a customer has been promised the delivery of the order.
  • Title: Promised Ship Date
    Read Only: true
    Date when a customer has been promised the shipping of the order.
  • Title: Quantity by Due Date
    Read Only: true
    Quantity that can be provided by the due date. For example, the order quantity may be 100 units, but only 50 units may be available by the due date.
  • Title: Quantity in Process
    Read Only: true
    Quantity that's in process of being released.
  • Read Only: true
    Maximum Length: 400
    Errors that are generated in the release process.
  • Title: Release Status
    Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
  • Read Only: true
    Maximum Length: 80
    Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
  • Title: Requested Arrival Date
    Read Only: true
    Date when the material must arrive at the customer site.
  • Title: Requested Item
    Read Only: true
    Maximum Length: 4000
    Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand.
  • Title: Requested Ship Date
    Read Only: true
    Date when the material must be shipped out to the customer.
  • Read Only: true
    Maximum Length: 200
    Value that indicates whether the order has been rescheduled or not. Contains one of the following values: 1 or 2. If 1, then the order has been rescheduled. If 2, then the order hasn't been rescheduled.
  • Title: Reserved Quantity
    Read Only: true
    Quantity that has been reserved against an order.
  • Title: Scheduled Arrival Date
    Read Only: true
    Date when the demand has been scheduled to arrive at a customer site.
  • Title: Scheduled Ship Date
    Read Only: true
    Date when the demand has been scheduled to be shipped.
  • Title: Schedule Name
    Read Only: true
    Maximum Length: 4000
    Name of the supply or demand schedule associated with an order.
  • Title: Segment
    Read Only: true
    Maximum Length: 120
    Name of the segment used for a set of items.
  • Read Only: true
    Selling price of an item on the order line.
  • Value that uniquely identifies the service level to use to ship a demand line from the ship-from organization or drop ship supplier to the customer site. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_SERVICE_LEVELS.
  • Read Only: true
    Maximum Length: 15
    Shipping calendar associated with the order.
  • Maximum Length: 30
    Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Shipping Method
    Maximum Length: 4000
    Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Ship To
    Read Only: true
    Maximum Length: 4000
    Abbreviation that indicates the specific ship-to location.
  • Value that uniquely identifies the simulation set used in the plan, if any.
  • Title: Source Order
    Read Only: true
    Maximum Length: 50
    Value that identifies the order number in the source application against which fulfillment line has been created.
  • Title: Source Order Line
    Read Only: true
    Maximum Length: 50
    Value that identifies the order line number in the source application against which fulfillment line has been created.
  • Title: Source Organization
    Maximum Length: 49
    Organization that will source the order.
  • Value that uniquely identifies the source organization.
  • Title: Source Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
  • Title: Suggested Due Date
    Read Only: true
    Date when the demand is recommended to be completed.
  • Title: Suggested Order Date
    Read Only: true
    Date when the order is recommended to be placed.
  • Title: Suggested Ship Date
    Read Only: true
    Date when the order is recommended to be shipped.
  • Title: Supplier
    Maximum Length: 4000
    Name of the source supplier.
  • Value that uniquely identifies the supplier.
  • Title: Supplier Site
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier ship-from location.
  • Value that uniquely identifies the supplier site.
  • Maximum Length: 4000
    Value that identifies task.
  • Value that uniquely identifies the demand. This value is internally generated by the application.
  • Title: Transit Lead Time
    Read Only: true
    Number of days that the demand is in transit between two locations.
  • Title: Unit Number
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number.
  • Title: Unmet Demand Quantity
    Read Only: true
    Quantity of demand that's not satisfied.
  • Read Only: true
    Maximum Length: 200
    Name of the unit of measure that's associated with the order quantity.
  • Title: UOM
    Read Only: true
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • Title: Using Assembly
    Maximum Length: 4000
    For component demands, this field refers to the assembly item that uses this item as a component.
  • Title: Zone
    Read Only: true
    Maximum Length: 400
    Region or zone where the demand quantity is being shipped.
Nested Schema : End Pegged Supplies
Type: array
Title: End Pegged Supplies
The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand.
Show Source
Nested Schema : Pegged Supplies
Type: array
Title: Pegged Supplies
The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand.
Show Source
Nested Schema : Planning Attributes
Type: array
Title: Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
Show Source
Nested Schema : supplyPlans-PlanningDemands-EndPeggedSupplies-item-response
Type: object
Show Source
Nested Schema : supplyPlans-PlanningDemands-PeggedSupplies-item-response
Type: object
Show Source
Nested Schema : supplyPlans-PlanningDemands-PlanningAttributes-item-response
Type: object
Show Source
Nested Schema : supplyPlans-PlanningSupplies-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 80
    Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
  • Read Only: true
    Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS.
  • Maximum Length: 4000
    Name of the alternate bill of material.
  • Maximum Length: 400
    Name of a routing used for the make order.
  • Title: Alternate Facility Used
    Read Only: true
    Value that indicates whether the planned order uses an alternate facility or not.
  • Title: Alternate Resource Used
    Read Only: true
    Value that indicates whether the planned order uses an alternate resource or not.
  • Title: Alternate Supplier Used
    Read Only: true
    Value that indicates whether the planned order uses an alternate supplier or not.
  • Title: Alternate Work Definition Used
    Read Only: true
    Value that indicates whether the planned order uses an alternate work definition or not.
  • Title: Asset
    Read Only: true
    Maximum Length: 80
    Number that identifies the asset associated with a maintenance work order.
  • Title: Batch Quantity
    Read Only: true
    Quantity that moves through operations in a process work order.
  • Title: Batch Quantity UOM
    Read Only: true
    Maximum Length: 30
    Identifies the unit of measure for the batch quantity in a process work definition.
  • Value that uniquely identifies the sequence in which a component is used within an operation.
  • Title: Buyer-Managed Transportation
    Read Only: true
    Contains one of the following values: 1 or 2. If 1, then the buyer is responsible for the transportation of the purchased item. If 2, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.
  • Read Only: true
    Name of the type of item. Valid values include 1: Model, 2: Option Class, 3: Planning, 4: Standard, or 5: Product Family. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE.
  • Title: Buyer
    Read Only: true
    Name of the buyer associated to the item.
  • Read Only: true
    Maximum Length: 200
    Contains one of the following values: Yes or No. If Yes, then the buyer is responsible for the transportation of the purchased item. If No, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.
  • Read Only: true
    Value that indicates whether the supply has been canceled.
  • Value that uniquely identifies the carrier.
  • Title: Category
    Read Only: true
    Maximum Length: 4000
    Name of the category to which the item is assigned.
  • Title: Completed Quantity
    Read Only: true
    Quantity of the work order that's already completed.
  • Title: Component Quantity Issued
    Read Only: true
    Quantity of a component issued to a work order.
  • Title: Compression Days
    Read Only: true
    Number of days prior to the plan start date that the order has to be scheduled to be considered on time.
  • Read Only: true
    Maximum Length: 64
    User who created the order.
  • Read Only: true
    Date when the user created the order.
  • Read Only: true
    Name of the column that contains the cumulative yield. For example, the name of the column in the Supplies and Demands view. This column is the product of operation yields of all the operations in the work definition of an item.
  • Title: Customer
    Maximum Length: 4000
    Name of the customer associated with the drop ship purchase order.
  • Value that uniquely identifies the customer.
  • Title: Customer Site
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Value that uniquely identifies the customer site.
  • Title: Days Past Due
    Read Only: true
    Number of days that the supply date is in the past.
  • Title: Destination Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the destination organization for an order.
  • Title: Earliest Start Date
    Read Only: true
    Earliest date on which a supply can start based on the lead times of all its upstream supplies, or its planning time-fence date, or based on the constrained capacity of a resource or supplier. This date is calculated by constraint-based plans
  • Title: Expected Scrap Quantity
    Read Only: true
    Quantity of the work order or planned order that's expected to be scrapped in addition to the quantity already scrapped.
  • Read Only: true
    Maximum Length: 100
    Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination.
  • Title: Expiration Date
    Date when the existing lot associated with the supply expires.
  • Read Only: true
    Contains one of the following values: 1 or 2. If 1, then the make order has an associated firm component. If 2, then the make order doesn't have an associated firm component.
  • Title: Firm Date
    Date when supply is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
  • Title: Firm Status
    Value that indicates whether the order is firmed or not. Valid values are 1 or 2. If 1, then the order is firm. If 2, then the order isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Firm Quantity
    Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Read Only: true
    Contains one of the following values: 1 or 2. If 1, then the make order has an associated firm resource. If 2, then the make order doesn't have an associated firm resource.
  • Date when supply begins. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
  • Title: Firm Start Quantity
    User-specified start quantity of a supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Read Only: true
    Maximum Length: 200
    Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Hold Date
    Read Only: true
    Date on which the on-hand inventory lot is no longer on hold.
  • Maximum Length: 100
    Name of an alternate, nonprimary item structure that will be used when the order is released.
  • Maximum Length: 100
    Name of a routing that will be used when the order is released.
  • Title: Implement Order Type
    Value that indicates the type of order to be implemented. Valid values are 1: None, 2: Purchase requisition, 3: Work order, or 5: Internal requisition. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS.
  • Title: Implement Date
    Date when the order is released.
  • Title: Implement Dock Date
    Date when the material should be on the receiving dock when the order is released.
  • Title: Implemented Quantity
    Cumulative quantity that has been released to date.
  • Title: Implement Firm
    Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.
  • Read Only: true
    Maximum Length: 200
    Status to use when the order is released. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Implement Item Structure Name
    Maximum Length: 4000
    Name of the item structure for the order that's released.
  • Title: Implement Work Order Number
    Maximum Length: 120
    Job name of the work order to be created when the order is released.
  • Title: Implement Location
    Maximum Length: 400
    Value that identifies the deliver-to location to use when the order is released.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the type of order to use when the order is released. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS.
  • Title: Implement Quantity
    Quantity of the order that's released.
  • Title: Implement Ship Date
    Date when the order is shipped.
  • Maximum Length: 30
    Value that indicates the shipping method to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Implement Shipping Method
    Maximum Length: 400
    Value that indicates the shipping method to use when the order is released, or is a concatenation of carrier name, method of transportation, and service level to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Implement Source Organization
    Maximum Length: 100
    Source organization used for the order that's released.
  • Read Only: true
    Maximum Length: 200
    Status of the order to use when the order is released. Valid Values are Unreleased or Released.
  • Title: Implement Status
    Abbreviation that identifies the status to use when the order is released. Valid values are 1 or 3. If 1, then the order isn't released. If 3, then the order is released.
  • Title: Implement Supplier
    Maximum Length: 360
    Name of the supplier for the order that's released.
  • Title: Implement Supplier Site
    Maximum Length: 300
    Abbreviation that indicates the specific supplier ship-from location to use when the order is released.
  • Title: Implement Work Order Subtype
    Maximum Length: 40
    Value that indicates the subtype of the work order to be implemented. Valid values are 1: Standard production, 2: Repair, 3: Prototype, 4: Pilot lot, or 5: Test lot. A list of accepted values is defined in the lookup type ORA_MSC_WO_SUB_TYPE.
  • Title: Implement Work Definition Name
    Maximum Length: 4000
    Name of the work definition that's used when the order is released.
  • Read Only: true
    Maximum Length: 200
    Meaning associated with the ImplementWIPClassCode attribute.
  • Value that uniquely identifies the item.
  • Title: Item
    Maximum Length: 300
    Name of the item associated with the supply.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item that's associated with the supply.
  • Title: Item Structure Name
    Maximum Length: 100
    Name of the item structure planned to be used for the make order.
  • Read Only: true
    Date when the order was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the supply.
  • Title: Latest Start Date
    Read Only: true
    Latest date on which a supply can start. This date is computed by offsetting the lead time of the supply from its need-by date. This date is calculated by constraint-based plans.
  • Title: Line Number
    Read Only: true
    Maximum Length: 100
    Number that identifies the order line.
  • Links
  • Title: Lot
    Read Only: true
    Maximum Length: 80
    Number that identifies the lot of the on-hand supply.
  • Read Only: true
    Maximum Length: 100
    Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
  • Title: Maturity Date
    Read Only: true
    Date when an inventory lot fully matures. It can then be used to fulfill demand.
  • Read Only: true
    Text of the error message, if any, encountered when creating or updating a supply.
  • Value that uniquely identifies the mode of transportation that's planned to be used to ship an order from the source organization or supplier. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_MODE_OF_TRANSPORT.
  • Title: MTQ Supply Date
    Read Only: true
    Date when the first minimum transfer quantity supply of the upstream process is available for the downstream process.
  • Title: Need-by Date
    Read Only: true
    Date when the supply quantity is needed.
  • Title: Old Dock Date
    Read Only: true
    Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application.
  • Title: Old Due Date
    Read Only: true
    Date when the order was originally due. This attribute value is extracted from the source application.
  • Title: Order Number
    Read Only: true
    Maximum Length: 4000
    Number that identifies the order associated with the supply.
  • Title: Order Quantity
    Read Only: true
    Quantity associated with the supply.
  • Read Only: true
    Maximum Length: 200
    SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.
  • Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Order Type
    Maximum Length: 4000
    Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Organization
    Maximum Length: 49
    Name of the organization associated with the order.
  • Value that uniquely identifies the organization.
  • Title: Organization Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with an organization.
  • Read Only: true
    Abbreviation that identifies the base currency of the organization.
  • Title: Requested Item
    Read Only: true
    Maximum Length: 4000
    Name of the requested item associated with the demand.
  • Title: Original Need-by Date
    Read Only: true
    Date when the order was originally needed. This value is extracted from the source application.
  • Title: Original Order Quantity
    Read Only: true
    Original quantity associated with the order. This value is extracted from the source application.
  • Title: Parent Model
    Read Only: true
    Maximum Length: 200
    Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option.
  • Pegged Demands
    Title: Pegged Demands
    The Pegged Demands resource manages all the demands that are pegged to a specific planning supply at the same level.
  • Value that uniquely identifies the plan.
  • Title: Planner
    Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Title: Planner Description
    Read Only: true
    Maximum Length: 100
    Description of the planner responsible for the item.
  • Planning Attributes
    Title: Planning Attributes
    The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
  • Title: Make or Buy
    Read Only: true
    Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Title: Process Name
    Read Only: true
    Maximum Length: 120
    Name of the manufacturing process used for this work order or planned order.
  • Value that uniquely identifies the manufacturing process that was used for the make order.
  • Maximum Length: 4000
    Value that identifies the project group.
  • Maximum Length: 4000
    Value that identifies the project.
  • Title: Promised Arrival Date
    Date when a customer has been promised the delivery of the order.
  • Title: Promised Ship Date
    Date when a customer has been promised the shipping of the order.
  • Title: Quantity in Process
    Quantity that's in the process of being released.
  • Title: Ready-to-Build Percentage
    Read Only: true
    Percent of order quantity that can be built with currently available material.
  • Read Only: true
    Number of units of an assembly item for which components are available on hand.
  • Read Only: true
    Maximum Length: 400
    Errors that are generated in the release process.
  • Title: Release Status
    Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
  • Read Only: true
    Maximum Length: 80
    Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
  • Read Only: true
    Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Read Only: true
    Work order quantity that remains to be completed.
  • Title: Requested Arrival Date
    Date when the material must arrive at the customer site.
  • Title: Requested Ship Date
    Date when the material must be shipped out to the customer.
  • Read Only: true
    Maximum Length: 100
    Contains one of the following values: true or false. If true, then the order has been rescheduled. If false, then the order hasn't been rescheduled.
  • Title: Reschedule Days
    Read Only: true
    Number of days to reschedule for a supply order. The reschedule days is the difference between the original due date and the revised due date. A negative value indicates the order is rescheduled to an earlier date.
  • Read Only: true
    Value that indicates whether the supply order has been reserved to a demand. Valid values are 1 or 2. If 1, then the supply is reserved to one or more demands. If 2, then planning is suggesting that the supply be reserved to one or more demands. A list of accepted values is defined in the lookup type ORA_MSC_RESERVATION_TYPE.
  • Title: Reserved Quantity
    Read Only: true
    Quantity that's reserved against an order.
  • Value that uniquely identifies the routing that was used for the make order.
  • Title: Scheduled Ship Date
    Read Only: true
    Date when the order is scheduled to be shipped.
  • Title: Schedule Name
    Read Only: true
    Maximum Length: 4000
    Name of the supply schedule associated with an order.
  • Title: Scrapped Quantity
    Read Only: true
    Work order quantity that has been scrapped.
  • Title: Segment
    Read Only: true
    Maximum Length: 120
    Name of the segment used for a set of items.
  • Read Only: true
    Selling price of an item on the order line.
  • Value that uniquely identifies the service level to use to ship an order from the source organization or supplier. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_SERVICE_LEVELS.
  • Read Only: true
    Maximum Length: 15
    Shipping calendar associated with the order.
  • Maximum Length: 30
    Value that indicates the shipping method used to ship the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Shipping Method
    Maximum Length: 4000
    Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Ship To
    Read Only: true
    Maximum Length: 4000
    Abbreviation that identifies the specific ship-to location.
  • Value that uniquely identifies the simulation set used in the plan, if any.
  • Title: Source Organization
    Maximum Length: 49
    Organization that will source the order.
  • Value that uniquely identifies the source organization.
  • Maximum Length: 12
    Value that identifies the data table source of the supply.
  • Title: Source Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
  • Value that identifies the type of planned order to be created. Valid values are 1, 2, or 3. If 1, then a planned make order is created. If 2, then a planned buy order is created. If 3, then a planned transfer order is created.
  • Title: Start Quantity
    Quantity at the beginning of a manufacturing process.
  • Title: Subinventory
    Read Only: true
    Maximum Length: 40
    Subinventory code associated with the supply.
  • Title: Substitute Component Used
    Read Only: true
    Value that indicates whether the planned order uses a substitute component or not.
  • Title: Suggested Completion Date
    Read Only: true
    Date when the process work order or a planned order completed. This attribute is required because the primary product can be produced in an operation that's prior to the last operation of the order.
  • Title: Suggested Dock Date
    Read Only: true
    Date when the order is recommended to arrive at the receiving dock.
  • Title: Suggested Due Date
    Read Only: true
    Date when a supply is expected to be completed.
  • Title: Suggested Order Date
    Read Only: true
    Date when an order is recommended to be placed.
  • Title: Suggested Ship Date
    Read Only: true
    Date when the order is recommended to be shipped.
  • Title: Suggested Start Date
    Read Only: true
    Date when work on the order is recommended to begin.
  • Title: Supplier
    Maximum Length: 4000
    Name of the source supplier.
  • Value that uniquely identifies the supplier.
  • Title: Supplier Site
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier location from where the item is being sourced.
  • Value that uniquely identifies the supplier site.
  • Maximum Length: 4000
    Value that identifies task.
  • Value that uniquely identifies the supply transaction. This value is internally generated by the application.
  • Title: Transit Lead Time
    Read Only: true
    Number of days that the supply is in transit between two locations.
  • Read Only: true
    Maximum Length: 200
    Name of the unit of measure associated with the order quantity.
  • Title: UOM
    Read Only: true
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • Upstream Supplies
    Title: Upstream Supplies
    The Upstream Supplies resource manages all the supplies that are pegged to a specific planning supply at the next level upstream.
  • Read Only: true
    Code that identifies the status of the work order. A list of accepted values is defined in the lookup type ORA_MSC_WIP_JOB_STATUS.
  • Read Only: true
    Type of supply transaction created when issuing items from inventory to work orders. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE.
  • Title: Work Definition
    Maximum Length: 100
    Name that uniquely identifies a work definition used for a make order.
  • Read Only: true
    Maximum Length: 4000
    Type of manufacturing used for the production process. Valid values are Discrete Manufacturing and Process Manufacturing.
  • Title: Work Method
    Type of manufacturing used for the production process. Valid values are 1: Discrete Manufacturing and 2: Process Manufacturing.
  • Title: Work Order Status
    Read Only: true
    Maximum Length: 4000
    Value that indicates the status of the work order. Valid values include Unreleased, Released, Complete, or On hold. A list of accepted values is defined in the lookup type ORA_MSC_WIP_JOB_STATUS.
Nested Schema : Pegged Demands
Type: array
Title: Pegged Demands
The Pegged Demands resource manages all the demands that are pegged to a specific planning supply at the same level.
Show Source
Nested Schema : Planning Attributes
Type: array
Title: Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
Show Source
Nested Schema : Upstream Supplies
Type: array
Title: Upstream Supplies
The Upstream Supplies resource manages all the supplies that are pegged to a specific planning supply at the next level upstream.
Show Source
Nested Schema : supplyPlans-PlanningSupplies-PeggedDemands-item-response
Type: object
Show Source
Nested Schema : supplyPlans-PlanningSupplies-PlanningAttributes-item-response
Type: object
Show Source
Nested Schema : supplyPlans-PlanningSupplies-UpstreamSupplies-item-response
Type: object
Show Source
Nested Schema : supplyPlans-ResourceExceptions-item-response
Type: object
Show Source
  • Title: Action Taken
    Read Only: true
    Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
  • Title: Additional Capacity Required by Date of Supplier Capacity Constraint
    Read Only: true
    Additional capacity to be added to the resource availability by the resource constraint date in the resource exception.
  • Title: Available Capacity
    Read Only: true
    Available capacity of the resource in the resource exception.
  • Title: Constraint End Date
    Read Only: true
    End constraint date of the resource requirement of the resource in the resource exception.
  • Title: Exception
    Read Only: true
    Maximum Length: 120
    Name of an exception.
  • Read Only: true
    Value that uniquely identifies the resource exception detail.
  • Read Only: true
    Number that uniquely identifies an exception.
  • Read Only: true
    Value that uniquely identifies the stored resource exception.
  • Title: Last Update Date
    Read Only: true
    Date when the exception detail was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the exception detail.
  • Links
  • Title: Notes
    Read Only: true
    Contains information created or updated for an exception detail represented as notes.
  • Title: Organization
    Read Only: true
    Maximum Length: 4000
    Name of the organization of an item for which an exception was calculated by the plan.
  • Read Only: true
    Value that uniquely identifies the organization of an item in the exception
  • Read Only: true
    Value that uniquely identifies the plan in which exception is generated.
  • Title: Required Capacity
    Read Only: true
    Capacity required by the resource in the resource exception.
  • Title: Available Capacity
    Read Only: true
    Availability of the resource in the resource exception.
  • Title: Resource
    Read Only: true
    Maximum Length: 4000
    Code of the resource in the resource exception.
  • Read Only: true
    Value that uniquely identifies the resource in the resource exception.
  • Title: Resource Load Ratio
    Read Only: true
    Load ratio of the resource in the resource exception.
  • Title: Resource Requirement by Resource Constraint Date
    Read Only: true
    Resource requirement of the resource by the resource constraint date in the resource exception.
  • Title: Start Constraint Date
    Read Only: true
    Constraint start date of the resource requirement of the resource in the resource exception.
  • Title: Work Center
    Read Only: true
    Maximum Length: 4000
    Code of the work center of the resource in the resource exception.
  • Read Only: true
    Value that uniquely identifies the work center of the resource in the resource exception.
Nested Schema : supplyPlans-Resources-item-response
Type: object
Show Source
  • Value that indicates whether the resource is available 24 hours a day or not. Valid values are: 1 or 2. If 1, then resource is available 24 hours a day. If 2, then not.
  • Maximum Length: 4000
    Value that indicates whether the resource is available 24 hours a day or not. Valid values are: Yes or No. If Yes, then the resource is available 24 hours a day. If No, then the resource isn't available 24 hours a day.
  • Maximum Length: 4000
    Value that indicates whether the resource is a bottleneck resource or not. Valid values are: 1 or 2. If 1, then resource is a bottleneck. If 2, then not.
  • Value that indicates whether the resource is a bottleneck or not. Valid values are: Yes or No. If Yes, then the resource is a bottleneck. If No, then the resource isn't a bottleneck.
  • Read Only: true
    Number of units of this resource that are available.
  • Read Only: true
    Maximum Length: 64
    User who created the resource.
  • Read Only: true
    Date and time when the user created the resource.
  • Value that indicates whether the resource is critical to honor resource capacity constraint or not. Valid values are: 1 or 2. If 1, then the resource is critical. If 2, then the resource isn't critical.
  • Maximum Length: 4000
    Value that indicates whether the resource is critical to honor the resource capacity constraint or not. Valid values are: Yes or No. If Yes, then the resource is critical. If No, then the resource isn't critical.
  • Read Only: true
    Maximum Length: 4000
    Code for the currency in which the resource cost is defined.
  • Read Only: true
    Date when the resource is no longer available.
  • Percentage of the actual output compared to the expected standard output.
  • Read Only: true
    Date and time when the user most recently updated the resource.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the resource.
  • Links
  • Read Only: true
    Value that's used to enable Create Note or Manage Notes. Valid values are 1 or 2. If 1, then Create Note is enabled. If 2, Manage Notes is enabled. The default value is 1.
  • Read Only: true
    Maximum Length: 4000
    Abbreviation that identifies the organization.
  • Read Only: true
    Value that uniquely identifies the organization.
  • Unique identifier of the plan.
  • Read Only: true
    Maximum Length: 40
    Abbreviation that identifies the resource.
  • Read Only: true
    Cost associated with using the resource.
  • Read Only: true
    Maximum Length: 240
    Description of the resource.
  • Value that uniquely identifies the resource.
  • Read Only: true
    Maximum Length: 80
    Name of the resource.
  • Read Only: true
    Value that identifies the type of resource. Valid values are 1 or 2. If 1, then the resource is a piece of equipment. If 2, then the resource is a crew. A list of accepted values is defined in the lookup type ORA_MSC_RESOURCE_TYPE.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the type of resource. Valid values are Equipment or Crew.
  • Read Only: true
    Maximum Length: 3
    Unit of measure associated with the resource.
  • Read Only: true
    Text that identifies whether the resource record has been modified or is newly created in the simulation set. Valid values are Changed or Null. If it's Changed, then the resource record has been modified or newly created in the simulation set. If it's Null, then the resource record hasn't been modified or newly created in the simulation set.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure associated with the resource.
  • Percentage of how much a resource is utilized.
  • Read Only: true
    Maximum Length: 120
    Abbreviation that identifies the work area.
  • Read Only: true
    Maximum Length: 240
    Description of the work area.
  • Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Read Only: true
    Maximum Length: 120
    Abbreviation that identifies the work center.
  • Read Only: true
    Maximum Length: 240
    Description of the work center.
  • Read Only: true
    Value that uniquely identifies the work center.
  • Read Only: true
    Maximum Length: 80
    Name of the work center.
Nested Schema : supplyPlans-Runs-item-response
Type: object
Show Source
  • List of entities to be refreshed. A comma separates each value. Valid values are 3: Forecasts, 4: Sales orders, and 6: Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.
  • 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 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.
  • 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. 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.
  • Value that uniquely identifies the plan.
  • 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.
  • This attribute isn't currently used.
  • Date and time to start the scheduled process.
  • 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.
Nested Schema : supplyPlans-SupplierExceptions-item-response
Type: object
Show Source
Nested Schema : supplyPlans-SupplyExceptions-item-response
Type: object
Show Source
  • Title: Action Taken
    Read Only: true
    Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
  • Title: Alternate BOM
    Read Only: true
    Maximum Length: 4000
    Name of the alternate bill of material in the supply exception.
  • Read Only: true
    Number that uniquely identifies the alternate bill of material in the supply exception.
  • Title: Alternate Facility Rank
    Read Only: true
    Number that represents the alternate facility rank from the sourcing rule used in the supply in the exception.
  • Title: Alternate Resource Requirement
    Read Only: true
    Number that represents the usage of an alternate resource in the supply in the exception.
  • Title: Alternate Routing
    Read Only: true
    Maximum Length: 4000
    Name of the alternate routing or work definition in the supply exception.
  • Read Only: true
    Number that uniquely identifies the alternate routing or work definition in the supply exception.
  • Title: Alternate Supplier
    Read Only: true
    Maximum Length: 4000
    Name of the alternate supplier in the supply exception.
  • Read Only: true
    Number that uniquely identifies the alternate supplier in the supply exception.
  • Title: Alternate Supplier Rank
    Read Only: true
    Number that represents the alternate supplier rank in the supply exception.
  • Title: Alternate Supplier Site
    Read Only: true
    Maximum Length: 4000
    Name of the alternate supplier site in the supply exception.
  • Read Only: true
    Number that uniquely identifies the alternate supplier site in the supply exception.
  • Title: Category
    Read Only: true
    Maximum Length: 4000
    Category of the item in the supply exception.
  • Title: Compression Days
    Read Only: true
    Number that represents the compression days of the supply in the exception.
  • Title: Compression Ratio
    Read Only: true
    Compression ratio of the supply in the exception.
  • Title: Currency
    Read Only: true
    Maximum Length: 4000
    Code for the currency of the supply's organization in the exception.
  • Title: Days Past Due
    Read Only: true
    Number that represents the number of days the supply is past due based on the plan start date in the exception.
  • Title: Exception
    Read Only: true
    Maximum Length: 15
    Name of an exception.
  • Read Only: true
    Value that uniquely identifies the supply exception detail.
  • Read Only: true
    Number that uniquely identifies an exception.
  • Read Only: true
    Value that uniquely identifies the stored supply exception.
  • Title: Firm Status
    Read Only: true
    Status that indicates whether the order is firm or not in the exception. Valid values include Firm and Not firm.
  • Title: From Date
    Read Only: true
    From date in the supply exception.
  • Read Only: true
    Number that uniquely identifies the item in the supply exception.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Name of the item in the supply exception.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item in the supply exception.
  • Title: Last Update Date
    Read Only: true
    Date when the exception detail was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the exception detail.
  • Links
  • Title: Lot Number
    Read Only: true
    Maximum Length: 80
    Lot number of the on-hand supply in the supply exception.
  • Title: Notes
    Read Only: true
    Contains information created or updated for an exception detail represented as notes.
  • Title: Old Due Date
    Read Only: true
    Old due date of the supply order in the supply exception.
  • Title: Order Date
    Read Only: true
    Supply order date in the exception.
  • Title: Order Line Number
    Read Only: true
    Maximum Length: 50
    Line number of the supply in the exception.
  • Title: Order Number
    Read Only: true
    Maximum Length: 240
    Order number of the supply in the exception.
  • Title: Order Start Date
    Read Only: true
    Start date of the supply order in the supply exception.
  • Title: Order Value
    Read Only: true
    Order value of the supply in the exception.
  • Title: Organization
    Read Only: true
    Maximum Length: 4000
    Name of the organization of the supply in the supply exception.
  • Read Only: true
    Value that uniquely identifies the organization of the supply in the supply exception.
  • Read Only: true
    Value that uniquely identifies the plan in which exception is generated.
  • Title: Planner
    Read Only: true
    Maximum Length: 10
    Name of the planner associated with the item in the exception.
  • Title: Planner Description
    Read Only: true
    Maximum Length: 4000
    Description of the planner associated with the item in the exception.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 10 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 11 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 12 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 13 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 14 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 15 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 3 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 4 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 5 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 6 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 7 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 8 associated with the supply in the exception in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 9 associated with the supply in the exception in an attribute-based plan.
  • Title: Plan Start Date
    Read Only: true
    Start date of the plan the exception is generated in.
  • Title: Primary Resource Requirement
    Read Only: true
    Resource requirement of the primary resource of the supply in the exception.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the project group associated with the supply in the exception of an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the project associated with the supply in the exception of an attribute-based plan.
  • Title: Quantity
    Read Only: true
    Number that represents the quantity of the supply in the supply exception.
  • Title: Reschedule Days
    Read Only: true
    Number that represents rescheduled days for the supply in the exception.
  • Title: Resource
    Read Only: true
    Maximum Length: 4000
    Code of the supply's resource in the supply exception.
  • Read Only: true
    Value that uniquely identifies the supply's resource in the supply exception.
  • Title: Shipping Method
    Read Only: true
    Maximum Length: 4000
    Name of the ship method associated with the supply in the supply exception.
  • Title: Source Organization
    Read Only: true
    Maximum Length: 4000
    Name of the source organization of the supply in the supply exception.
  • Read Only: true
    Value that uniquely identifies the source organization of the supply in the supply exception.
  • Read Only: true
    Maximum Length: 240
    Name of the store key in the supply exception.
  • Title: Subinventory
    Read Only: true
    Maximum Length: 80
    Name of the subinventory of supply in the supply exception.
  • Title: Alternate Resource
    Read Only: true
    Maximum Length: 4000
    Code of the supply's alternate resource in the supply exception.
  • Read Only: true
    Value that uniquely identifies the supply's alternate resource in the supply exception.
  • Title: Supplier
    Read Only: true
    Maximum Length: 4000
    Name of the supplier in the supply exception.
  • Read Only: true
    Number that uniquely identifies the supplier in the supply exception.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 4000
    Name of the supplier site in the supply exception.
  • Read Only: true
    Number that uniquely identifies the supplier site in the supply exception.
  • Title: Supply Order Type
    Read Only: true
    Maximum Length: 4000
    Type of supply order in the exception, such as a planned order or transfer order.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the task associated with the supply in the exception in an attribute-based plan.
  • Title: To Date
    Read Only: true
    To date of the supply in the supply exception.
  • Read Only: true
    Value that uniquely identifies the supply in the supply exception.
  • Title: Work Center
    Read Only: true
    Maximum Length: 4000
    Code of the work center of the supply's resource in the supply exception.
  • Read Only: true
    Value that uniquely identifies the work center of the supply's resource in the supply exception.
Back to Top

Examples

This example describes how to get one plan detail.

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/supplyPlans/PlanId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915"

Example Response Body

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

{
    "AltItemWorkDefOption": 1,
    "UseAlternateResources": 1,
    "AltSupSourceOrgOption": 1,
    "OrderModifierStartQuantity": 2,
    "ArchiveTimeHierarchy": null,
    "ArchiveTimeLevel": null,
    "ArchivePlan": null,
    "CompressionDaysTolerance": null,
    "BackwardConsumptionBucket": null,
    "CapacityConstrainedResources": 1,
    "PlanName": "RTSP-GB-EX8-ONHOLDPL01",
    "ConsumeByForecastBucket": 2,
    "ConsumeWithInternalOrders": null,
    "ConsumptionBucketType": 1,
    "ConsumptionCalendar": "10002",
    "CutoffDate": "2030-03-17",
    "CalendarCode": "10002",
    "DemandPrioritizationMethod": 1,
    "DemandPriorityRule": null,
    "DemandTimeFenceControl": 2,
    "EnableForArchiving": 2,
    "ExceptionSet": 4,
    "ForwardConsumptionBucket": null,
    "GroupPlannedOrders": null,
    "HorizonForAverageDemand": 7,
    "IncludeProdMonitoringAlrts": null,
    "IncludeItemsWithSafetyStock": null,
    "IncludeItemsWithSupplyButNoDemand": null,
    "DontConsiderInTransitSupplyAsFirm": null,
    "EnforceLeadTimeInTransit": null,
    "LastUpdatedDate": "2022-06-29T08:25:14+00:00",
    "LoadedOption": null,
    "RequisitionLoadGroupBy": 5,
    "TransferLoadGroupBy": 1,
    "MaximumVarSafetyStockValue": null,
    "MinimumVarSafetyStockValue": null,
    "PastDueForecastBucket": null,
    "PastDueDemandBucket": 1,
    "PastDueOpenSoBucket": null,
    "PastDueShippedSoBucket": null,
    "PastDueDemandBucketType": null,
    "PastDueDemandCalendar": null,
    "PlanId": 300100551624915,
    "PlanHorizonStartDate": "2030-01-04",
    "SupplyPlannedItems": 6,
    "PlanningTimeFenceControl": 2,
    "ForecastError": null,
    "OverwriteSafetyStock": 1,
    "SaveToCollectedData": 2,
    "DateUsedToPlanSalesOrders": null,
    "SimulationSet": 300100176684635,
    "SafetyStockChangeToAll": null,
    "PlanStatus": 0,
    "SupplyParameterOverrides": null,
    "HasRun": 1,
    "AutoRelease": 2,
    "ApplyPolicyOverrides": 2,
    "ConsumptionDtlsCutoffDays": null,
    "NumberOfDaysForDemandCutoff": null,
    "UseEndItemSubstitutes": 2,
    "EnforceResourceCapConstr": null,
    "EnforceSupplierCapConstr": null,
    "UseModelSpecificPlanPct": null,
    "UseFcstPlanPercInsteadCollData": null,
    "FirstPlanningBucketCode": 1,
    "FirstPlanningBucketNumber": 60,
    "SecondPlanningBucketCode": 2,
    "SecondPlanningBucketNumber": 2,
    "SupplyPlanningCalendar": "APS Calendar",
    "FirstPlanningBucketName": "Day",
    "SecondPlanningBucketName": "Week",
    "PlanItemLevelMembers": "",
    "PriceLists": "",
    "PlanOrganizationLevelMembers": "EX8:M2,EX8:M1,EX8:M3",
    "DemandSchedules": "(GB-EX8-FDS,null,External,,Item) (GB-DP,null,External,,Item) (GB-EXP3,null,External,,Item) (GB-HLDEX9,null,External,,Item) (GB-EXP1,null,External,,Item) (GB-CSA,null,External,,Item) ",
    "Organizations": "(EX8:M1,Denver ManufacturingEX8) (EX8:M2,Boston ManufacturingEX8) (EX8:M3,New Orleans ManufacturingEX8) ",
    "SafetyStockForecastPlan": null,
    "MeasureCatalogForArchival": "DEMO:Measure Catalog",
    "AssignmentSetName": "GB-ONHOLD",
    "PolicyAssignmentSet": null,
    "AppliesToOrderTypes": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915",
            "name": "supplyPlans",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915",
            "name": "supplyPlans",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915/child/PlanningDemands",
            "name": "PlanningDemands",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915/child/PlanningSupplies",
            "name": "PlanningSupplies",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915/child/Runs",
            "name": "Runs",
            "kind": "collection"
        }
    ]
}
Back to Top