Get details of all upstream supply orders at the next level upstream in the supply chain
get
/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/UpstreamOrders
Request
Path Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the upstream orders using the primary key.
Finder Variables- PeggingId; integer; Value that uniquely identifies the pegging.
- PlanId; integer; Value that uniquely identifies the plan.
- TransactionId; integer; Value that uniquely identifies the order.
- PrimaryKey Finds the upstream orders using the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Action; string; Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
- ActionCode; integer; Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS.
- AltFacilityUsed; integer; Value that indicates whether the planned order uses an alternate facility or not.
- AltResourceUsed; integer; Value that indicates whether the planned order uses an alternate resource or not.
- AltSupplierUsed; integer; Value that indicates whether the planned order uses an alternate supplier or not.
- AltWorkDefinitionUsed; integer; Value that indicates whether the planned order uses an alternate work definition or not.
- AlternateBOMDesignator; string; Name of the alternate bill of material.
- AlternateFacilityUsed; string; Indicates whether the planned order uses an alternate facility. Valid values are Yes or No. If Yes, then the planned order uses an alternate facility. If No, then the planned order doesn't use an alternate facility. Only applicable for constrained plans.
- AlternateResourceUsed; string; Indicates whether the planned order uses an alternate resource. Valid values are Yes or No. If Yes, then the planned order uses an alternate resource. If No, then the planned order doesn't use an alternate resource. Only applicable for constrained plans.
- AlternateRoutingDesignator; string; Name of a routing used for the make order.
- AlternateSupplierUsed; string; Indicates whether the planned order uses an alternate supplier. Valid values are Yes or No. If Yes, then the planned order uses an alternate supplier. If No, then the planned order doesn't use an alternate supplier. Only applicable for constrained plans.
- AlternateWorkDefinitionUsed; string; Indicates whether the planned order uses an alternate work definition. Valid values are Yes or No. If Yes, then the planned order uses an alternate work definition. If No, then the planned order doesn't use an alternate work definition. Only applicable for constrained plans.
- AssetNumber; string; Number that identifies the asset associated with a maintenance work order.
- 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.
- BatchQuantity; number; Quantity that moves through operations in a process work order.
- BatchUOM; string; Identifies the unit of measure for the batch quantity in a process work definition.
- BillSequenceId; integer; Value that uniquely identifies the sequence in which a component is used within an operation.
- BmtOption; integer; 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.
- Buyer; string; Name of the buyer associated with the item.
- BuyerManagedTransportation; string; 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; Value that indicates whether the supply has been canceled.
- CanceledText; string; Value that indicates whether the supply has been canceled. Valid values are: Yes or No. If Yes, then the supply has been canceled. If No, then the supply hasn't been canceled.
- CarrierId; integer; Value that uniquely identifies the carrier.
- CategoryName; string; Name of the category to which the item is assigned.
- ChildOrganization; string; Organization code of an organization that's modeled as a child organization with a modeled subinventory code.
- ChildOrganizationId; integer; Value that uniquely identifies the child organization.
- CompletedQuantity; number; Order quantity that's already been completed.
- CompressionDays; number; Number of days prior to the plan start date that the order has to be scheduled to be considered on time.
- ConsumptionStartDate; string; Date when a supply starts being consumed by demands.
- ContributesDmdLateness; number; Indicates whether the supply is on the critical path leading to a demand that's satisfied late. Valid values are 1 or 2. If 1, then the supply is on the critical path leading to a demand that's satisfied late. If 2, then the supply isn't on the critical path leading to a demand that's satisfied late. Only applicable for constrained plans.
- ContributesOverload; number; Indicates whether the supply contributes to a capacity overload. Valid values are 1 or 2. If 1, then the supply contributes to a capacity overload. If 2, then the supply doesn't contribute to a capacity overload. Only applicable for constrained plans.
- ContributesToDemandLateness; string; Meaning associated with the ContributesDmdLateness attribute. Value values are Yes and No.
- ContributesToOverload; string; Meaning associated with the ContributesOverload attribute. Value values are Yes and No.
- CreatedBy; string; User who created the order.
- CreationDate; string; Date when the user created the order.
- CumulativeYield; number; Name of the column that contains the cumulative yield. For example, the name of the column in the Supplies and Demands view. This column is the product of operation yields of all the operations in the work definition of an item.
- Customer; string; Name of the customer associated with the order.
- CustomerId; integer; Value that uniquely identifies the customer.
- CustomerSite; string; Code associated with a specific customer ship-to location.
- CustomerSiteId; integer; Value that uniquely identifies the customer site.
- DaysPastDue; number; Number of days that the order due date is in past.
- DestOrgCode; string; Abbreviation that identifies the destination organization of an order.
- DestinationTimeZone; string; Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
- DestinationType; string; Value that indicates where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE.
- DropShipDestType; integer; Code that identifies where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE.
- EarliestStartDate; string; 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
- EndDemandValue; number; Monetary value associated with the end demand.
- EndPeggingId; integer; Value that uniquely identifies the end pegged order.
- ExpectedScrapQuantity; number; Quantity of the work order or planned order that's expected to be scrapped in addition to the quantity already scrapped.
- ExpenseDestinationTransfer; string; 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.
- ExpenseTransfer; integer; 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 when the existing lot associated with the supply expires.
- FirmDate; string; The date when the order is due. This attribute is a fixed value that can't be rescheduled by planning and is populated only when the firm status is set to firm.
- FirmPlannedType; integer; 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; The fixed quantity of the order. This attribute value can't be changed by planning and is populated only when the firm status is set to firm.
- FirmStartDate; string; 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; 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; 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.
- HasFirmComponent; integer; 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.
- HasFirmResource; integer; 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.
- HoldDate; string; Date on which the on-hand inventory lot is no longer on hold.
- ImplementAlternateBOM; string; Name of an alternate, nonprimary item structure that will be used when the order is released.
- ImplementAlternateRouting; string; Name of a routing that will be used when the order is released.
- ImplementAs; integer; 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 when the order is released.
- ImplementDockDate; string; Date when the material should be on the receiving dock when the order is released.
- ImplementFirm; integer; 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; 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; Name of the item structure for the order that's released.
- ImplementJobName; string; Job name of the work order to be created when the order is released.
- ImplementLocation; string; Value that identifies the deliver-to location to use when the order is released.
- ImplementLocationId; integer; Value that uniquely identifies the deliver-to location to use when the order is released.
- ImplementOrderType; string; 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; Quantity of the order that's released.
- ImplementShipDate; string; Date when the order is shipped.
- ImplementShipMethod; string; 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; 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.
- ImplementSourceOrgId; integer; Value that uniquely identifies the source organization to use when the order is released.
- ImplementSourceOrganization; string; Source organization used for the order that's released.
- ImplementStatus; string; Status of the order to use when the order is released. Valid Values are Unreleased or Released.
- ImplementStatusCode; integer; 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; Name of the supplier for the order that's released.
- ImplementSupplierSite; string; Abbreviation that indicates the specific supplier ship-from location to use when the order is released.
- ImplementVendorId; integer; Value that uniquely identifies the supplier to use when the order is released.
- ImplementVendorSiteId; integer; Value that uniquely identifies the specific supplier ship-from location to use when the order is released.
- ImplementWIPClassCode; string; 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; Name of the work definition that's used when the order is released.
- ImplementWorkOrderSubtype; string; Meaning associated with the ImplementWIPClassCode attribute.
- ImplementedQuantity; number; Cumulative quantity that has been released to date.
- InventoryItemId; integer; Value that uniquely identifies the item.
- Item; string; Name of the item associated with the order.
- ItemDescription; string; Description of the item associated with the demand.
- ItemStructureName; string; Name of the item structure planned to be used for the make order.
- LastUpdateDate; string; Date when the order was most recently updated.
- LastUpdatedBy; string; User who most recently updated the demand.
- LatestStartDate; string; 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; Number that identifies the order line.
- Lot; string; Number that identifies the lot of the on-hand supply.
- MakeOrBuy; string; 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.
- MaturityDate; string; Date when an inventory lot fully matures. It can then be used to fulfill demand.
- ModeOfTransport; integer; 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.
- MtqSupplyDate; string; Date when the first minimum transfer quantity supply of the upstream process is available for the downstream process.
- NeedByDate; string; Date when the order is needed.
- OldDockDate; string; Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application.
- OldDueDate; string; Date when the order was originally due. This attribute value is extracted from the source application.
- OperationSequenceNumber; integer; Number that identifies the execution sequence of the operation.
- OrderNumber; string; Number that identifies the order.
- OrderQuantity; number; Quantity associated with the order.
- OrderStatus; integer; SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.
- OrderType; integer; Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
- OrderTypeText; string; 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.
- OrgCurrencyCode; string; Abbreviation that identifies the base currency of the organization.
- Organization; string; Name of the organization associated with the order.
- OrganizationId; integer; Value that uniquely identifies the organization.
- OrganizationTimeZone; string; Time zone associated with an organization.
- OriginalItemId; integer; Value that uniquely identifies the requested item.
- OriginalNeedByDate; string; Date when the order was originally needed. This value is extracted from the source application.
- OriginalOrderQuantity; number; Original quantity associated with the order. This value is extracted from the source application.
- ParentModel; string; Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option.
- PeggedDemandId; integer; Value that uniquely identifies the demand at the next upstream level in the pegging chain.
- PeggedQuantity; number; Quantity of the upstream supply that's pegged to this supply.
- PeggedToFirm; number; Indicates whether the supply pegs to a downstream supply that's firm. Valid values are 1 or 2. If 1, then the supply pegs to a downstream supply that's firm. If 2, then it doesn't peg to a downstream supply that's firmed.
- PeggedToFirmText; string; Value that indicates whether the supply pegs to a downstream supply that's firm. Valid values are: Yes or No. If Yes, then supply is pegged to a downstream supply that's firm. If No, then it isn't pegged to a downstream supply that's firmed.
- PeggingId; integer; Value that identifies the association of this order with the upstream order.
- PeggingType; integer; 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.
- PlanId; integer; Value that uniquely identifies the plan.
- Planner; string; Abbreviation that identifies the planner responsible for the item.
- PlannerDescription; string; Description of the planner responsible for the item.
- PlanningMakeBuyCode; integer; 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.
- PreviousPeggingId; integer; Value that uniquely identifies the pegging record at the next upstream level in the pegging chain.
- ProcessName; string; Name of the manufacturing process used for this work order or planned order.
- ProcessSequenceId; integer; Value that uniquely identifies the manufacturing process that was used for the make order.
- ProjectGroupValue; string; Value that identifies the project group.
- ProjectValue; string; Value that identifies the project.
- PromisedArrivalDate; string; Date when a customer has been promised the delivery of the order.
- PromisedShipDate; string; Date when a customer has been promised the shipping of the order.
- QuantityInProcess; number; Quantity that's in the process of being released.
- ReadyToBuildPercentage; number; Percent of order quantity that can be built with currently available material.
- ReadyToBuildQuantity; number; Number of units of an assembly item for which components are available on hand.
- ReleaseErrors; string; Errors that are generated in the release process.
- ReleaseStatus; integer; 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; 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; 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; Work order quantity that remains to be completed.
- RequestedArrivalDate; string; Date when the material must arrive at the customer site.
- RequestedItem; string; Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand.
- RequestedItemDescription; string; Description of the item that's being requested.
- RequestedShipDate; string; Date when the material must be shipped out to the customer.
- RescheduleDays; number; 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.
- Rescheduled; string; Value that indicates whether or not the order has been rescheduled. Contains one of the following values: Yes or No. If Yes, then the order has been rescheduled. If No, then the order hasn't been rescheduled.
- RescheduledOption; integer; 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; Quantity that's reserved against an order.
- RoutingSequenceId; integer; Value that uniquely identifies the routing that was used for the make order.
- RowModified; string; Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified.
- ScheduleName; string; Name of the supply or demand schedule associated with an order.
- ScheduledShipDate; string; Date when the order is scheduled to be shipped.
- ScrappedQuantity; number; Work order quantity that has been scrapped.
- SegmentId; integer; Value that uniquely identifies the segment.
- SegmentName; string; Name of the segment used for a set of items.
- SellingPrice; number; Selling price of an item on the order line.
- ServiceLevel; integer; 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.
- SharedSupply; number; Indicates whether the supply is shared by more than one demand. Valid values are 1 or 2. If 1, then the supply is shared by more than one demand. If 2, then the supply isn't shared.
- SharedSupplyText; string; Value that indicates whether the supply is shared by more than one demand. Valid values are: Yes or No. If Yes, then supply is shared by more than one demand. If No, then it isn't shared by more than one demand.
- ShipCalendar; string; Shipping calendar associated with the order.
- ShipMethod; string; 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.
- ShipTo; string; Abbreviation that identifies the specific ship-to location.
- ShippingMethod; string; 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.
- SourceOrganization; string; Organization that will source the order.
- SourceOrganizationId; integer; Value that uniquely identifies the source organization.
- SourceTablePrimary; string; Value that identifies the data table source of the supply.
- SourceTimeZone; string; Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
- StartQuantity; number; Quantity at the beginning of a manufacturing process.
- StartTransactionId; integer; Value that uniquely identifies the supply at the next upstream level in the pegging chain.
- Subinventory; string; Subinventory code associated with the order.
- SubinventoryCodeOfChildOrg; string; Subinventory code of an organization that's a modeled as a child of a parent organization, and from which supply is recast into a modeled subinventory in its parent organization.
- SubstItemId; integer; Value that uniquely identifies the substitute item.
- SubstituteComponentUsed; integer; Value that indicates whether the planned order uses a substitute component or not.
- SubstituteComponentUsedText; string; Meaning associated with the SubstituteComponentUsed attribute. Valid values are Yes and No.
- SuggestedCompletionDate; string; 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 when the order is recommended to arrive at the receiving dock.
- SuggestedDueDate; string; Date when an order is expected to be completed.
- SuggestedOrderDate; string; Date when the order is recommended to be placed.
- SuggestedShipDate; string; Date when the order is recommended to be shipped.
- SuggestedStartDate; string; Date when work on the order is recommended to begin.
- SuppliedItem; string; Name of the supplied item.
- SuppliedItemDescription; string; Description of the supplied item.
- Supplier; string; Name of the source supplier.
- SupplierId; integer; Value that uniquely identifies the supplier.
- SupplierSite; string; Abbreviation that indicates the specific supplier ship-from location.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site.
- TaskValue; string; Value that identifies task.
- TransactionId; integer; Value that uniquely identifies the order.
- TransitLeadTime; number; Number of days the order is in transit between two locations.
- UOM; string; Name of the unit of measure associated with the order quantity.
- UOMCode; string; Abbreviation that identifies the unit of measure associated with the order quantity.
- UsesOrderModifier; number; Meaning associated with the UsesOrderModifierIndicator attribute. Valid values are Yes and No.
- UsesOrderModifierText; string; Value that indicates whether the supply quantity has been determined by applying an order modifier. Valid values are: Yes or No. If Yes, then an order modifier was applied to the supply quantity. If No, then it hasn't.
- WIPStatusCode; integer; 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; 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; Name that uniquely identifies a work definition used for a make order.
- WorkMethod; string; Type of manufacturing used for the production process. Valid values are Discrete Manufacturing and Process Manufacturing.
- WorkMethodCode; integer; Type of manufacturing used for the production process. Valid values are 1: Discrete Manufacturing and 2: Process Manufacturing.
- WorkOrderStatus; string; 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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-UpstreamOrders
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplyPlans-UpstreamOrders-item-response
Type:
Show Source
object
-
Action: string
Read Only:
true
Maximum Length:4000
Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS. -
ActionCode: integer
Read Only:
true
Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS. -
AlternateBOMDesignator: string
Read Only:
true
Maximum Length:4000
Name of the alternate bill of material. -
AlternateFacilityUsed: string
Read Only:
true
Maximum Length:4000
Indicates whether the planned order uses an alternate facility. Valid values are Yes or No. If Yes, then the planned order uses an alternate facility. If No, then the planned order doesn't use an alternate facility. Only applicable for constrained plans. -
AlternateResourceUsed: string
Read Only:
true
Maximum Length:4000
Indicates whether the planned order uses an alternate resource. Valid values are Yes or No. If Yes, then the planned order uses an alternate resource. If No, then the planned order doesn't use an alternate resource. Only applicable for constrained plans. -
AlternateRoutingDesignator: string
Read Only:
true
Maximum Length:400
Name of a routing used for the make order. -
AlternateSupplierUsed: string
Read Only:
true
Maximum Length:4000
Indicates whether the planned order uses an alternate supplier. Valid values are Yes or No. If Yes, then the planned order uses an alternate supplier. If No, then the planned order doesn't use an alternate supplier. Only applicable for constrained plans. -
AlternateWorkDefinitionUsed: string
Read Only:
true
Maximum Length:4000
Indicates whether the planned order uses an alternate work definition. Valid values are Yes or No. If Yes, then the planned order uses an alternate work definition. If No, then the planned order doesn't use an alternate work definition. Only applicable for constrained plans. -
AltFacilityUsed: integer
Read Only:
true
Value that indicates whether the planned order uses an alternate facility or not. -
AltResourceUsed: integer
Read Only:
true
Value that indicates whether the planned order uses an alternate resource or not. -
AltSupplierUsed: integer
Read Only:
true
Value that indicates whether the planned order uses an alternate supplier or not. -
AltWorkDefinitionUsed: integer
Read Only:
true
Value that indicates whether the planned order uses an alternate work definition or not. -
AssetNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the asset associated with a maintenance work order. -
BatchQuantity: number
Read Only:
true
Quantity that moves through operations in a process work order. -
BatchUOM: string
Read Only:
true
Maximum Length:30
Identifies the unit of measure for the batch quantity in a process work definition. -
BillSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the sequence in which a component is used within an operation. -
BmtOption: integer
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 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. -
Buyer: string
Read Only:
true
Name of the buyer associated with 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. -
CanceledText: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the supply has been canceled. Valid values are: Yes or No. If Yes, then the supply has been canceled. If No, then the supply hasn't been canceled. -
CarrierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the carrier. -
CategoryName: string
Read Only:
true
Maximum Length:4000
Name of the category to which the item is assigned. -
ChildOrganization: string
Read Only:
true
Maximum Length:4000
Organization code of an organization that's modeled as a child organization with a modeled subinventory code. -
ChildOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the child organization. -
CompletedQuantity: number
Read Only:
true
Order quantity that's already been completed. -
CompressionDays: number
Read Only:
true
Number of days prior to the plan start date that the order has to be scheduled to be considered on time. -
ConsumptionStartDate: string
(date)
Read Only:
true
Date when a supply starts being consumed by demands. -
ContributesDmdLateness: number
Read Only:
true
Indicates whether the supply is on the critical path leading to a demand that's satisfied late. Valid values are 1 or 2. If 1, then the supply is on the critical path leading to a demand that's satisfied late. If 2, then the supply isn't on the critical path leading to a demand that's satisfied late. Only applicable for constrained plans. -
ContributesOverload: number
Read Only:
true
Indicates whether the supply contributes to a capacity overload. Valid values are 1 or 2. If 1, then the supply contributes to a capacity overload. If 2, then the supply doesn't contribute to a capacity overload. Only applicable for constrained plans. -
ContributesToDemandLateness: string
Read Only:
true
Maximum Length:4000
Meaning associated with the ContributesDmdLateness attribute. Value values are Yes and No. -
ContributesToOverload: string
Read Only:
true
Maximum Length:4000
Meaning associated with the ContributesOverload attribute. Value values are Yes and No. -
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. -
CumulativeYield: number
Read Only:
true
Name of the column that contains the cumulative yield. For example, the name of the column in the Supplies and Demands view. This column is the product of operation yields of all the operations in the work definition of an item. -
Customer: string
Read Only:
true
Name of the customer associated with the order. -
CustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer. -
CustomerSite: string
Read Only:
true
Code associated with a specific customer ship-to location. -
CustomerSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer site. -
DaysPastDue: number
Read Only:
true
Number of days that the order due date is in past. -
DestinationTimeZone: string
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. -
DestinationType: string
Read Only:
true
Maximum Length:200
Value that indicates where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE. -
DestOrgCode: string
Read Only:
true
Abbreviation that identifies the destination organization of an order. -
DropShipDestType: integer
Read Only:
true
Code that identifies where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE. -
EarliestStartDate: string
(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 -
EndDemandValue: number
Read Only:
true
Monetary value associated with the end demand. -
EndPeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the end pegged order. -
ExpectedScrapQuantity: number
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. -
ExpenseTransfer: integer
Read Only:
true
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)
Read Only:
true
Date when the existing lot associated with the supply expires. -
FirmDate: string
(date)
Read Only:
true
The date when the order is due. This attribute is a fixed value that can't be rescheduled by planning and is populated only when the firm status is set to firm. -
FirmPlannedType: integer
Read Only:
true
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
Read Only:true
The fixed quantity of the order. This attribute value can't be changed by planning and is populated only when the firm status is set to firm. -
FirmStartDate: string
(date)
Read Only:
true
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
Read Only:true
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. -
HasFirmComponent: integer
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.
-
HasFirmResource: integer
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.
-
HoldDate: string
(date)
Read Only:
true
Date on which the on-hand inventory lot is no longer on hold. -
ImplementAlternateBOM: string
Read Only:
true
Maximum Length:100
Name of an alternate, nonprimary item structure that will be used when the order is released. -
ImplementAlternateRouting: string
Read Only:
true
Maximum Length:100
Name of a routing that will be used when the order is released. -
ImplementAs: integer
Read Only:
true
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)
Read Only:
true
Date when the order is released. -
ImplementDockDate: string
(date)
Read Only:
true
Date when the material should be on the receiving dock when the order is released. -
ImplementedQuantity: number
Read Only:
true
Cumulative quantity that has been released to date. -
ImplementFirm: integer
Read Only:
true
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
Read Only:
true
Maximum Length:400
Name of the item structure for the order that's released. -
ImplementJobName: string
Read Only:
true
Maximum Length:120
Job name of the work order to be created when the order is released. -
ImplementLocation: string
Read Only:
true
Maximum Length:200
Value that identifies the deliver-to location to use when the order is released. -
ImplementLocationId: integer
(int64)
Read Only:
true
Value that uniquely 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
Read Only:true
Quantity of the order that's released. -
ImplementShipDate: string
(date)
Read Only:
true
Date when the order is shipped. -
ImplementShipMethod: string
Read Only:
true
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
Read Only:
true
Maximum Length:4000
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
Read Only:
true
Maximum Length:100
Source organization used for the order that's released. -
ImplementSourceOrgId: integer
(int64)
Read Only:
true
Value that uniquely identifies the source organization to use when the order is 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
Read Only:
true
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
Read Only:
true
Maximum Length:360
Name of the supplier for the order that's released. -
ImplementSupplierSite: string
Read Only:
true
Maximum Length:300
Abbreviation that indicates the specific supplier ship-from location to use when the order is released. -
ImplementVendorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier to use when the order is released. -
ImplementVendorSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the specific supplier ship-from location to use when the order is released. -
ImplementWIPClassCode: string
Read Only:
true
Maximum Length:10
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
Read Only:
true
Maximum Length:400
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. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
Item: string
Read Only:
true
Maximum Length:300
Name of the item associated with the order. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item associated with the demand. -
ItemStructureName: string
Read Only:
true
Maximum Length:400
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 demand. -
LatestStartDate: string
(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
Read Only:
true
Number that identifies the order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Read Only:
true
Maximum Length:80
Number that identifies the lot of the on-hand supply. -
MakeOrBuy: string
Read Only:
true
Maximum Length:10
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. -
MaturityDate: string
(date)
Read Only:
true
Date when an inventory lot fully matures. It can then be used to fulfill demand. -
ModeOfTransport: integer
(int64)
Read Only:
true
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. -
MtqSupplyDate: string
(date)
Read Only:
true
Date when the first minimum transfer quantity supply of the upstream process is available for the downstream process. -
NeedByDate: string
(date)
Read Only:
true
Date when the order is needed. -
OldDockDate: string
(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)
Read Only:
true
Date when the order was originally due. This attribute value is extracted from the source application. -
OperationSequenceNumber: integer
(int64)
Read Only:
true
Number that identifies the execution sequence of the operation. -
OrderNumber: string
Read Only:
true
Maximum Length:4000
Number that identifies the order. -
OrderQuantity: number
Read Only:
true
Quantity associated with the order. -
OrderStatus: integer
Read Only:
true
SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process. -
OrderType: integer
Read Only:
true
Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
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:49
Name of the organization associated with the order. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization. -
OrganizationTimeZone: string
Read Only:
true
Maximum Length:400
Time zone associated with an organization. -
OrgCurrencyCode: string
Read Only:
true
Abbreviation that identifies the base currency of the organization. -
OriginalItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requested item. -
OriginalNeedByDate: string
(date)
Read Only:
true
Date when the order was originally needed. This value is extracted from the source application. -
OriginalOrderQuantity: number
Read Only:
true
Original quantity associated with the order. This value is extracted from the source application. -
ParentModel: string
Read Only:
true
Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option. -
PeggedDemandId: integer
(int64)
Read Only:
true
Value that uniquely identifies the demand at the next upstream level in the pegging chain. -
PeggedQuantity: number
Read Only:
true
Quantity of the upstream supply that's pegged to this supply. -
PeggedToFirm: number
Read Only:
true
Indicates whether the supply pegs to a downstream supply that's firm. Valid values are 1 or 2. If 1, then the supply pegs to a downstream supply that's firm. If 2, then it doesn't peg to a downstream supply that's firmed. -
PeggedToFirmText: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the supply pegs to a downstream supply that's firm. Valid values are: Yes or No. If Yes, then supply is pegged to a downstream supply that's firm. If No, then it isn't pegged to a downstream supply that's firmed. -
PeggingId: integer
(int64)
Read Only:
true
Value that identifies the association of this order with the upstream order. -
PeggingType: integer
(int32)
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. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the plan. -
Planner: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Read Only:
true
Maximum Length:100
Description of the planner responsible for the item. -
PlanningMakeBuyCode: integer
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. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pegging record at the next upstream level in the pegging chain. -
ProcessName: string
Read Only:
true
Maximum Length:120
Name of the manufacturing process used for this work order or planned order. -
ProcessSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the manufacturing process that was used for the make order. -
ProjectGroupValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the project group. -
ProjectValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the project. -
PromisedArrivalDate: string
(date)
Read Only:
true
Date when a customer has been promised the delivery of the order. -
PromisedShipDate: string
(date)
Read Only:
true
Date when a customer has been promised the shipping of the order. -
QuantityInProcess: number
Read Only:
true
Quantity that's in the process of being released. -
ReadyToBuildPercentage: number
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:250
Errors that are generated in the release process. -
ReleaseStatus: integer
Read Only:
true
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:4000
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)
Read Only:
true
Date when the material must arrive at the customer site. -
RequestedItem: string
Read Only:
true
Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand. -
RequestedItemDescription: string
Read Only:
true
Maximum Length:4000
Description of the item that's being requested. -
RequestedShipDate: string
(date)
Read Only:
true
Date when the material must be shipped out to the customer. -
Rescheduled: string
Read Only:
true
Maximum Length:100
Value that indicates whether or not the order has been rescheduled. Contains one of the following values: Yes or No. If Yes, then the order has been rescheduled. If No, then the order hasn't been rescheduled. -
RescheduleDays: number
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. -
RescheduledOption: integer
Read Only:
true
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
Read Only:
true
Quantity that's reserved against an order. -
RoutingSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the routing that was used for the make order. -
RowModified: string
Read Only:
true
Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified. -
ScheduledShipDate: string
(date)
Read Only:
true
Date when the order is scheduled to be shipped. -
ScheduleName: string
Read Only:
true
Maximum Length:4000
Name of the supply or demand schedule associated with an order. -
ScrappedQuantity: number
Read Only:
true
Work order quantity that has been scrapped. -
SegmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the segment. -
SegmentName: string
Read Only:
true
Maximum Length:4000
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)
Read Only:
true
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. - SharedSupply: number
- SharedSupplyText: string
-
ShipCalendar: string
Read Only:
true
Maximum Length:15
Shipping calendar associated with the order. -
ShipMethod: string
Read Only:
true
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
Read Only:
true
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
Read Only:
true
Abbreviation that identifies the specific ship-to location. -
SourceOrganization: string
Read Only:
true
Maximum Length:18
Organization that will source the order. -
SourceOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the source organization. -
SourceTablePrimary: string
Read Only:
true
Maximum Length:12
Value that identifies the data table source of the supply. -
SourceTimeZone: string
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. -
StartQuantity: number
Read Only:
true
Quantity at the beginning of a manufacturing process. -
StartTransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supply at the next upstream level in the pegging chain. -
Subinventory: string
Read Only:
true
Maximum Length:10
Subinventory code associated with the order. -
SubinventoryCodeOfChildOrg: string
Read Only:
true
Maximum Length:10
Subinventory code of an organization that's a modeled as a child of a parent organization, and from which supply is recast into a modeled subinventory in its parent organization. -
SubstItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the substitute item. -
SubstituteComponentUsed: integer
Read Only:
true
Value that indicates whether the planned order uses a substitute component or not. -
SubstituteComponentUsedText: string
Read Only:
true
Maximum Length:4000
Meaning associated with the SubstituteComponentUsed attribute. Valid values are Yes and No. -
SuggestedCompletionDate: string
(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)
Read Only:
true
Date when the order is recommended to arrive at the receiving dock. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when an order is expected to be completed. -
SuggestedOrderDate: string
(date)
Read Only:
true
Date when the order is recommended to be placed. -
SuggestedShipDate: string
(date)
Read Only:
true
Date when the order is recommended to be shipped. -
SuggestedStartDate: string
(date)
Read Only:
true
Date when work on the order is recommended to begin. -
SuppliedItem: string
Read Only:
true
Maximum Length:4000
Name of the supplied item. -
SuppliedItemDescription: string
Read Only:
true
Maximum Length:4000
Description of the supplied item. -
Supplier: string
Read Only:
true
Maximum Length:4000
Name of the source supplier. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplierSite: string
Read Only:
true
Maximum Length:4000
Abbreviation that indicates the specific supplier ship-from location. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site. -
TaskValue: string
Read Only:
true
Maximum Length:4000
Value that identifies task. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the order. -
TransitLeadTime: number
Read Only:
true
Number of days the order is in transit between two locations. -
UOM: string
Read Only:
true
Maximum Length:4000
Name of the unit of measure associated with the order quantity. -
UOMCode: string
Read Only:
true
Abbreviation that identifies the unit of measure associated with the order quantity. -
UsesOrderModifier: number
Read Only:
true
Meaning associated with the UsesOrderModifierIndicator attribute. Valid values are Yes and No. -
UsesOrderModifierText: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the supply quantity has been determined by applying an order modifier. Valid values are: Yes or No. If Yes, then an order modifier was applied to the supply quantity. If No, then it hasn't. -
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
Read Only:
true
Maximum Length:400
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
Read Only:
true
Type of manufacturing used for the production process. Valid values are 1: Discrete Manufacturing and 2: Process Manufacturing. -
WorkOrderStatus: string
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 : 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.