Get all supplies
get
/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/PlanningSupplies
Request
Path Parameters
-
PlanInputId(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=
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 Find planning supplies according to the primary key criteria.
Finder Variables- TransactionId; integer; Value that uniquely identifies the supply transaction.
- TransactionIdFinder Find planning supplies according to the primary key criteria.
Finder Variables- TransactionId; integer; Value that uniquely identifies the supply transaction.
- PrimaryKey Find planning supplies according to the primary key criteria.
-
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:- ActualStartDate; string; Date when the work was started, which applies to work orders in process.
- AlternateBOMDesignator; string; Name of the alternate bill of material.
- AlternateRoutingDesignator; string; Name of a routing used for the make order.
- AssetNumber; string; Number that identifies the asset associated with a maintenance work order.
- BatchQuantity; number; Quantity that moves through operations in a process work order.
- BatchUOM; string; Unit of measure for the batch quantity in a process work order.
- Buyer; string; Name of the buyer associated to 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.
- CompletedQuantity; number; Quantity of the work order that's already completed.
- CreatedBy; string; User who created the order.
- CreationDate; string; Date when the user created the order.
- Customer; string; Name of the customer associated with the drop ship purchase order.
- CustomerSite; string; Code associated with a specific customer ship-to location.
- DeliveryPrice; number; Supply unit price for purchased supply.
- 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.
- DropShipCustomer; string; Number that uniquely identifies the customer whose demand is being met through the drop ship supply.
- DropShipCustomerSite; string; Customer site to which the drop ship supply must be shipped to meet the demand.
- 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.
- ExpirationDate; string; Date when the existing lot associated with the supply expires.
- FirmDate; string; 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; 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; Fixed quantity of supply. This attribute value can't be changed 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.
- HoldDate; string; Date on which the on-hand inventory lot is no longer on hold.
- Item; string; Name of the item associated with the supply.
- ItemDescription; string; Description of the item that's associated with the supply.
- 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 supply.
- 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.
- NeedByDate; string; Date when the supply quantity 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.
- OrderNumber; string; Number that identifies the order associated with the supply.
- OrderQuantity; number; Quantity associated with the supply.
- 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.
- Organization; string; Name of the organization associated with the order.
- OrganizationTimeZone; string; Time zone associated with an organization.
- 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.
- 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.
- ProcessName; string; Name of the manufacturing process used for this work order or planned 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.
- ReceiptNumber; string; Number that identifies the receipt of the transfer order.
- RemainingQuantity; number; Work order quantity that remains to be completed.
- RequestedArrivalDate; string; Date when the material must arrive at the customer site.
- RequestedShipDate; string; Date when the material must be shipped out to the customer.
- Revision; string; Abbreviation that identifies the revision of the inventory item.
- ScheduleLineNumber; string; Number that identifies the purchase order line location information for collection at the schedule level.
- ScheduleName; string; Name of the schedule associated to the supply.
- SchedulePriority; number; Value that identifies the priority of the work order.
- ScrappedQuantity; number; Work order quantity that has been scrapped.
- 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.
- ShipmentHeaderNumber; string; Number that identifies the shipment header of the transfer order.
- ShipmentLineNumber; string; Number that identifies the shipment line of the transfer order.
- 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; Name of the organization that will source the order.
- SourceSubinventoryCode; string; Abbreviation that identifies the subinventory associated with the 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.
- Subinventory; string; Subinventory code associated with the supply.
- 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 a supply is expected to be completed.
- SuggestedOrderDate; string; Date when an 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.
- Supplier; string; Name of the source supplier.
- SupplierSite; string; Abbreviation that indicates the specific supplier location from where the item is being sourced.
- TaskValue; string; Value that identifies task.
- TransactionId; integer; Value that uniquely identifies the supply transaction. This value is internally generated by the application.
- 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.
- Undercompleted; integer; Contains one of the following values 1 or 2. If 1, then the work order is undercompleted based on undercompletion tolerance values. If 2, then the work order isn't undercompleted.
- UnitNumber; string; Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number.
- WIPStatusCode; integer; Abbreviation 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.
- 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.
- WorkOrderSubtype; integer; Work order subtype associated with the make order. A list of accepted values is defined in the lookup type ORA_MSC_WO_SUB_TYPE .
-
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:
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 : planInputs-PlanningSupplies
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 : planInputs-PlanningSupplies-item-response
Type:
Show Source
object
-
ActualStartDate: string
(date)
Read Only:
true
Date when the work was started, which applies to work orders in process. -
AlternateBOMDesignator: string
Read Only:
true
Maximum Length:80
Name of the alternate bill of material. -
AlternateRoutingDesignator: string
Read Only:
true
Maximum Length:30
Name of a routing used for the make order. -
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:3
Unit of measure for the batch quantity in a process work order. -
Buyer: string
Read Only:
true
Maximum Length:240
Name of the buyer associated to the item. -
BuyerManagedTransportation: string
Read Only:
true
Maximum Length:400
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
Read Only:
true
Quantity of the work order that's already completed. -
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
Read Only:
true
Maximum Length:400
Name of the customer associated with the drop ship purchase order. -
CustomerSite: string
Read Only:
true
Maximum Length:400
Code associated with a specific customer ship-to location. -
DeliveryPrice: number
Read Only:
true
Supply unit price for purchased supply. -
DestinationTimeZone: string
Read Only:
true
Maximum Length:400
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:400
Value that indicates where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE. -
DropShipCustomer: string
Read Only:
true
Maximum Length:400
Number that uniquely identifies the customer whose demand is being met through the drop ship supply. -
DropShipCustomerSite: string
Read Only:
true
Maximum Length:400
Customer site to which the drop ship supply must be shipped to meet the demand. -
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:400
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
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
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
Read Only:
true
Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmStartQuantity: number
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:400
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)
Read Only:
true
Date on which the on-hand inventory lot is no longer on hold. -
Item: string
Read Only:
true
Maximum Length:300
Name of the item associated with the supply. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item that's associated with the supply. -
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 supply. -
LineNumber: string
Read Only:
true
Maximum Length:400
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:400
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. -
NeedByDate: string
(date)
Read Only:
true
Date when the supply quantity 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. -
OrderNumber: string
Read Only:
true
Maximum Length:400
Number that identifies the order associated with the supply. -
OrderQuantity: number
Read Only:
true
Quantity associated with the supply. -
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:400
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. -
OrganizationTimeZone: string
Read Only:
true
Maximum Length:400
Time zone associated with an organization. -
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. -
Planner: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Read Only:
true
Maximum Length:400
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
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
Read Only:
true
Maximum Length:120
Name of the manufacturing process used for this work order or planned order. -
ProjectGroupValue: string
Read Only:
true
Maximum Length:400
Value that identifies the project group. -
ProjectValue: string
Read Only:
true
Maximum Length:400
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. -
ReceiptNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the receipt of the transfer order. -
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. -
RequestedShipDate: string
(date)
Read Only:
true
Date when the material must be shipped out to the customer. -
Revision: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the revision of the inventory item. -
ScheduleLineNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the purchase order line location information for collection at the schedule level. -
ScheduleName: string
Read Only:
true
Maximum Length:10
Name of the schedule associated to the supply. -
SchedulePriority: number
Read Only:
true
Value that identifies the priority of the work order. -
ScrappedQuantity: number
Read Only:
true
Work order quantity that has been scrapped. -
ShipmentHeaderNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the shipment header of the transfer order. -
ShipmentLineNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the shipment line of the transfer 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:400
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
Read Only:
true
Maximum Length:400
Name of the organization that will source the order. -
SourceSubinventoryCode: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the subinventory associated with the source of the supply. -
SourceTimeZone: string
Read Only:
true
Maximum Length:400
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. -
Subinventory: string
Read Only:
true
Maximum Length:10
Subinventory code associated with the supply. -
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 a supply is expected to be completed. -
SuggestedOrderDate: string
(date)
Read Only:
true
Date when an 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. -
Supplier: string
Read Only:
true
Maximum Length:400
Name of the source supplier. -
SupplierSite: string
Read Only:
true
Maximum Length:400
Abbreviation that indicates the specific supplier location from where the item is being sourced. -
TaskValue: string
Read Only:
true
Maximum Length:400
Value that identifies task. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supply transaction. This value is internally generated by the application. -
Undercompleted: integer
Read Only:
true
Contains one of the following values 1 or 2. If 1, then the work order is undercompleted based on undercompletion tolerance values. If 2, then the work order isn't undercompleted. -
UnitNumber: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number. -
UOM: string
Read Only:
true
Maximum Length:400
Name of the unit of measure associated with the order quantity. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure associated with the order quantity. -
WIPStatusCode: integer
Read Only:
true
Abbreviation 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
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. -
WorkOrderStatus: string
Read Only:
true
Maximum Length:400
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. -
WorkOrderSubtype: integer
Read Only:
true
Work order subtype associated with the make order. A list of accepted values is defined in the lookup type ORA_MSC_WO_SUB_TYPE .
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : 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 : planInputs-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