Update a work order
patch
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/workOrders/{workOrdersUniqID}
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=
-
workOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and WorkOrderId ---for the Work Orders resource and used to uniquely identify an instance of Work Orders. The client should not generate the hash key value. Instead, the client should query on the Work Orders collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Orders.
For example: workOrders?q=PlanId=<value1>;WorkOrderId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActualEndDate: string
(date-time)
Date and time when the work order operation is no longer effective.
-
ActualStartDate: string
(date-time)
Date and time when the work order operation is actually effective.
-
CompletedQuantity: number
Quantity of primary product completed so far in the work order.
-
demands: array
Demands
Title:
Demands
Demands and customers pegged to a work order. -
Description: string
Maximum Length:
500
Description of the production schedule. -
EarliestStartDate: string
(date-time)
Date when the work order operation can be requested at the earliest.
-
FirmPlannedFlag(required): boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then allow Oracle Supply Planning Cloud from suggesting rescheduling and replanning recommendations with respect to the work order. If false, then don't allow Oracle Supply Planning Cloud from suggesting rescheduling and replanning recommendations. This attribute doesn't have a default value. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
MaterialAvailable: string
Maximum Length:
30
Contains one of the following values: true or false. If true, then all the material is available for a work order. If false, then the material isn't available for a work order. This attribute doesn't have a default value. -
OnHoldFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the work order is on hold. If false, then the work order isn't on hold. This attribute doesn't have a default value. -
operations: array
Work Order Operations
Title:
Work Order Operations
The Operations resource manages the operations that are a part of the work definition. -
OrderClass: string
Maximum Length:
20
Class of the work order. Valid values include HotOrder, Committed, and Uncommitted. -
PlanId(required): integer
(int64)
Value that uniquely identifies the production schedule.
-
PlannedStartQuantity(required): number
Quantity of planned work order which should be greater than zero for standard work orders, and can be equal to or greater than zero for nonstandard work orders.
-
PrimaryProductQuantity: number
Quantity planned to be produced for the work order.
-
PrimaryProductRemainingQuantity: number
Quantity remaining to be produced for the work order.
-
RejectedQuantity: number
Total rejected quantity across all operations for the work order.
-
RemainingQuantity: number
Quantity that's remaining.
-
RequestedDate(required): string
(date-time)
Date when the work order operation is requested.
-
RescheduledFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then work order is rescheduled. If false, then work order isn't rescheduled. This attribute doesn't have a default value. -
ReservedQuantity: number
The total quantity of demands reserved to the work order.
-
RoutingCode: string
Maximum Length:
300
Abbreviation that identifies the work definition for this work order. -
ScheduledEndDate: string
(date-time)
Date when the work order is scheduled to complete.
-
ScheduledStartDate: string
(date-time)
Date when the work order is scheduled to start.
-
ScrappedQuantity: number
Total scrapped quantity across all operations for the work order.
-
SelectedForReleaseFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then work order is selected for release. If false, then work order isn't selected for release. This attribute doesn't have a default value. -
SupplyPlanSupplyId: integer
(int64)
Value that uniquely identifies the supply plan for planned order supplies.
-
TargetCompletionDate: string
(date-time)
Date when the work order is targeted to be scheduled. This attribute overrides the need-by date of the work order.
-
UnitOfMeasure: string
Maximum Length:
25
Name of the unit of measure. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the primary product. -
WorkDefinitionId: integer
(int64)
Value that uniquely identifies the work definition.
-
WorkDefinitionVersionNumber: string
Maximum Length:
10
Value that indicates the version of the work definition. -
WorkMethodCode: string
Maximum Length:
30
Abbreviation that identifies the user key to the work method. -
WorkMethodId: integer
(int64)
Value that uniquely identifies the work method for which this work definition is applicable.
-
WorkMethodName: string
Maximum Length:
120
Name of the work method. -
WorkOrderId(required): integer
(int64)
Value that uniquely identifies the work order. It's a primary key of the work order.
-
WorkOrderNumber(required): string
Maximum Length:
300
Number that uniquely identifies the work order. -
WorkOrderPriority: number
Value that indicates the value of the work order.
-
WorkOrderStatus: string
Maximum Length:
30
Value the indicates the status of the work order. -
WorkOrderSubTypeCode: string
Maximum Length:
30
Abbreviation that identifies the subtype of the work order. -
WorkOrderSubTypeName: string
Maximum Length:
80
Name of the work order subtype. -
WorkOrderType(required): string
Maximum Length:
30
Type of work order. Valid vales include Production, Maintenance, or EAM work order. -
WorkOrderTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of the work order. -
WorkOrderTypeName: string
Maximum Length:
80
Name of the work order type.
Nested Schema : Demands
Type:
array
Title:
Demands
Demands and customers pegged to a work order.
Show Source
Nested Schema : Work Order Operations
Type:
array
Title:
Work Order Operations
The Operations resource manages the operations that are a part of the work definition.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-demands-item-patch-request
Type:
Show Source
object
Nested Schema : productionSchedulingPlans-workOrders-operations-item-patch-request
Type:
Show Source
object
-
ActualEndDate: string
(date-time)
Date and time when the work order operation is no longer effective.
-
ActualStartDate: string
(date-time)
Date and time when the work order operation is actually effective.
-
ChangedByLastRepairFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then object is changed by last repair solve. If false, then object isn't changed by last repair solve. This attribute doesn't have a default value. -
ChangedSinceLastSolveFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then object is changed by last solve. If false, then object isn't changed by last solve. This attribute doesn't have a default value. -
DurationResourceId: integer
(int64)
Value that uniquely identifies the duration production resource which is the principal resource.
-
DurationResourceSetCode: string
Maximum Length:
100
Abbreviation that identifies the resource set of the duration resource. -
EndDate: string
(date-time)
Date and time when the work order operation is no longer effective.
-
ExecutionSequence: number
Execution sequence of the work order operation.
-
FirmStatus: string
Maximum Length:
30
Status of the operation firm. Valid values include Firm Start, Firm End, and Firm Range. The operation isn't firmed if this isn't specified. -
LotMultipleResourceId: integer
(int64)
Value that uniquely identifies the production resource that's the lot multiple resource.
-
LotMultipleResourceSetCode: string
Maximum Length:
100
Abbreviation that identifies the resource set with the lot multiple resource. -
OperationCode: string
Maximum Length:
300
Abbreviation that identifies the operation. -
operationMaterials: array
Operation Materials
Title:
Operation Materials
The Operation Materials resource manages the items that are either produced or consumed during the manufacturing production process. -
OperationName: string
Maximum Length:
120
Name of the operation. -
operationResources: array
Operation Resources
Title:
Operation Resources
The Operation Resources resource manages the production resources that are used for a particular operation. -
OperationSequenceNumber: number
Number that identifies the execution sequence of the operation.
-
OperationType: string
Maximum Length:
30
Type of the resource operation, which indicates if it's an in house or and outside supplier operation. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ResourceSequenceNumber: integer
Number that identifies the resource sequence of the operation.
-
ScheduledDuration: number
Duration of schedule of the operation.
-
ScheduledDurationUnit: string
Maximum Length:
30
Time unit of measure for the schedule duration of the operation. Valid values include second, minutes, hours, and days. -
ScheduledEndDate: string
(date-time)
Date when the work order operation schedule ends.
-
ScheduledStartDate: string
(date-time)
Date when the work order operation is scheduled.
-
StartDate: string
(date-time)
Date and time when the work order operation is effective.
-
Status: string
Maximum Length:
30
Status of the operation. Valid values include Open, Active, or Closed. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier for the operation.
-
SupplierName: string
Maximum Length:
360
Name of the supplier associated with the operation. -
SupplierSiteCode: string
Maximum Length:
15
Abbreviation that identifies the supplier associated with the operation. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site for the operation.
-
SupplyReservationsFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the work order contains supply reservations. If false, then work order doesn't contain a supply reservation. The default value is false. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center. It's a primary key of the work center.
-
WorkDefinitionOperationId: integer
(int64)
Value that uniquely identifies the work definition operation.
-
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order. It's a primary key of the work order.
-
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
Yield: number
Yield percent of the work order operation.
Nested Schema : Operation Materials
Type:
array
Title:
Operation Materials
The Operation Materials resource manages the items that are either produced or consumed during the manufacturing production process.
Show Source
Nested Schema : Operation Resources
Type:
array
Title:
Operation Resources
The Operation Resources resource manages the production resources that are used for a particular operation.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-operationMaterials-item-patch-request
Type:
Show Source
object
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
IssuedQuantity: number
Quantity issued on the operation.
-
MaterialSequenceNumber: number
Number that indicates the sequence for a component item for a work order operation.
-
MaterialType: string
Maximum Length:
30
Type of material either produced or consumed by the operation. Valid values include Consumed Item and Produced Item. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ProducedQuantity: number
Quantity issued so far, since partial issues are possible.
-
Quantity: number
Quantity of the material either consumed in the operation or produced from the operation.
-
RemainingQuantity: number
Quantity that's remaining.
-
ResourceSequenceNumber: integer
Number that identifies the resource sequence of the operation material.
-
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
WorkOrderOperationMaterialId: integer
(int64)
Value that uniquely identifies the component item for a work order operation.
Nested Schema : productionSchedulingPlans-workOrders-operations-operationResources-item-patch-request
Type:
Show Source
object
-
AllowOffloading: string
Maximum Length:
1
Contains one of the following values: true or false. If true, then allow offloading of the production resource to a viable alternate. If false, then don't allow offloading of the production resource to a viable alternate. This attribute doesn't have a default value. -
CapacityRequired: number
Number of alternate resource instances. Valid values include Labor or Equipment.
-
Duration: number
Duration of the resource for an operation.
-
DurationUnit: string
Maximum Length:
30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, and days. -
ExpendedDuration: number
Duration of the expended resource on the operation.
-
LotMultiple: number
Lot multiple of the operation resource.
-
OriginalCapacityRequired: number
Capacity required for the original planned resource.
-
OriginalResourceId: integer
(int64)
Value that uniquely identifies the original resource.
-
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
PrincipalFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value. -
RemainingDuration: number
Duration that's remaining.
-
ResourceActivityName: string
Maximum Length:
80
Name of the resource activity. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It's a primary key of the resource.
-
ResourceSequenceNumber: number
Number that identifies the resource sequence of the operation resource.
-
ScheduledFlag: boolean
Maximum Length:
1
Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource, and it sets the start date equal to the completion date. This attribute doesn't have a default value. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center. It's a primary key of the work center.
-
WorkDefinitionOperationResourceId: integer
(int64)
Value that uniquely identifies the work definition operation resource.
-
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
WorkOrderOperationResourceId: integer
(int64)
Value that uniquely identifies the work order operation resource. It's a primary key of the work order operation resource.
Response
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 : productionSchedulingPlans-workOrders-item-response
Type:
Show Source
object
-
ActualEndDate: string
(date-time)
Date and time when the work order operation is no longer effective.
-
ActualStartDate: string
(date-time)
Date and time when the work order operation is actually effective.
-
AssetDescription: string
Read Only:
true
Maximum Length:240
Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. -
AssetId: integer
(int64)
Read Only:
true
Value that uniquely identifies the asset charge. This attribute is read only. -
AssetNumber: string
Read Only:
true
Maximum Length:80
Number that uniquely identifies the asset. -
CompletedQuantity: number
Quantity of primary product completed so far in the work order.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
demands: array
Demands
Title:
Demands
Demands and customers pegged to a work order. -
Description: string
Maximum Length:
500
Description of the production schedule. -
EarliestStartDate: string
(date-time)
Date when the work order operation can be requested at the earliest.
-
FirmPlannedFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then allow Oracle Supply Planning Cloud from suggesting rescheduling and replanning recommendations with respect to the work order. If false, then don't allow Oracle Supply Planning Cloud from suggesting rescheduling and replanning recommendations. This attribute doesn't have a default value. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the item. -
ItemDescription: string
Read Only:
true
Maximum Length:500
Description of the item that's produced by the work order. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialAvailable: string
Maximum Length:
30
Contains one of the following values: true or false. If true, then all the material is available for a work order. If false, then the material isn't available for a work order. This attribute doesn't have a default value. -
OnHoldFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the work order is on hold. If false, then the work order isn't on hold. This attribute doesn't have a default value. -
operations: array
Work Order Operations
Title:
Work Order Operations
The Operations resource manages the operations that are a part of the work definition. -
OrderClass: string
Maximum Length:
20
Class of the work order. Valid values include HotOrder, Committed, and Uncommitted. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
PlannedStartQuantity: number
Quantity of planned work order which should be greater than zero for standard work orders, and can be equal to or greater than zero for nonstandard work orders.
-
PrimaryProductQuantity: number
Quantity planned to be produced for the work order.
-
PrimaryProductRemainingQuantity: number
Quantity remaining to be produced for the work order.
-
RejectedQuantity: number
Total rejected quantity across all operations for the work order.
-
RemainingQuantity: number
Quantity that's remaining.
-
RequestedDate: string
(date-time)
Date when the work order operation is requested.
-
RescheduledFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then work order is rescheduled. If false, then work order isn't rescheduled. This attribute doesn't have a default value. -
ReservedQuantity: number
The total quantity of demands reserved to the work order.
-
RoutingCode: string
Maximum Length:
300
Abbreviation that identifies the work definition for this work order. -
ScheduledEndDate: string
(date-time)
Date when the work order is scheduled to complete.
-
ScheduledStartDate: string
(date-time)
Date when the work order is scheduled to start.
-
ScrappedQuantity: number
Total scrapped quantity across all operations for the work order.
-
SelectedForReleaseFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then work order is selected for release. If false, then work order isn't selected for release. This attribute doesn't have a default value. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Number that uniquely identifies the serial that the asset references. This attributes is applied when the item is serial controlled. -
SupplyPlanSupplyId: integer
(int64)
Value that uniquely identifies the supply plan for planned order supplies.
-
TargetCompletionDate: string
(date-time)
Date when the work order is targeted to be scheduled. This attribute overrides the need-by date of the work order.
-
UnitOfMeasure: string
Maximum Length:
25
Name of the unit of measure. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the primary product. -
WorkDefinitionId: integer
(int64)
Value that uniquely identifies the work definition.
-
WorkDefinitionVersionNumber: string
Maximum Length:
10
Value that indicates the version of the work definition. -
WorkMethodCode: string
Maximum Length:
30
Abbreviation that identifies the user key to the work method. -
WorkMethodId: integer
(int64)
Value that uniquely identifies the work method for which this work definition is applicable.
-
WorkMethodName: string
Maximum Length:
120
Name of the work method. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order. It's a primary key of the work order.
-
WorkOrderNumber: string
Maximum Length:
300
Number that uniquely identifies the work order. -
WorkOrderPriority: number
Value that indicates the value of the work order.
-
WorkOrderStatus: string
Maximum Length:
30
Value the indicates the status of the work order. -
WorkOrderStatusName: string
Read Only:
true
Maximum Length:120
The work order status. -
WorkOrderSubTypeCode: string
Maximum Length:
30
Abbreviation that identifies the subtype of the work order. -
WorkOrderSubTypeName: string
Maximum Length:
80
Name of the work order subtype. -
WorkOrderType: string
Maximum Length:
30
Type of work order. Valid vales include Production, Maintenance, or EAM work order. -
WorkOrderTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of the work order. -
WorkOrderTypeName: string
Maximum Length:
80
Name of the work order type.
Nested Schema : Demands
Type:
array
Title:
Demands
Demands and customers pegged to a work order.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Work Order Operations
Type:
array
Title:
Work Order Operations
The Operations resource manages the operations that are a part of the work definition.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-demands-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
CustomerName: string
Read Only:
true
Maximum Length:300
Name of the customer with the demand. -
CustomerNumber: string
Read Only:
true
Maximum Length:240
Number of the customer with the demand. -
DemandId: integer
(int64)
Read Only:
true
Value that uniquely identifies the demand. -
DemandLineItemNumber: string
Read Only:
true
Maximum Length:150
Number that identifies the line of the demand. -
DemandNumber: string
Read Only:
true
Maximum Length:240
Number that identifies the demand. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production schedule. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order. It's a primary key of the work order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : productionSchedulingPlans-workOrders-operations-item-response
Type:
Show Source
object
-
ActualEndDate: string
(date-time)
Date and time when the work order operation is no longer effective.
-
ActualStartDate: string
(date-time)
Date and time when the work order operation is actually effective.
-
ChangedByLastRepairFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then object is changed by last repair solve. If false, then object isn't changed by last repair solve. This attribute doesn't have a default value. -
ChangedSinceLastSolveFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then object is changed by last solve. If false, then object isn't changed by last solve. This attribute doesn't have a default value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource for the duration resource in an operation. -
DurationResourceId: integer
(int64)
Value that uniquely identifies the duration production resource which is the principal resource.
-
DurationResourceSetCode: string
Maximum Length:
100
Abbreviation that identifies the resource set of the duration resource. -
EndDate: string
(date-time)
Date and time when the work order operation is no longer effective.
-
ExecutionSequence: number
Execution sequence of the work order operation.
-
FirmStatus: string
Maximum Length:
30
Status of the operation firm. Valid values include Firm Start, Firm End, and Firm Range. The operation isn't firmed if this isn't specified. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotMultipleResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource that's the lot multiple resource. -
LotMultipleResourceId: integer
(int64)
Value that uniquely identifies the production resource that's the lot multiple resource.
-
LotMultipleResourceSetCode: string
Maximum Length:
100
Abbreviation that identifies the resource set with the lot multiple resource. -
OperationCode: string
Maximum Length:
300
Abbreviation that identifies the operation. -
operationMaterials: array
Operation Materials
Title:
Operation Materials
The Operation Materials resource manages the items that are either produced or consumed during the manufacturing production process. -
OperationName: string
Maximum Length:
120
Name of the operation. -
operationResources: array
Operation Resources
Title:
Operation Resources
The Operation Resources resource manages the production resources that are used for a particular operation. -
OperationSequenceNumber: number
Number that identifies the execution sequence of the operation.
-
OperationType: string
Maximum Length:
30
Type of the resource operation, which indicates if it's an in house or and outside supplier operation. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ResourceSequenceNumber: integer
Number that identifies the resource sequence of the operation.
-
ScheduledDuration: number
Duration of schedule of the operation.
-
ScheduledDurationUnit: string
Maximum Length:
30
Time unit of measure for the schedule duration of the operation. Valid values include second, minutes, hours, and days. -
ScheduledEndDate: string
(date-time)
Date when the work order operation schedule ends.
-
ScheduledStartDate: string
(date-time)
Date when the work order operation is scheduled.
-
StartDate: string
(date-time)
Date and time when the work order operation is effective.
-
Status: string
Maximum Length:
30
Status of the operation. Valid values include Open, Active, or Closed. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier for the operation.
-
SupplierName: string
Maximum Length:
360
Name of the supplier associated with the operation. -
SupplierSiteCode: string
Maximum Length:
15
Abbreviation that identifies the supplier associated with the operation. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site for the operation.
-
SupplyReservationsFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the work order contains supply reservations. If false, then work order doesn't contain a supply reservation. The default value is false. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center. It's a primary key of the work center.
-
WorkDefinitionOperationId: integer
(int64)
Value that uniquely identifies the work definition operation.
-
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order. It's a primary key of the work order.
-
WorkOrderNumber: string
Read Only:
true
Maximum Length:300
Number that uniquely identifies the work order. -
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
Yield: number
Yield percent of the work order operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Operation Materials
Type:
array
Title:
Operation Materials
The Operation Materials resource manages the items that are either produced or consumed during the manufacturing production process.
Show Source
Nested Schema : Operation Resources
Type:
array
Title:
Operation Resources
The Operation Resources resource manages the production resources that are used for a particular operation.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-operationMaterials-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
IssuedQuantity: number
Quantity issued on the operation.
-
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialSequenceNumber: number
Number that indicates the sequence for a component item for a work order operation.
-
MaterialType: string
Maximum Length:
30
Type of material either produced or consumed by the operation. Valid values include Consumed Item and Produced Item. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ProducedQuantity: number
Quantity issued so far, since partial issues are possible.
-
Quantity: number
Quantity of the material either consumed in the operation or produced from the operation.
-
RemainingQuantity: number
Quantity that's remaining.
-
ResourceSequenceNumber: integer
Number that identifies the resource sequence of the operation material.
-
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Name of the unit of measure. -
UOMCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the unit of measure. -
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
WorkOrderOperationMaterialId: integer
(int64)
Value that uniquely identifies the component item for a work order operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-operationResources-item-response
Type:
Show Source
object
-
AllowOffloading: string
Maximum Length:
1
Contains one of the following values: true or false. If true, then allow offloading of the production resource to a viable alternate. If false, then don't allow offloading of the production resource to a viable alternate. This attribute doesn't have a default value. -
CapacityRequired: number
Number of alternate resource instances. Valid values include Labor or Equipment.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
Duration: number
Duration of the resource for an operation.
-
DurationUnit: string
Maximum Length:
30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, and days. -
ExpendedDuration: number
Duration of the expended resource on the operation.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotMultiple: number
Lot multiple of the operation resource.
-
OriginalCapacityRequired: number
Capacity required for the original planned resource.
-
OriginalResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the original resource. -
OriginalResourceId: integer
(int64)
Value that uniquely identifies the original resource.
-
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
PrincipalFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value. -
RemainingDuration: number
Duration that's remaining.
-
ResourceActivityName: string
Maximum Length:
80
Name of the resource activity. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It's a primary key of the resource.
-
ResourceSequenceNumber: number
Number that identifies the resource sequence of the operation resource.
-
ScheduledFlag: boolean
Maximum Length:
1
Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource, and it sets the start date equal to the completion date. This attribute doesn't have a default value. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center. It's a primary key of the work center.
-
WorkDefinitionOperationResourceId: integer
(int64)
Value that uniquely identifies the work definition operation resource.
-
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
WorkOrderOperationResourceId: integer
(int64)
Value that uniquely identifies the work order operation resource. It's a primary key of the work order operation resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- demands
-
Parameters:
- PlanId:
$request.path.PlanId
- workOrdersUniqID:
$request.path.workOrdersUniqID
Demands and customers pegged to a work order. - PlanId:
- operations
-
Parameters:
- PlanId:
$request.path.PlanId
- workOrdersUniqID:
$request.path.workOrdersUniqID
The Operations resource manages the operations that are a part of the work definition. - PlanId: