Get one changed demand
get
/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/ChangedDemands/{ComparisonPlanId}
Request
Path Parameters
-
ComparisonPlanId(required): number
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=
-
PlanId(required): integer(int64)
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
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : supplyPlans-ChangedDemands-item-response
Type:
Show Source
object
-
ActionCodeComparisonPlan: string
Read Only:
true
Maximum Length:12
Code that indicates the type of recommended change made by the planning engine to the supply or demand in the comparison plan. 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. -
ActionCodeCurrentPlan: string
Read Only:
true
Maximum Length:255
Code that indicates the type of recommended change made by the planning engine to the supply or demand in the current plan. 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. -
ActionComparisonPlan: string
Read Only:
true
Maximum Length:4000
Value that indicates the type of recommended change made by the planning engine to the supply or demand in the comparison plan. 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. -
ActionCurrentPlan: string
Title:
Action
Read Only:true
Maximum Length:4000
Value that indicates the type of recommended change made by the planning engine to the supply or demand in the current plan. 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. -
AtRiskStatusComparisonPlan: string
Read Only:
true
Maximum Length:255
Indicates whether the order is at risk in the comparison plan. Valid values are At risk or Not at risk. -
AtRiskStatusCurrentPlan: string
Read Only:
true
Maximum Length:255
Indicates whether the order is at risk in the current plan. Valid values are At risk or Not at risk. -
CalculatedDemandPriorityComparisonPlan: number
Read Only:
true
Calculated priority of the demand in the comparison plan. -
CalculatedDemandPriorityCurrentPlan: number
Title:
Calculated Demand Priority
Read Only:true
Calculated priority of the demand in the current plan. -
CategoryId: string
Read Only:
true
Value that uniquely identifies the category. -
CategoryName: string
Title:
Category
Read Only:true
Maximum Length:4000
Name of the category to which the item is assigned. -
ComparisonPlanId: number
Read Only:
true
Value that uniquely identifies the plan being compared. -
Customer: string
Title:
Customer
Read Only:true
Maximum Length:4000
Name of the customer associated with the sales order or forecast. -
CustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer. -
CustomerSite: string
Title:
Customer Site
Read Only:true
Maximum Length:4000
Code associated with a specific customer ship-to location. -
CustomerSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer site. -
DaysLateComparisonPlan: number
Read Only:
true
Number of days that the demand is late in the comparison plan. -
DaysLateCurrentPlan: number
Title:
Days Late
Read Only:true
Number of days that the demand is late in the current plan. -
ExceptionCountComparisonPlan: number
Read Only:
true
The number of exceptions associated with the order in the comparison plan. -
ExceptionCountCurrentPlan: number
Read Only:
true
The number of exceptions associated with the order in the current plan. -
InventoryItemIdComparisonPlan: integer
(int64)
Read Only:
true
Value that uniquely identifies the item in the comparison plan. -
InventoryItemIdCurrentPlan: integer
(int64)
Read Only:
true
Value that uniquely identifies the item in the current plan. -
ItemComparisonPlan: string
Read Only:
true
Maximum Length:300
Name of the item associated with the demand in the comparison plan. -
ItemCurrentPlan: string
Title:
Item
Read Only:true
Maximum Length:300
Name of the item associated with the demand in the current plan. -
ItemDescriptionComparisonPlan: string
Read Only:
true
Maximum Length:240
Description of the item associated with the demand in the comparison plan. -
ItemDescriptionCurrentPlan: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item associated with the demand in the current plan. -
LateDemandValueComparisonPlan: number
Read Only:
true
The monetary value of the late demand in the comparison plan. -
LateDemandValueCurrentPlan: number
Title:
Late Demand Value
Read Only:true
The monetary value of the late demand in the current plan. -
LatenessImprovement: number
Title:
Lateness Improvement
Read Only:true
A sales order's difference in the number of days late between the current plan and the comparison plan. A positive number means the sales order is less late in the current plan. A negative number represents is more late in the current plan. -
LateQuantityComparisonPlan: number
Read Only:
true
Quantity of the demand that's late in the comparison plan. -
LateQuantityCurrentPlan: number
Title:
Late Quantity
Read Only:true
Quantity of the demand that's late in the current plan. -
LineNumber: string
Title:
Line Number
Read Only:true
Maximum Length:150
Line number associated with the demand. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialAvailableDateComparisonPlan: string
(date)
Read Only:
true
The quantity of the demand that's late in the comparison plan. -
MaterialAvailableDateCurrentPlan: string
(date)
Title:
Material Available Date
Read Only:true
The quantity of the demand that's late in the current plan. -
NotesCount: integer
Title:
Notes
Read Only:true
Number of notes associated with a demand order. -
OnTimeComparison: string
Read Only:
true
Maximum Length:255
Compares the on time status of a sales order between the current plan and a comparison plan. A list of accepted values is defined in the lookup type ORA_MSC_ON_TIME_COMP. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:4000
Order number associated with the sales order. -
OrderQuantityComparisonPlan: number
Read Only:
true
Quantity associated with the demand in the comparison plan. -
OrderQuantityCurrentPlan: number
Title:
Order Quantity
Read Only:true
Quantity associated with the demand in the current plan. -
OrderType: string
Title:
Order Type
Read Only:true
Maximum Length:4000
Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
OrderTypeCode: number
Read Only:
true
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. -
OrderValueComparisonPlan: number
Read Only:
true
Monetary value associated with the order in the comparison plan. -
OrderValueCurrentPlan: number
Title:
Order Value
Read Only:true
Monetary value associated with the order in the current plan. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:49
Name of the organization associated with the order. -
OrganizationId: number
Read Only:
true
Value that uniquely identifies the organization. -
OriginalItem: string
Title:
Original Item
Read Only:true
Maximum Length:4000
Name of the requested item associated with the demand. -
OriginalItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requested item. -
OriginalItemQuantity: number
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. -
OverrideDemandPriorityComparisonPlan: number
Read Only:
true
Overridden priority of the demand in the current plan. -
OverrideDemandPriorityCurrentPlan: number
Title:
Override Demand Priority
Read Only:true
Overridden priority of the demand in the current plan. -
PlanId: number
Read Only:
true
Value that uniquely identifies the plan. -
PlanningAttributeNumber10ComparisonPlan: number
Read Only:
true
Value for the planning attribute number 10 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber10CurrentPlan: number
Read Only:
true
Value for the planning attribute number 10 in attribute-based planning in the current plan. -
PlanningAttributeNumber11ComparisonPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 11 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber11CurrentPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 11 in attribute-based planning in the current plan. -
PlanningAttributeNumber12ComparisonPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 12 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber12CurrentPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 12 in attribute-based planning in the current plan. -
PlanningAttributeNumber13ComparisonPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 13 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber13CurrentPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 13 in attribute-based planning in the current plan. -
PlanningAttributeNumber14ComparisonPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 14 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber14CurrentPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 14 in attribute-based planning in the current plan. -
PlanningAttributeNumber15ComparisonPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 15 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber15CurrentPlan: integer
(int64)
Read Only:
true
Value for the planning attribute number 15 in attribute-based planning in the current plan. -
PlanningAttributeNumber3ComparisonPlan: number
Read Only:
true
Value for the planning attribute number 3 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber3CurrentPlan: number
Read Only:
true
Value for the planning attribute number 3 in attribute-based planning in the current plan. -
PlanningAttributeNumber4ComparisonPlan: number
Read Only:
true
Value for the planning attribute number 4 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber4CurrentPlan: number
Read Only:
true
Value for the planning attribute number 4 in attribute-based planning in the current plan. -
PlanningAttributeNumber5ComparisonPlan: number
Read Only:
true
Value for the planning attribute number 5 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber5CurrentPlan: number
Read Only:
true
Value for the planning attribute number 5 in attribute-based planning in the current plan. -
PlanningAttributeNumber6ComparisonPlan: number
Read Only:
true
Value for the planning attribute number 6 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber6CurrentPlan: number
Read Only:
true
Value for the planning attribute number 6 in attribute-based planning in the current plan. -
PlanningAttributeNumber7ComparisonPlan: number
Read Only:
true
Value for the planning attribute number 7 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber7CurrentPlan: number
Read Only:
true
Value for the planning attribute number 7 in attribute-based planning in the current plan. -
PlanningAttributeNumber8ComparisonPlan: number
Read Only:
true
Value for the planning attribute number 8 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber8CurrentPlan: number
Read Only:
true
Value for the planning attribute number 8 in attribute-based planning in the current plan. -
PlanningAttributeNumber9ComparisonPlan: number
Read Only:
true
Value for the planning attribute number 9 in attribute-based planning in the comparison plan. -
PlanningAttributeNumber9CurrentPlan: number
Read Only:
true
Value for the planning attribute number 9 in attribute-based planning in the current plan. -
ProjectGroupValueComparisonPlan: string
Read Only:
true
Value that identifies the project group in the comparison plan. -
ProjectGroupValueCurrentPlan: string
Read Only:
true
Maximum Length:4000
Value that identifies the project group in the current plan. -
ProjectValueComparisonPlan: string
Read Only:
true
Value that identifies the project in the comparison plan. -
ProjectValueCurrentPlan: string
Read Only:
true
Maximum Length:4000
Value that identifies the project in the current plan. -
QuantityByDueDateComparisonPlan: number
Read Only:
true
Quantity that can be provided by the due date in the comparison plan. For example, the order quantity may be 100 units but only 50 units may be available by the due date. -
QuantityByDueDateCurrentPlan: number
Title:
Quantity by Due Date
Read Only:true
Quantity that can be provided by the due date in the current plan. For example, the order quantity may be 100 units but only 50 units may be available by the due date. -
QuantityOnDueDateChange: number
Title:
Quantity by Due Date Change
Read Only:true
Difference in an order's quantity that's available by the due date between plans. For example, when an order whose quantity available by the due date differs by 50 units between two plans. -
RequestedArrivalDateComparisonPlan: string
(date)
Read Only:
true
Date when the material must arrive at the customer site in the comparison plan. -
RequestedArrivalDateCurrentPlan: string
(date)
Title:
Requested Arrival Date
Read Only:true
Date when the material must arrive at the customer site in the current plan. -
RequestedShipDateComparisonPlan: string
(date)
Read Only:
true
Date when the material must be shipped out to the customer in the comparison plan. -
RequestedShipDateCurrentPlan: string
(date)
Title:
Requested Ship Date
Read Only:true
Date when the material must be shipped out to the customer in the current plan. -
SuggestedDueDateComparisonPlan: string
(date)
Read Only:
true
Date when the demand is recommended to be completed in the comparison plan. -
SuggestedDueDateCurrentPlan: string
(date)
Title:
Suggested Due Date
Read Only:true
Date when the demand is recommended to be completed in the current plan. -
TaskValueComparisonPlan: string
Read Only:
true
Value that identifies the task in the comparison plan. -
TaskValueCurrentPlan: string
Read Only:
true
Maximum Length:4000
Value that identifies the task in the current plan. -
TransactionId: string
Read Only:
true
Value that uniquely identifies the demand. This value is internally generated by the application. -
UnmetDemandQuantityComparisonPlan: number
Read Only:
true
Quantity of demand that's not satisfied in the comparison plan. -
UnmetDemandQuantityCurrentPlan: number
Title:
Unmet Demand Quantity
Read Only:true
Quantity of demand that's not satisfied in the current plan. -
UOM: string
Title:
UOM
Read Only:true
Maximum Length:4000
Name of the unit of measure that's associated with the order quantity. -
UOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure associated with the order quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.