Get one demand
get
/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/PlanningDemands/{TransactionId}
Request
Path Parameters
-
PlanId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
TransactionId(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:
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.
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(required):
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(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : demandAndSupplyPlans-PlanningDemands-item-response
Type:
Show Source
object
-
Action: string
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. -
AssetNumber: string
Title:
Asset
Read Only:true
Maximum Length:80
Number that identifies the asset associated with a maintenance work order. -
BillSequenceId: integer
(int64)
Value that uniquely identifies the sequence in which a component is used within an operation.
-
BOMItemType: integer
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.
-
BucketType: string
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. -
Buyer: string
Title:
Buyer
Read Only:true
Name of the buyer associated with the item. -
ComponentQuantityIssued: number
Title:
Component Quantity Issued
Read Only:true
Quantity of a component issued to a work order. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the order. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the order. -
Customer: string
Title:
Customer
Maximum Length:4000
Name of the customer associated with the sales order or forecast. -
CustomerSite: string
Title:
Customer Site
Maximum Length:4000
Code associated with a specific customer ship-to location. -
DaysLate: integer
(int64)
Title:
Days Late
Read Only:true
Number of days that the demand is late. -
DaysPastDue: number
Title:
Days Past Due
Read Only:true
Number of days that the demand date is in the past. -
DemandClass: string
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. -
DemandClassCode: string
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. -
DemandPriority: integer
(int64)
Title:
Order Priority
Priority of the demand. -
DestinationTimeZone: string
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. -
DestOrgCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the destination organization of an order. -
EndDemandValue: number
Read Only:
true
Monetary value associated with the end demand. -
EndPeggedSupplies: array
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. -
ExpenseDestinationTransfer: string
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. -
FirmDate: string
(date)
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. -
FirmPlannedType: integer
(int32)
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. -
FirmQuantity: number
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. -
FirmStatus: string
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. -
FulfillmentLine: integer
Title:
Fulfillment Line
Read Only:true
Fulfillment line number associated with a sales order. -
ImplementDate: string
(date)
Title:
Implement Date
Date when the order is implemented. -
ImplementDemandClass: string
Title:
Implement Demand Class
Maximum Length:30
Demand class associated with the order that will be used when the order is released. -
ImplementedQuantity: number
Title:
Implemented Quantity
Cumulative quantity that has been released to date. -
ImplementFirm: integer
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. -
ImplementFirmOption: string
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. -
ImplementQuantity: number
Title:
Implement Quantity
Order quantity for the released order. -
ImplementShipDate: string
(date)
Title:
Implement Ship Date
Date when the order is shipped. -
ImplementShipMethod: string
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. -
ImplementShippingMethod: string
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. -
ImplementSourceOrganization: string
Title:
Implement Source Organization
Read Only:true
Maximum Length:100
Source organization for the released order. -
Item: string
Title:
Item
Maximum Length:300
Name of the item associated with the demand. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item associated with the demand. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the demand was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the demand. -
LatestAcceptableDate: string
(date)
Title:
Latest Acceptable Date
Read Only:true
Date beyond which the demand line must not be promised. -
LineNumber: string
Title:
Line Number
Read Only:true
Maximum Length:100
Line number associated with the demand. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Title:
Lot
Read Only:true
Maximum Length:80
Lot number associated with an expired on-hand lot. -
MakeOrBuy: string
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. -
MarkForReleaseOption: string
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.
-
MaterialAvailableDate: string
(date)
Title:
Material Available Date
Read Only:true
Date when the total quantity is available. -
Message: string
Read Only:
true
Text of the error message, if any, encountered when creating or updating a demand. -
ModeOfTransport: integer
(int64)
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.
-
NeedByDate: string
(date)
Title:
Need-by Date
Read Only:true
Date by when the demand quantity is needed. -
OldDueDate: string
(date)
Title:
Old Due Date
Read Only:true
Date when the demand quantity was originally due. This attribute value is extracted from the source application. -
OrderDateType: string
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. -
OrderDateTypeCode: integer
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. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:4000
Order number associated with the sales order. -
OrderQuantity: number
Title:
Order Quantity
Read Only:true
Quantity associated with the demand. -
OrderType: integer
(int32)
Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
-
OrderTypeText: string
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. -
Organization: string
Title:
Organization
Maximum Length:49
Name of the organization associated with the order. -
OrganizationTimeZone: string
Title:
Organization Time Zone
Read Only:true
Maximum Length:100
Time zone of the organization associated with the demand. -
OrgCurrencyCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the base currency of the organization. -
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. -
OriginalNeedByDate: string
(date)
Title:
Original Need-by Date
Read Only:true
Date when the order is needed. This value is extracted from the source application. -
OriginalOrderQuantity: number
Title:
Original Order Quantity
Read Only:true
Quantity associated with the order. This value is extracted from the source application. -
OverrideDemandPriority: number
Title:
Override Demand Priority
Override priority of end demands such as sales order, forecast, and manual demand. -
ParentModel: string
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. -
PeggedSupplies: array
Pegged Supplies
Title:
Pegged Supplies
The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand. -
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
PlannedArrivalDate: string
(date)
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. -
Planner: string
Title:
Planner
Read Only:true
Maximum Length:10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:100
Description of the planner responsible for the item. -
PlanningAttributes: array
Planning Attributes
Title:
Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply. -
PlanningMakeBuyCode: integer
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. -
ProjectGroupValue: string
Maximum Length:
4000
Value that identifies the project group. -
ProjectValue: string
Maximum Length:
4000
Value that identifies the project. -
PromisedArrivalDate: string
(date)
Title:
Promised Arrival Date
Read Only:true
Date when a customer has been promised the delivery of the order. -
PromisedShipDate: string
(date)
Title:
Promised Ship Date
Read Only:true
Date when a customer has been promised the shipping of the order. -
QuantityByDueDate: number
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. -
QuantityInProcess: number
Title:
Quantity in Process
Read Only:true
Quantity that's in process of being released. -
ReleaseErrors: string
Read Only:
true
Maximum Length:400
Errors that are generated in the release process. -
ReleaseStatus: integer
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. -
ReleaseStatusText: string
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. -
RequestedArrivalDate: string
(date)
Title:
Requested Arrival Date
Read Only:true
Date when the material must arrive at the customer site. -
RequestedItem: string
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. -
RequestedShipDate: string
(date)
Title:
Requested Ship Date
Read Only:true
Date when the material must be shipped out to the customer. -
Rescheduled: string
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. -
ReservedQuantity: number
Title:
Reserved Quantity
Read Only:true
Quantity that has been reserved against an order. -
ScheduledArrivalDate: string
(date)
Title:
Scheduled Arrival Date
Read Only:true
Date when the demand has been scheduled to arrive at a customer site. -
ScheduledShipDate: string
(date)
Title:
Scheduled Ship Date
Read Only:true
Date when the demand has been scheduled to be shipped. -
ScheduleName: string
Title:
Schedule Name
Read Only:true
Maximum Length:4000
Name of the supply or demand schedule associated with an order. -
SegmentName: string
Title:
Segment
Read Only:true
Maximum Length:120
Name of the segment used for a set of items. -
SellingPrice: number
Read Only:
true
Selling price of an item on the order line. -
ServiceLevel: integer
(int64)
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.
-
ShipCalendar: string
Read Only:
true
Maximum Length:15
Shipping calendar associated with the order. -
ShipMethod: string
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. -
ShippingMethod: string
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. -
ShipTo: string
Title:
Ship To
Read Only:true
Maximum Length:4000
Abbreviation that indicates the specific ship-to location. -
SimulationSetId: integer
(int64)
Value that uniquely identifies the simulation set used in the plan, if any.
-
SourceOrder: string
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. -
SourceOrderLine: string
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. -
SourceOrganization: string
Title:
Source Organization
Maximum Length:49
Organization that will source the order. -
SourceTimeZone: string
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. -
SuggestedDueDate: string
(date)
Title:
Suggested Due Date
Read Only:true
Date when the demand is recommended to be completed. -
SuggestedOrderDate: string
(date)
Title:
Suggested Order Date
Read Only:true
Date when the order is recommended to be placed. -
SuggestedShipDate: string
(date)
Title:
Suggested Ship Date
Read Only:true
Date when the order is recommended to be shipped. -
Supplier: string
Title:
Supplier
Maximum Length:4000
Name of the source supplier. -
SupplierSite: string
Title:
Supplier Site
Maximum Length:4000
Abbreviation that indicates the specific supplier ship-from location. -
TaskValue: string
Maximum Length:
4000
Value that identifies task. -
TransactionId: integer
(int64)
Value that uniquely identifies the demand. This value is internally generated by the application.
-
TransitLeadTime: number
Title:
Transit Lead Time
Read Only:true
Number of days that the demand is in transit between two locations. -
UnitNumber: string
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. -
UnmetDemandQuantity: number
Title:
Unmet Demand Quantity
Read Only:true
Quantity of demand that's not satisfied. -
UOM: string
Read Only:
true
Maximum Length:200
Name of the unit of measure that's associated with the order quantity. -
UOMCode: string
Title:
UOM
Read Only:true
Abbreviation that identifies the unit of measure associated with the order quantity. -
UsingAssembly: string
Title:
Using Assembly
Maximum Length:4000
For component demands, this field refers to the assembly item that uses this item as a component. -
Zone: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : demandAndSupplyPlans-PlanningDemands-EndPeggedSupplies-item-response
Type:
Show Source
object
-
Item: string
Read Only:
true
Maximum Length:4000
Name of the item associated with the supply. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Read Only:
true
Maximum Length:4000
Number that identifies the order associated with the supply. -
OrderQuantity: number
Read Only:
true
Quantity associated with the supply. -
OrderTypeText: string
Read Only:
true
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. -
Organization: string
Read Only:
true
Maximum Length:4000
Name of the organization associated with the order. -
PeggedQuantity: number
Read Only:
true
Quantity of supply that's pegged to this demand. -
PeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the association with the end pegged supply. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the next level of supply and demand in the supply chain. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when the supply is expected to be completed. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the end pegged supply.
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.
Nested Schema : demandAndSupplyPlans-PlanningDemands-PeggedSupplies-item-response
Type:
Show Source
object
-
Item: string
Read Only:
true
Maximum Length:4000
Name of the item associated with the supply. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Read Only:
true
Maximum Length:4000
Number that identifies the order associated with the supply. -
OrderQuantity: number
Read Only:
true
Quantity associated with the supply. -
OrderTypeText: string
Read Only:
true
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. -
Organization: string
Read Only:
true
Maximum Length:4000
Name of the organization associated with the order. -
PeggedQuantity: number
Read Only:
true
Quantity of supply that's pegged to this demand. -
PeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the association with the pegged supply. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the next level of supply and demand in the supply chain. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when the supply is expected to be completed. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pegged supply.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningDemands-PlanningAttributes-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Title:
Order Number
Maximum Length:4000
Number that identifies the order associated with the demand or supply. -
PlanningAttributeNumber10: string
Maximum Length:
4000
Value for the planning attribute number 10 in attribute-based planning. -
PlanningAttributeNumber11: string
Maximum Length:
4000
Value for the planning attribute number 11 in attribute-based planning. -
PlanningAttributeNumber12: string
Maximum Length:
4000
Value for the planning attribute number 12 in attribute-based planning. -
PlanningAttributeNumber13: string
Maximum Length:
4000
Value for the planning attribute number 13 in attribute-based planning. -
PlanningAttributeNumber14: string
Maximum Length:
4000
Value for the planning attribute number 14 in attribute-based planning. -
PlanningAttributeNumber15: string
Maximum Length:
4000
Value for the planning attribute number 15 in attribute-based planning. -
PlanningAttributeNumber3: string
Maximum Length:
4000
Value for the planning attribute number 3 in attribute-based planning. -
PlanningAttributeNumber4: string
Maximum Length:
4000
Value for the planning attribute number 4 in attribute-based planning. -
PlanningAttributeNumber5: string
Maximum Length:
4000
Value for the planning attribute number 5 in attribute-based planning. -
PlanningAttributeNumber6: string
Maximum Length:
4000
Value for the planning attribute number 6 in attribute-based planning. -
PlanningAttributeNumber7: string
Maximum Length:
4000
Value for the planning attribute number 7 in attribute-based planning. -
PlanningAttributeNumber8: string
Maximum Length:
4000
Value for the planning attribute number 8 in attribute-based planning. -
PlanningAttributeNumber9: string
Maximum Length:
4000
Value for the planning attribute number 9 in attribute-based planning. -
TransactionId: integer
(int64)
Value that uniquely identifies the demand or supply. This value is internally generated by the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- EndPeggedSupplies
-
Parameters:
- PlanId:
$request.path.PlanId
- TransactionId:
$request.path.TransactionId
The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand. - PlanId:
- PeggedSupplies
-
Parameters:
- PlanId:
$request.path.PlanId
- TransactionId:
$request.path.TransactionId
The Pegged Supplies resource manages the supplies that are pegged to a specific planning demand at the same level. - PlanId:
- PlanningAttributes
-
Parameters:
- PlanId:
$request.path.PlanId
- TransactionId:
$request.path.TransactionId
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply. - PlanId:
Examples
This example describes how to get one demand.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/demandandsupplyplans-planid-child-planningdemands-transactionid"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningDemands/3504907"
Example Response Body
The following shows an example of the response body in JSON format.
{ "BillSequenceId": null, "BOMItemType": 4, "BucketType": "Day", "Buyer": null, "CreatedBy": "OPERATIONS", "CreationDate": "2021-06-22T23:45:15.976+00:00", "CustomerSite": null, "DemandClass": null, "DemandPriority": null, "ItemDescription": "AI-ABP-5000", "ScheduleName": "AI-AB-FC2", "DestOrgCode": null, "MaterialAvailableDate": "2030-02-11", "FirmDate": null, "FirmQuantity": null, "ImplementDemandClass": null, "ImplementFirm": null, "ImplementFirmOption": null, "ImplementQuantity": null, "ImplementShipDate": null, "ImplementShipMethod": null, "ImplementedQuantity": null, "ImplementDate": null, "TransitLeadTime": null, "Item": "AI-ABP-5000", "Organization": "PDSCM1", "OrderTypeText": "Forecast", "FirmPlannedType": 2, "FirmStatus": "Not firm", "SuggestedDueDate": "2030-02-11", "OrderNumber": "AI-AB-FC2", "Planner": "JOHN BROWN", "Customer": null, "ReleaseStatus": 6, "SuggestedShipDate": null, "LastUpdateDate": "2021-06-22T23:45:15.976+00:00", "LastUpdatedBy": "OPERATIONS", "LatestAcceptableDate": null, "NeedByDate": null, "SuggestedOrderDate": null, "OldDueDate": "2030-02-11", "OrderDateTypeCode": null, "OrderDateType": "Ship date", "OrderType": 1029, "OriginalNeedByDate": null, "OriginalOrderQuantity": null, "OriginalItemQuantity": 10, "RequestedItem": "AI-ABP-5000", "PlanId": 300100561723255, "PlannedArrivalDate": null, "PlanningMakeBuyCode": 1, "MakeOrBuy": "Make", "PromisedArrivalDate": null, "PromisedShipDate": null, "QuantityByDueDate": 10, "OrderQuantity": -10, "QuantityInProcess": null, "ReleaseErrors": "Orders for order type Forecast cannot be marked for release.", "RequestedArrivalDate": null, "RequestedShipDate": null, "Rescheduled": null, "ReservedQuantity": null, "ScheduledArrivalDate": null, "ScheduledShipDate": "2030-02-11", "SellingPrice": 10, "ShipCalendar": null, "ShipMethod": null, "ShippingMethod": null, "ShipTo": null, "SourceOrganization": null, "Supplier": null, "SupplierSite": null, "TransactionId": 3504907, "UnitNumber": null, "UnmetDemandQuantity": null, "UOMCode": "Ea", "UOM": "Each", "UsingAssembly": "AI-ABP-5000", "DaysLate": 0, "Zone": null, "LineNumber": null, "SimulationSetId": -1, "SourceOrder": null, "SourceOrderLine": null, "FulfillmentLine": null, "DemandClassCode": null, "OrgCurrencyCode": "USD", "ModeOfTransport": null, "ServiceLevel": null, "ImplementShippingMethod": null, "DaysPastDue": 0, "ExpenseDestinationTransfer": "No", "ParentModel": null, "OrganizationTimeZone": "Coordinated Universal Time", "PlannerDescription": "JOHN BROWN", "SourceTimeZone": null, "DestinationTimeZone": null, "ImplementSourceOrganization": null, "ProjectValue": null, "TaskValue": null, "ProjectGroupValue": null, "ComponentQuantityIssued": null, "AssetNumber": null, "Action": "None", "ReleaseStatusText": "Ineligible", "SegmentName": "AI-Hard Pegged", "EndDemandValue": 100.0, "Message": "", "MarkForReleaseOption": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningDemands/3504907", "name": "PlanningDemands", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningDemands/3504907", "name": "PlanningDemands", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255", "name": "demandAndSupplyPlans", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningDemands/3504907/child/EndPeggedSupplies", "name": "EndPeggedSupplies", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningDemands/3504907/child/PeggedSupplies", "name": "PeggedSupplies", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningDemands/3504907/child/PlanningAttributes", "name": "PlanningAttributes", "kind": "collection" } ] }