Get one supply
get
/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/PlanningSupplies/{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:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : demandAndSupplyPlans-PlanningSupplies-item-response
Type:
Show Source
object
-
Action: string
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. -
AlternateBOMDesignator: string
Maximum Length:
4000
Name of the alternate bill of material. -
AlternateRoutingDesignator: string
Maximum Length:
400
Name of a routing used for the make order. -
AltFacilityUsed: integer
Title:
Alternate Facility Used
Read Only:true
Value that indicates whether the planned order uses an alternate facility or not. -
AltResourceUsed: integer
Title:
Alternate Resource Used
Read Only:true
Value that indicates whether the planned order uses an alternate resource or not. -
AltSupplierUsed: integer
Title:
Alternate Supplier Used
Read Only:true
Value that indicates whether the planned order uses an alternate supplier or not. -
AltWorkDefinitionUsed: integer
Title:
Alternate Work Definition Used
Read Only:true
Value that indicates whether the planned order uses an alternate work definition or not. -
AssetNumber: string
Title:
Asset
Read Only:true
Maximum Length:80
Number that identifies the asset associated with a maintenance work order. -
BatchQuantity: number
Title:
Batch Quantity
Read Only:true
Quantity that moves through operations in a process work order. -
BatchUOM: string
Title:
Batch Quantity UOM
Read Only:true
Maximum Length:30
Identifies the unit of measure for the batch quantity in a process work definition. -
BillSequenceId: integer
(int64)
Value that uniquely identifies the sequence in which a component is used within an operation.
-
BmtOption: integer
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. -
BOMItemType: integer
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. -
Buyer: string
Title:
Buyer
Read Only:true
Name of the buyer associated to the item. -
BuyerManagedTransportation: string
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. -
Canceled: integer
Read Only:
true
Value that indicates whether the supply has been canceled. -
CompletedQuantity: number
Title:
Completed Quantity
Read Only:true
Quantity of the work order that's already completed. -
ComponentQuantityIssued: number
Title:
Component Quantity Issued
Read Only:true
Quantity of a component issued to a work order. -
CompressionDays: number
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. -
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 drop ship purchase order. -
CustomerSite: string
Title:
Customer Site
Maximum Length:4000
Code associated with a specific customer ship-to location. -
DaysPastDue: number
Title:
Days Past Due
Read Only:true
Number of days that the supply date is in the past. -
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 for an order. -
EarliestStartDate: string
(date)
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 -
ExpectedScrapQuantity: number
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. -
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. -
ExpirationDate: string
(date)
Title:
Expiration Date
Date when the existing lot associated with the supply expires. -
FirmComponents: string
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. -
FirmDate: string
(date)
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. -
FirmPlannedType: integer
(int32)
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. -
FirmQuantity: number
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. -
FirmResources: string
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. -
FirmStartDate: string
(date)
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.
-
FirmStartQuantity: number
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. -
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. -
HoldDate: string
(date)
Title:
Hold Date
Read Only:true
Date on which the on-hand inventory lot is no longer on hold. -
ImplementAlternateBOM: string
Maximum Length:
100
Name of an alternate, nonprimary item structure that will be used when the order is released. -
ImplementAlternateRouting: string
Maximum Length:
100
Name of a routing that will be used when the order is released. -
ImplementAs: integer
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. -
ImplementDate: string
(date)
Title:
Implement Date
Date when the order is released. -
ImplementDockDate: string
(date)
Title:
Implement Dock Date
Date when the material should be on the receiving dock 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 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. -
ImplementItemStructure: string
Title:
Implement Item Structure Name
Maximum Length:4000
Name of the item structure for the order that's released. -
ImplementJobName: string
Title:
Implement Work Order Number
Maximum Length:120
Job name of the work order to be created when the order is released. -
ImplementLocation: string
Title:
Implement Location
Maximum Length:400
Value that identifies the deliver-to location to use when the order is released. -
ImplementOrderType: string
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. -
ImplementQuantity: number
Title:
Implement Quantity
Quantity of the order that's released. -
ImplementShipDate: string
(date)
Title:
Implement Ship Date
Date when the order is shipped. -
ImplementShipMethod: string
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. -
ImplementShippingMethod: string
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. -
ImplementSourceOrganization: string
Title:
Implement Source Organization
Maximum Length:100
Source organization used for the order that's released. -
ImplementStatus: string
Read Only:
true
Maximum Length:200
Status of the order to use when the order is released. Valid Values are Unreleased or Released. -
ImplementStatusCode: integer
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. -
ImplementSupplier: string
Title:
Implement Supplier
Maximum Length:360
Name of the supplier for the order that's released. -
ImplementSupplierSite: string
Title:
Implement Supplier Site
Maximum Length:300
Abbreviation that indicates the specific supplier ship-from location to use when the order is released. -
ImplementWIPClassCode: string
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. -
ImplementWorkDefinition: string
Title:
Implement Work Definition Name
Maximum Length:4000
Name of the work definition that's used when the order is released. -
ImplementWorkOrderSubtype: string
Read Only:
true
Maximum Length:200
Meaning associated with the ImplementWIPClassCode attribute. -
Item: string
Title:
Item
Maximum Length:300
Name of the item associated with the supply. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item that's associated with the supply. -
ItemStructureName: string
Title:
Item Structure Name
Maximum Length:100
Name of the item structure planned to be used for the make order. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the order was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the supply. -
LatestStartDate: string
(date)
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. -
LineNumber: string
Title:
Line Number
Read Only:true
Maximum Length:100
Number that identifies the order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Title:
Lot
Read Only:true
Maximum Length:80
Number that identifies the lot of the on-hand supply. -
MakeOrBuy: string
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. -
MarkForReleaseOption: string
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.
-
MaturityDate: string
(date)
Title:
Maturity Date
Read Only:true
Date when an inventory lot fully matures. It can then be used to fulfill demand. -
Message: string
Read Only:
true
Text of the error message, if any, encountered when creating or updating a supply. -
ModeOfTransport: integer
(int64)
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.
-
NeedByDate: string
(date)
Title:
Need-by Date
Read Only:true
Date when the supply quantity is needed. -
OldDockDate: string
(date)
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. -
OldDueDate: string
(date)
Title:
Old Due Date
Read Only:true
Date when the order was originally due. This attribute value is extracted from the source application. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:4000
Number that identifies the order associated with the supply. -
OrderQuantity: number
Title:
Order Quantity
Read Only:true
Quantity associated with the supply. -
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
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
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 associated with an organization. -
OrgCurrencyCode: string
Read Only:
true
Abbreviation that identifies the base currency of the organization. -
OriginalItemName: string
Title:
Requested Item
Read Only:true
Maximum Length:4000
Name of the requested item associated with the demand. -
OriginalNeedByDate: string
(date)
Title:
Original Need-by Date
Read Only:true
Date when the order was originally needed. This value is extracted from the source application. -
OriginalOrderQuantity: number
Title:
Original Order Quantity
Read Only:true
Original quantity associated with the order. This value is extracted from the source application. -
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. -
PeggedDemands: array
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. -
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
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. -
ProcessName: string
Title:
Process Name
Read Only:true
Maximum Length:120
Name of the manufacturing process used for this work order or planned order. -
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
Date when a customer has been promised the delivery of the order. -
PromisedShipDate: string
(date)
Title:
Promised Ship Date
Date when a customer has been promised the shipping of the order. -
QuantityInProcess: number
Title:
Quantity in Process
Quantity that's in the process of being released. -
ReadyToBuildPercentage: number
Title:
Ready-to-Build Percentage
Read Only:true
Percent of order quantity that can be built with currently available material. -
ReadyToBuildQuantity: number
Read Only:
true
Number of units of an assembly item for which components are available on hand. -
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. -
ReleaseTimeFenceCode: integer
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. -
RemainingQuantity: number
Read Only:
true
Work order quantity that remains to be completed. -
RequestedArrivalDate: string
(date)
Title:
Requested Arrival Date
Date when the material must arrive at the customer site. -
RequestedShipDate: string
(date)
Title:
Requested Ship Date
Date when the material must be shipped out to the customer. -
Rescheduled: string
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. -
RescheduleDays: number
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. -
ReservationType: string
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. -
ReservedQuantity: number
Title:
Reserved Quantity
Read Only:true
Quantity that's reserved against an order. -
ScheduledShipDate: string
(date)
Title:
Scheduled Ship Date
Read Only:true
Date when the order is scheduled to be shipped. -
ScheduleName: string
Title:
Schedule Name
Read Only:true
Maximum Length:4000
Name of the supply schedule associated with an order. -
ScrappedQuantity: number
Title:
Scrapped Quantity
Read Only:true
Work order quantity that has been scrapped. -
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 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.
-
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 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. -
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 identifies the specific ship-to location. -
SimulationSetId: integer
(int64)
Value that uniquely identifies the simulation set used in the plan, if any.
-
SourceOrganization: string
Title:
Source Organization
Maximum Length:49
Organization that will source the order. -
SourceTablePrimary: string
Maximum Length:
12
Value that identifies the data table source of the supply. -
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. -
SourceType: integer
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.
-
StartQuantity: number
Title:
Start Quantity
Quantity at the beginning of a manufacturing process. -
Subinventory: string
Title:
Subinventory
Read Only:true
Maximum Length:40
Subinventory code associated with the supply. -
SubstituteComponentUsed: integer
Title:
Substitute Component Used
Read Only:true
Value that indicates whether the planned order uses a substitute component or not. -
SuggestedCompletionDate: string
(date)
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. -
SuggestedDockDate: string
(date)
Title:
Suggested Dock Date
Read Only:true
Date when the order is recommended to arrive at the receiving dock. -
SuggestedDueDate: string
(date)
Title:
Suggested Due Date
Read Only:true
Date when a supply is expected to be completed. -
SuggestedOrderDate: string
(date)
Title:
Suggested Order Date
Read Only:true
Date when an 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. -
SuggestedStartDate: string
(date)
Title:
Suggested Start Date
Read Only:true
Date when work on the order is recommended to begin. -
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 location from where the item is being sourced. -
TaskValue: string
Maximum Length:
4000
Value that identifies task. -
TransactionId: integer
(int64)
Value that uniquely identifies the supply transaction. This value is internally generated by the application.
-
TransitLeadTime: number
Title:
Transit Lead Time
Read Only:true
Number of days that the supply is in transit between two locations. -
UOM: string
Read Only:
true
Maximum Length:200
Name of the unit of measure associated with the order quantity. -
UOMCode: string
Title:
UOM
Read Only:true
Abbreviation that identifies the unit of measure associated with the order quantity. -
UpstreamSupplies: array
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. -
WIPStatusCode: integer
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. -
WIPSupplyType: integer
(int64)
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. -
WorkDefinition: string
Title:
Work Definition
Maximum Length:100
Name that uniquely identifies a work definition used for a make order. -
WorkMethod: string
Read Only:
true
Maximum Length:4000
Type of manufacturing used for the production process. Valid values are Discrete Manufacturing and Process Manufacturing. -
WorkMethodCode: integer
Title:
Work Method
Type of manufacturing used for the production process. Valid values are 1: Discrete Manufacturing and 2: Process Manufacturing. -
WorkOrderStatus: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 : 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-PlanningSupplies-PeggedDemands-item-response
Type:
Show Source
object
-
DemandId: integer
(int64)
Read Only:
true
Value that identifies the pegged demand. -
EndDemandId: integer
(int64)
Read Only:
true
Value that identifies the end pegged independent demand. -
EndDemandOrderNumber: string
Read Only:
true
Maximum Length:400
Number that identifies the order associated with the pegged independent demand. -
Item: string
Read Only:
true
Maximum Length:400
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:400
Number that identifies the order associated with the demand. -
OrderQuantity: number
Read Only:
true
Quantity associated with the demand. -
OrderTypeText: string
Read Only:
true
Maximum Length:400
Type of demand such as forecast or sales order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Read Only:
true
Maximum Length:400
Name of the organization associated with the demand. -
PeggedQuantity: number
Read Only:
true
Quantity of the supply that's pegged to this demand. -
PeggingId: integer
(int64)
Read Only:
true
Value that identifies the association of the supply with the pegged demand. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that identifies the next level of supply and demand in the supply chain. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when a demand is expected to be satisfied.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningSupplies-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
Nested Schema : demandAndSupplyPlans-PlanningSupplies-UpstreamSupplies-item-response
Type:
Show Source
object
-
Item: string
Read Only:
true
Maximum Length:4000
Name of the item associated with the upstream 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 upstream supply. -
OrderQuantity: number
Read Only:
true
Quantity associated with the upstream 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 upstream supply. -
PeggedQuantity: number
Read Only:
true
Quantity of the upstream supply that's pegged to this supply. -
PeggingId: integer
(int64)
Read Only:
true
Value that identifies the association of this supply with the upstream supply. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that identifies the next level of supply and demand in the supply chain. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when a upstream supply is expected to be completed. -
TransactionId: integer
(int64)
Read Only:
true
Value that identifies the pegged upstream supply.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PeggedDemands
-
Parameters:
- PlanId:
$request.path.PlanId
- TransactionId3:
$request.path.TransactionId3
The Pegged Demands resource manages all the demands that are pegged to a specific planning supply at the same level. - PlanId:
- PlanningAttributes
-
Parameters:
- PlanId:
$request.path.PlanId
- TransactionId3:
$request.path.TransactionId3
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply. - PlanId:
- UpstreamSupplies
-
Parameters:
- PlanId:
$request.path.PlanId
- TransactionId3:
$request.path.TransactionId3
The Upstream Supplies resource manages all the supplies that are pegged to a specific planning supply at the next level upstream. - PlanId:
Examples
This example describes how to get one supply.
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/PlanningSupplies/TransactionId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningSupplies/99091296"
Example Response Body
The following shows an example of the response body in JSON format.
{ "AlternateBOMDesignator": null, "AlternateRoutingDesignator": "AI-ABP-5000", "BillSequenceId": 2772487, "BOMItemType": 4, "Buyer": null, "CreatedBy": "OPERATIONS", "CreationDate": "2021-06-22T23:45:16.291+00:00", "CustomerSite": null, "ItemDescription": "AI-ABP-5000", "DestOrgCode": null, "Canceled": 2, "ExpirationDate": null, "FirmDate": null, "FirmQuantity": null, "ImplementAlternateBOM": null, "ImplementAlternateRouting": null, "ImplementAs": null, "ImplementOrderType": null, "ImplementDockDate": null, "ImplementFirm": null, "ImplementFirmOption": null, "ImplementJobName": null, "ImplementQuantity": null, "ImplementShipDate": null, "ImplementShipMethod": null, "ImplementStatusCode": null, "ImplementStatus": null, "ImplementWIPClassCode": null, "ImplementWorkOrderSubtype": null, "ImplementedQuantity": null, "ImplementDate": null, "TransitLeadTime": null, "Item": "AI-ABP-5000", "Organization": "PDSCM1", "OrderTypeText": "Work order", "FirmPlannedType": 2, "FirmStatus": "Not firm", "SuggestedDueDate": "2030-01-16", "OrderNumber": "M1-1017", "Planner": "JOHN BROWN", "Customer": null, "ReleaseStatus": 2, "SuggestedShipDate": null, "LastUpdateDate": "2021-06-22T23:45:16.291+00:00", "LastUpdatedBy": "OPERATIONS", "NeedByDate": "2030-01-16", "SuggestedDockDate": "2030-01-16", "SuggestedOrderDate": "2030-01-14", "SuggestedStartDate": "2030-01-16", "OldDockDate": "2030-01-17", "OldDueDate": "2030-01-17", "OrderType": 3, "OriginalNeedByDate": null, "OriginalOrderQuantity": 15, "PlanId": 300100561723255, "PlanningMakeBuyCode": 1, "MakeOrBuy": "Make", "PromisedArrivalDate": null, "PromisedShipDate": null, "OrderQuantity": 15, "QuantityInProcess": null, "ReleaseErrors": null, "ReleaseTimeFenceCode": 4, "RequestedArrivalDate": null, "RequestedShipDate": null, "RescheduleDays": -1, "Rescheduled": "Yes", "ReservedQuantity": null, "CompressionDays": null, "ScheduledShipDate": null, "SellingPrice": null, "ShipCalendar": null, "ShipMethod": null, "ShippingMethod": null, "ShipTo": null, "SourceOrganization": "PDSCM1", "SourceTablePrimary": "MSC_SUPPLIES", "Supplier": null, "SupplierSite": null, "Subinventory": null, "TransactionId": 99091296, "UOMCode": "Ea", "UOM": "Each", "StartQuantity": 15, "WIPStatusCode": 3, "WorkOrderStatus": "Released", "WIPSupplyType": 1, "FirmStartDate": null, "ReadyToBuildPercentage": 0, "ReadyToBuildQuantity": 0, "LineNumber": null, "SimulationSetId": -1, "ImplementSupplier": null, "ImplementSupplierSite": null, "BmtOption": 2, "BuyerManagedTransportation": "No", "Lot": null, "OrgCurrencyCode": null, "ModeOfTransport": null, "ServiceLevel": null, "ImplementShippingMethod": null, "ItemStructureName": "Primary", "WorkDefinition": "AI-ABP-5000", "ImplementItemStructure": null, "ImplementWorkDefinition": null, "DaysPastDue": 0, "ExpenseDestinationTransfer": "No", "ParentModel": null, "CompletedQuantity": 0, "ScrappedQuantity": 0, "ExpectedScrapQuantity": 0, "FirmStartQuantity": null, "RemainingQuantity": 15, "OrganizationTimeZone": "Coordinated Universal Time", "PlannerDescription": "JOHN BROWN", "SourceTimeZone": null, "DestinationTimeZone": null, "AltFacilityUsed": 2, "AltSupplierUsed": 2, "AltWorkDefinitionUsed": 2, "AltResourceUsed": 2, "SubstituteComponentUsed": 2, "BatchQuantity": null, "SuggestedCompletionDate": "2030-01-16", "WorkMethodCode": 1, "WorkMethod": "Discrete manufacturing", "ProcessName": null, "BatchUOM": null, "ImplementSourceOrganization": null, "ProjectValue": null, "TaskValue": null, "ProjectGroupValue": null, "ComponentQuantityIssued": null, "AssetNumber": null, "Action": "Reschedule in", "ReleaseStatusText": "Reschedule", "SegmentName": "AI-Hard Pegged", "ReservationType": null, "FirmComponents": null, "FirmResources": null, "SourceType": null, "Message": "", "MarkForReleaseOption": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningSupplies/99091296", "name": "PlanningSupplies", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningSupplies/99091296", "name": "PlanningSupplies", "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/PlanningSupplies/99091296/child/PeggedDemands", "name": "PeggedDemands", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningSupplies/99091296/child/PlanningAttributes", "name": "PlanningAttributes", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100561723255/child/PlanningSupplies/99091296/child/UpstreamSupplies", "name": "UpstreamSupplies", "kind": "collection" } ] }