Get one production schedule
get
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}
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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : productionSchedulingPlans-item-response
Type:
Show Source
object
-
AcceleratedDispatchingFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then production scheduling algorithm uses accelerated dispatching. If false, then production scheduling algorithm doesn't use accelerated dispatching. This attribute doesn't have a default value. -
ActualFixedTimeFenceDuration: number
Duration of the actual fixed time fence. This is calculated based on the horizon anchor behavior, minimum time fence, and horizon extension.
-
AllowSameAttributeChangeoverFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the production scheduling plan allows attribute changeovers of the same value. If N, then attribute changeovers of the same value aren't allowed. The default value is N. -
AnchorTimestamp: string
(date-time)
Time stamp of the anchor date for the schedule.
-
ApprovedFlag: boolean
Contains one of the following values: Y or N. If Y, then the production scheduling plan is approved. If N, then the production scheduling plan isn't approved. The default value is Y.
-
assets: array
Assets
Title:
Assets
The Assets resource manages the assets that require maintenance. -
assignedAttributeValues: array
Assigned Attribute Values
Title:
Assigned Attribute Values
The Assigned Attribute Values resource manages the attributes that are assigned to work order operations that are used for scheduling. -
attributes: array
Attributes
Title:
Attributes
The Attributes resource manages the attributes that are a part of the plan that are used for scheduling. -
BuildStrategy: string
Maximum Length:
10
Build strategy for fulfilling demand. Valid values include JIT and PreBuild. -
calendarEvents: array
Calendar Events
Title:
Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available. -
CalendarHorizonEndDate: string
(date-time)
Date when the evaluated global calendar horizon is no longer effective.
-
CalendarHorizonStartDate: string
(date-time)
Date when the evaluated global calendar horizon is effective.
-
calendars: array
Calendars
Title:
Calendars
The Calendars resource manages the calendars that are part of the schedule to establish availability. -
changeoverInstances: array
Changeover Instances
Title:
Changeover Instances
The Changeover Instances resource manages the individual changeover instances that occur on a production resource as a result of the changeover rules. -
changeoverRules: array
Changeover Rules
Title:
Changeover Rules
The Changeover Rules resource manages the changeover rules by attribute for a production resource or group. -
ChangeoversRespectResourceCalendarFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then changeovers consider downtime. If N, then changeovers don't consider downtime. The default value is N. -
changeoverTimeMeasures: array
KPI for Changeover Times
Title:
KPI for Changeover Times
The KPI for Changeover Times resource manages the key performance indicator for changeover times of the production schedule used for reporting. -
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. -
DataHorizonEndDate: string
(date-time)
Date when the evaluated data horizon is no longer effective.
-
DataHorizonStartDate: string
(date-time)
Date when the evaluated data horizon is effective, taking demand date, and others into consideration.
-
DefaultGanttDisplayHorizon: number
Duration of the default scheduling view horizon in days.
-
DefaultResourceGanttGroupCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource group of the default resource group for display purposes. -
DefaultResourceGanttGroupId: integer
(int64)
Value that uniquely identifies the resource group of the default resource group for display purposes.
-
demandEvents: array
Demand Events
Title:
Demand Events
The Demand Events resource manages the demands to be considered in the production schedule. -
Description: string
Maximum Length:
2000
Description of the production schedule. -
EngineStateFile: string
(byte)
Read Only:
true
Value that reports on the state of the scheduling engine binary file. -
FirmInsideTimeFenceOnRefreshFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then all work orders that are within the time fence will be firmed. If false, then work orders won't be automatically firmed within the time fence. This attribute doesn't have a default value. -
FixedTimeFenceDuration: number
Duration of the fixed time fence from the start of the horizon.
-
HorizonAnchorBehavior: string
Maximum Length:
12
Value that specifies whether the anchor time stamp is evaluated using either Rolling or Fixed. This attribute is used for horizon advancement. -
HorizonDuration: number
User defined scheduling horizon duration.
-
HorizonDurationUnit: string
Maximum Length:
12
Time unit of measure for horizon duration. The default value is days. -
HorizonEndDate: string
(date-time)
Date when the evaluated production scheduling plan horizon is no longer effective.
-
HorizonExtension: number
The amount to add to time fence when the minimum time fence is reached.
-
HorizonStartDate: string
(date-time)
Date when the evaluated production scheduling plan horizon is effective.
-
IncludeUnreleasedPlannedOrdersFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then planned orders are included in the production schedule. If N, then only work orders are included in the production schedule. The default value is N. -
items: array
Items
Title:
Items
The Items resource manages the items that are part of the schedule and can include purchased, manufactured, and finished good items. -
LastApprovedBy: string
Maximum Length:
64
User who most recently approved the plan action. -
LastApprovedDate: string
(date-time)
Date when the production scheduling plan was most recently approved.
-
LastExecutionId: integer
(int64)
Value that uniquely identifies the process that was most recently run.
-
LastPublishDate: string
(date-time)
Date and time when the schedule was last published.
-
LastRefreshDate: string
(date-time)
Date and time when the schedule was last refreshed.
-
LastRequest: integer
(int32)
Date and time of the last request.
-
LastRequestAction: string
Read Only:
true
Maximum Length:16
Action that was performed in the last request. -
LastRequestEndDate: string
(date-time)
Read Only:
true
Date and time of the last request. -
LastRequestErrorCode: integer
(int32)
Read Only:
true
Abbreviation that identifies the error of the last request. -
LastRequestId: integer
(int64)
Value that uniquely identifies the process that was most recently requested.
-
LastRequestPercentage: integer
Read Only:
true
Percent complete of the last request. -
LastRequestStatus: integer
(int32)
Read Only:
true
Status of the last request. -
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 record. -
lateDemandMeasures: array
KPI for Late Demands
Title:
KPI for Late Demands
The KPI for Late Demands resource manages the key performance indicator for late demands of the production schedule used for reporting. -
LatenessTolerance: number
Value of the threshold after which a demand or work order is late.
-
LatenessToleranceUnit: string
Maximum Length:
10
Time unit of measure for the delay. Valid values are seconds, minutes, hours, and days. The default value is hours. -
lateWorkOrderMeasures: array
KPI for Late Work Orders
Title:
KPI for Late Work Orders
The KPI for Late Work Orders resource manages the key performance indicator for late work orders of the production schedule used for reporting. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaintenanceEnabledFlag: boolean
Maximum Length:
1
Contains one of the following values: Yes or No. If Yes, then the plan is setup to schedule maintenance work orders. If No, then the plan isn't setup to schedule maintenance work orders. The default value is No. -
MinimumTimeFence: number
Minimum duration threshold before it's extended by the horizon extension. This attribute is used for fixed horizon advancement.
-
ModelExtractFile: string
(byte)
Read Only:
true
Model extract file that can be downloaded for support purposes. -
OperationLabelMode: string
Maximum Length:
80
Value that identifies the display label on the operation resource in the application. -
OrganizationCode: string
Maximum Length:
100
Abbreviation that identifies the inventory organization that's enabled for scheduling. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
PastDueDemandDuration: number
Duration of the past due demand before the start of horizon. This attribute uses horizon duration unit.
-
PastDueSupplyDuration: number
Duration of the past due supply before the start of horizon. This attribute uses horizon duration unit.
-
peggingRelationships: array
Pegging Relationships
Title:
Pegging Relationships
The Pegging Relationships resource manages the pegging between different types of supply and demand. -
PlanApprovalStatus: number
Status of the production scheduling plan approval.
-
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
PlanName: string
Maximum Length:
300
Name of the production schedule. -
PlanOwner: string
Maximum Length:
64
Owner of the production scheduling plan. -
planStatus: array
Plan Statuses
Title:
Plan Statuses
The Plan Statuses resource manages the different states of the schedule and determines when the schedule is completed. -
PrebuildMaximum: number
Maximum number of days that a work order can be built in advance.
-
PrebuildMaximumUnit: string
Maximum Length:
10
Time unit of measure for the prebuild maximum. The default value is Days. -
PreBuildPolicy: string
Maximum Length:
30
Prebuild policy. Values are Balanced, DynamicResourceAllocation, or MultiStageSynchronization. -
PrebuildUpstreamRelaxedFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the upstream resources that have constraints relaxed are scheduled as soon as possible or aligned to the required date. If N, then the upstream resources that have constraints relaxed aren't scheduled. The default value is N. -
PreserveWorkOrderStatusFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the work order status won't be changed when releasing the schedule. If false, the work order status will be changed to release status. -
PublishHorizonDuration: number
The time period where the schedule will be published.
-
RepairSequencingMode: string
Maximum Length:
40
Mode of repair sequencing. Valid values include SingleStage, MultiStage, and MultiStageIncludeRelatedWorkOrders. -
RepairUnconstrainedMode: string
Maximum Length:
30
Mode of repair of manual scheduling. Valid values include ConstrainedRepairMode and UnconstrainedRepairMode. -
RequestInProcessFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then request is in process. If false, then request isn't in process. This attribute doesn't have a default value. -
reservations: array
Reservations
Title:
Reservations
The Reservations resource manages the reservations in a schedule. -
ResourceAllocationMode: string
Maximum Length:
40
Mode of resource allocation priorities. Values include EarliestCompletionTime and MinimizeChangeoversAndIdleTimes. -
resourceCalendars: array
Resource Calendars
Title:
Resource Calendars
The Resource Calendars resource manages the association of the calendar to the production resource. -
ResourceCapacityHorizonDuration: number
Duration of the resource capacity horizon. If null, resource constrained horizon is disabled. This attribute uses horizon duration unit.
-
ResourceCapacityHorizonEndDate: string
(date-time)
End date of the resource capacity horizon.
-
resourceChangeoverSequences: array
Resource Changeover Sequences
Title:
Resource Changeover Sequences
The Resource Changeover Sequences resource manages the changeover sequences for a production resource. -
resourceGroups: array
Resource Groups
Title:
Resource Groups
The Resource Groups resource manages the user-defined groups of resources. -
resourceGroupUtilization: array
Resource Group Utilization
Title:
Resource Group Utilization
The Resource Group Utilization resource manages the resource utilization of a production resource group. -
ResourceLabelMode: string
Maximum Length:
30
Value that identifies the display label of resources in the application. -
resourceOperationSequences: array
Resource Operation Sequences
Title:
Resource Operation Sequences
The Resource Operation Sequences resource manages the sequence of operations that occur on a production resource. -
resourceRelationships: array
Resource Relationships
Title:
Resource Relationships
The Resource Relationships resource manages the upstream and downstream production resource relationships that describe how a product can be manufactured in a multistage production environment. -
resources: array
Resources
Title:
Resources
The Resources resource manages production resources that are part of the production schedule. -
resourceUsageLevels: array
Resource Usage Levels
Title:
Resource Usage Levels
The Resource Usage Levels resource manages the usage levels for a production resource. -
resourceUtilization: array
Resource Utilization
Title:
Resource Utilization
The Resource Utilization resource manages the resource utilization of a production resource. -
resourceUtilizationMeasures: array
KPIs for Resource Utilization
Title:
KPIs for Resource Utilization
The KPI for Resource Utilization resource manages the summary of the overall utilization of the production resources that are included in the schedule and used for reporting. -
RespectFirmDatesInsideTimeFenceFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then firm dates are respected inside the time fence. If false, then firm dates aren't respected inside the time fence. This attribute doesn't have a default value. -
scheduleMeasures: array
KPI Summaries
Title:
KPI Summaries
The KPI Summaries resource manages the summary of the overall key performance indicators of the production schedule used for reporting. -
SchedulingBucket: number
Time interval over which demand event and operations are grouped for the multistage synchronization solver algorithm. This is the real number of units.
-
SchedulingBucketUnit: string
Maximum Length:
10
Time unit of measure for scheduling bucket. Valid values include seconds, minutes, hours, days, shifts, weeks, and months. -
schedulingResources: array
Scheduling Resources
Title:
Scheduling Resources
The Scheduling Resources resource manages the production resources used in the production schedule. -
selectedItemCategories: array
Selected Item Categories
Title:
Selected Item Categories
The Selected Item Categories resource manages the item categories used to establish the scope of items to include in the production schedule. -
ShortPlanId: number
Value that uniquely identifies the short plan that's used for creating plan partitions.
-
SolveTimeLimitDuration: number
Maximum time interval after which the solver stops automatically with a partial plan schedule. This is a real number of units.
-
SolveTimeLimitUnit: string
Maximum Length:
10
Time unit of measure for solver. Valid values include seconds, minutes, hours, days, weeks, and months. -
supplyEvents: array
Supply Events
Title:
Supply Events
The Supply Events resource manages the supplies that are a part of the production schedule and can include purchase orders, transfer orders, and on hand. -
SupplyPlanId: integer
(int64)
Value that uniquely identifies the supply plan.
-
SupplyPlanName: string
Maximum Length:
30
Name of the supply plan. -
SupplyPlanOrganizationId: integer
(int64)
Value that uniquely identifies the organization of the supply plan.
-
Timezone: string
Maximum Length:
50
Time zone of the production scheduling organization. -
UseAnchorForHorizonFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the anchor is used to determine the anchor horizon. If false, then the current date is used to determine the anchor horizon. This attribute doesn't have a default value. -
UseSchedulingBucketFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then use the scheduling bucket. If N, then don't use the scheduling bucket. This attribute doesn't have a default value. -
UseSolveTimeLimitFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then use the solver time limit. If N, then don't use the solver time limit. This attribute doesn't have a default value. -
workOrderOperationAlternateResources: array
Work Order Operation Alternate Resources
Title:
Work Order Operation Alternate Resources
The Work Order Operation Alternate Resources resource manages the viable alternate production resource that can be used for an operation. -
workOrderOperationAttributes: array
Work Order Operation Attributes
Title:
Work Order Operation Attributes
The Work Order Operation Attributes resource manages the attributes that are relevant for a work order operation and used to generate a production schedule. -
workOrderOperations: array
Work Order Operations
Title:
Work Order Operations
The Operations resource manages the operations that are a part of the work definition. -
workOrders: array
Work Orders
Title:
Work Orders
The Work Orders resource manages the work orders that are to be scheduled in the production schedule. -
workOrderTemporalRelations: array
Work Order Temporal Relations
Title:
Work Order Temporal Relations
The Work Order Temporal Relations resource manages the temporal relations between the upstream and downstream operations. -
WorkOrderUnitOfEffort: string
Maximum Length:
30
Unit of effort for the schedule work orders. Valid values include Yes, No, or Select By Routing.
Nested Schema : Assets
Type:
array
Title:
Assets
The Assets resource manages the assets that require maintenance.
Show Source
Nested Schema : Assigned Attribute Values
Type:
array
Title:
Assigned Attribute Values
The Assigned Attribute Values resource manages the attributes that are assigned to work order operations that are used for scheduling.
Show Source
Nested Schema : Attributes
Type:
array
Title:
Attributes
The Attributes resource manages the attributes that are a part of the plan that are used for scheduling.
Show Source
Nested Schema : Calendar Events
Type:
array
Title:
Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available.
Show Source
Nested Schema : Calendars
Type:
array
Title:
Calendars
The Calendars resource manages the calendars that are part of the schedule to establish availability.
Show Source
Nested Schema : Changeover Instances
Type:
array
Title:
Changeover Instances
The Changeover Instances resource manages the individual changeover instances that occur on a production resource as a result of the changeover rules.
Show Source
Nested Schema : Changeover Rules
Type:
array
Title:
Changeover Rules
The Changeover Rules resource manages the changeover rules by attribute for a production resource or group.
Show Source
Nested Schema : KPI for Changeover Times
Type:
array
Title:
KPI for Changeover Times
The KPI for Changeover Times resource manages the key performance indicator for changeover times of the production schedule used for reporting.
Show Source
Nested Schema : Demand Events
Type:
array
Title:
Demand Events
The Demand Events resource manages the demands to be considered in the production schedule.
Show Source
Nested Schema : Items
Type:
array
Title:
Items
The Items resource manages the items that are part of the schedule and can include purchased, manufactured, and finished good items.
Show Source
Nested Schema : KPI for Late Demands
Type:
array
Title:
KPI for Late Demands
The KPI for Late Demands resource manages the key performance indicator for late demands of the production schedule used for reporting.
Show Source
Nested Schema : KPI for Late Work Orders
Type:
array
Title:
KPI for Late Work Orders
The KPI for Late Work Orders resource manages the key performance indicator for late work orders of the production schedule used for reporting.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pegging Relationships
Type:
array
Title:
Pegging Relationships
The Pegging Relationships resource manages the pegging between different types of supply and demand.
Show Source
Nested Schema : Plan Statuses
Type:
array
Title:
Plan Statuses
The Plan Statuses resource manages the different states of the schedule and determines when the schedule is completed.
Show Source
Nested Schema : Reservations
Type:
array
Title:
Reservations
The Reservations resource manages the reservations in a schedule.
Show Source
Nested Schema : Resource Calendars
Type:
array
Title:
Resource Calendars
The Resource Calendars resource manages the association of the calendar to the production resource.
Show Source
Nested Schema : Resource Changeover Sequences
Type:
array
Title:
Resource Changeover Sequences
The Resource Changeover Sequences resource manages the changeover sequences for a production resource.
Show Source
Nested Schema : Resource Groups
Type:
array
Title:
Resource Groups
The Resource Groups resource manages the user-defined groups of resources.
Show Source
Nested Schema : Resource Group Utilization
Type:
array
Title:
Resource Group Utilization
The Resource Group Utilization resource manages the resource utilization of a production resource group.
Show Source
Nested Schema : Resource Operation Sequences
Type:
array
Title:
Resource Operation Sequences
The Resource Operation Sequences resource manages the sequence of operations that occur on a production resource.
Show Source
Nested Schema : Resource Relationships
Type:
array
Title:
Resource Relationships
The Resource Relationships resource manages the upstream and downstream production resource relationships that describe how a product can be manufactured in a multistage production environment.
Show Source
Nested Schema : Resources
Type:
array
Title:
Resources
The Resources resource manages production resources that are part of the production schedule.
Show Source
Nested Schema : Resource Usage Levels
Type:
array
Title:
Resource Usage Levels
The Resource Usage Levels resource manages the usage levels for a production resource.
Show Source
Nested Schema : Resource Utilization
Type:
array
Title:
Resource Utilization
The Resource Utilization resource manages the resource utilization of a production resource.
Show Source
Nested Schema : KPIs for Resource Utilization
Type:
array
Title:
KPIs for Resource Utilization
The KPI for Resource Utilization resource manages the summary of the overall utilization of the production resources that are included in the schedule and used for reporting.
Show Source
Nested Schema : KPI Summaries
Type:
array
Title:
KPI Summaries
The KPI Summaries resource manages the summary of the overall key performance indicators of the production schedule used for reporting.
Show Source
Nested Schema : Scheduling Resources
Type:
array
Title:
Scheduling Resources
The Scheduling Resources resource manages the production resources used in the production schedule.
Show Source
Nested Schema : Selected Item Categories
Type:
array
Title:
Selected Item Categories
The Selected Item Categories resource manages the item categories used to establish the scope of items to include in the production schedule.
Show Source
Nested Schema : Supply Events
Type:
array
Title:
Supply Events
The Supply Events resource manages the supplies that are a part of the production schedule and can include purchase orders, transfer orders, and on hand.
Show Source
Nested Schema : Work Order Operation Alternate Resources
Type:
array
Title:
Work Order Operation Alternate Resources
The Work Order Operation Alternate Resources resource manages the viable alternate production resource that can be used for an operation.
Show Source
Nested Schema : Work Order Operation Attributes
Type:
array
Title:
Work Order Operation Attributes
The Work Order Operation Attributes resource manages the attributes that are relevant for a work order operation and used to generate a production schedule.
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 : Work Orders
Type:
array
Title:
Work Orders
The Work Orders resource manages the work orders that are to be scheduled in the production schedule.
Show Source
Nested Schema : Work Order Temporal Relations
Type:
array
Title:
Work Order Temporal Relations
The Work Order Temporal Relations resource manages the temporal relations between the upstream and downstream operations.
Show Source
Nested Schema : productionSchedulingPlans-assets-item-response
Type:
Show Source
object
-
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. -
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. -
Description: 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. -
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that uniquely identifies the item that the asset references. The application determines this value from the attribute that identifies the item. This attribute is read only. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item that the asset references. -
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 record. -
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. -
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.
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-assignedAttributeValues-item-response
Type:
Show Source
object
-
AttributeCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the attribute. -
AttributeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the attribute. -
AttributeName: string
Read Only:
true
Maximum Length:100
Name of the attribute. -
AttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the attribute value. -
AttributeValueId: integer
(int64)
Read Only:
true
Value that uniquely identifies the attribute value. -
AttributeValueName: string
Read Only:
true
Maximum Length:300
Name of the attribute value. -
Color: string
Read Only:
true
Maximum Length:10
Color associated with the attribute value which can be used for highlighting in the user interface. The value is specified in HTML hex color code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-attributes-item-response
Type:
Show Source
object
-
AttributeCode: string
Maximum Length:
300
Abbreviation that identifies the attribute. -
AttributeId: integer
(int64)
Value that uniquely identifies the attribute.
-
AttributeName: string
Maximum Length:
100
Name of the attribute. -
attributeValues: array
Attribute Values
Title:
Attribute Values
The Attribute Values resource manages the attribute values that are used in the scheduling changeover rules. -
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
DefaultAttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the attribute of the default attribute. -
DefaultAttributeValueId: integer
(int64)
Value that uniquely identifies the default attribute value.
-
Description: string
Maximum Length:
2000
Description of the attribute. -
HighlightAttributeFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the attribute can be used for highlighting in the user interface. If false, then the attribute can't be used for highlighting in the user interface. This attribute doesn't have a default value. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
Nested Schema : Attribute Values
Type:
array
Title:
Attribute Values
The Attribute Values resource manages the attribute values that are used in the scheduling changeover rules.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-attributes-attributeValues-item-response
Type:
Show Source
object
-
AttributeId: integer
(int64)
Value that uniquely identifies the attribute.
-
AttributeValueCode: string
Maximum Length:
300
Abbreviation that indicates the attribute value. -
AttributeValueId: integer
(int64)
Value that uniquely identifies the attribute value.
-
AttributeValueName: string
Maximum Length:
300
Name of the attribute value. -
Color: string
Maximum Length:
10
Color associated with the attribute value which can be used for highlighting in the user interface. Value is specified in hex color code as common in HTML standards. -
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
Description: string
Maximum Length:
2000
Description of the attribute value. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-calendarEvents-item-response
Type:
Show Source
object
-
CalendarId: integer
(int64)
Value that uniquely identifies the calendar.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EndDate: string
(date-time)
Date and time when the calendar event is no longer effective.
-
EventType: string
Maximum Length:
20
Type of calendar event. Valid values are Delay or Down. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
StartDate: string
(date-time)
Date and time when the calendar event is effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-calendars-item-response
Type:
Show Source
object
-
CalendarCode: string
Maximum Length:
300
Abbreviation that identifies the calendar. -
calendarEvents: array
Calendar Events
Title:
Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available. -
CalendarId: integer
(int64)
Value that uniquely identifies the calendar.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
Description: string
Maximum Length:
2000
Description of the calendar. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
Nested Schema : Calendar Events
Type:
array
Title:
Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-calendars-calendarEvents-item-response
Type:
Show Source
object
-
CalendarId: integer
(int64)
Value that uniquely identifies the calendar.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EndDate: string
(date-time)
Date and time when the calendar event is no longer effective.
-
EventType: string
Maximum Length:
20
Type of calendar event. Valid values are Delay or Down. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
StartDate: string
(date-time)
Date and time when the calendar event is effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-changeoverInstances-item-response
Type:
Show Source
object
-
changeoverInstanceDetails: array
Changeover Instance Details
Title:
Changeover Instance Details
The Changeover Instance Details resource manages the details of the changeovers including the attributes and durations that impact that changeover. -
ChangeoverInstanceId: integer
(int64)
Value that uniquely identifies the changeover instance.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
DurationUnit: string
Maximum Length:
30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, days. -
ElapsedDuration: number
Duration that elapsed for the changeover instance.
-
EndDate: string
(date-time)
Date and time when the record is no longer effective..
-
FromResourceSequenceNumber: integer
Number that identifies the resource sequence of the from operation.
-
FromWorkOrderOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation for the upstream operation that triggers a changeover. -
FromWorkOrderOperationId: integer
(int64)
Value that uniquely identifies the operation of the from work order.
-
FromWorkOrderOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation for the upstream operation that triggers a changeover. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
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.
-
RunDuration: number
Duration of running for the changeover instance. This value is less then or equal to the elapsed duration.
-
StartDate: string
(date-time)
Date and time when the changeover instance is effective.
-
ToResourceSequenceNumber: integer
Number that identifies the resource sequence of the to operation.
-
ToWorkOrderOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation for the downstream operation that triggers a changeover. -
ToWorkOrderOperationId: integer
(int64)
Value that uniquely identifies the operation of the to work order.
-
ToWorkOrderOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation for the downstream operation that triggers a changeover. -
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.
Nested Schema : Changeover Instance Details
Type:
array
Title:
Changeover Instance Details
The Changeover Instance Details resource manages the details of the changeovers including the attributes and durations that impact that changeover.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-changeoverInstances-changeoverInstanceDetails-item-response
Type:
Show Source
object
-
AttributeCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the attribute. -
AttributeId: integer
(int64)
Value that uniquely identifies the attribute.
-
AttributeName: string
Read Only:
true
Maximum Length:100
Name of the attribute for a changeover instance. -
ChangeoverInstanceId: integer
(int64)
Value that uniquely identifies the changeover instance.
-
Cost: number
Cost of changeover for the changeover rule.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
Duration: number
Duration of the changeover instance.
-
DurationUnit: string
Maximum Length:
30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, days. -
FromAttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the from attribute value. -
FromAttributeValueId: integer
(int64)
Value that uniquely identifies the from attribute value.
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ToAttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the to attribute value. -
ToAttributeValueId: integer
(int64)
Value that uniquely identifies the to attribute value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-changeoverRules-item-response
Type:
Show Source
object
-
AttributeCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the attribute. -
AttributeId: integer
(int64)
Value that uniquely identifies the attribute.
-
CalendarCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the calendar. -
CalendarId: integer
(int64)
Value that uniquely identifies the calendar.
-
ChangeoverId: integer
(int64)
Value the uniquely identifies a changeover.
-
ChangeoverSequenceNumber: number
Number that identifies the sequence that defines the order of changeover rules in the organization.
-
Cost: number
Cost of changeover for the changeover rule.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
Duration: number
Duration associated with the changeover rule.
-
DurationUnit: string
Maximum Length:
30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, days. -
FromAttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the from attribute value. -
FromAttributeValueId: integer
(int64)
Value that uniquely identifies the from attribute value.
-
GroupCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource group. -
GroupId: integer
(int64)
Value the uniquely identifies the resource group.
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
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.
-
ToAttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the to attribute value. -
ToAttributeValueId: integer
(int64)
Value that uniquely identifies the to attribute 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-changeoverTimeMeasures-item-response
Type:
Show Source
object
-
ChangeoverTime: number
Read Only:
true
Key performance indicator for changeover time. -
ChangeoverTimeUnit: string
Read Only:
true
Maximum Length:30
Time unit of changeover duration. Valid values include seconds, minutes, hours, days, shifts, weeks, and months. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-demandEvents-item-response
Type:
Show Source
object
-
AvailableDate: string
(date-time)
Date when the demand line-item engine is scheduled.
-
CustomerName: string
Maximum Length:
300
Name of the customer with the demand. -
CustomerNumber: string
Maximum Length:
240
Number of the customer with the demand. -
DemandHeaderId: integer
(int64)
Value that uniquely identifies the demand header.
-
DemandId: integer
(int64)
Value the uniquely identifies the demand.
-
DemandLineItemNumber: string
Maximum Length:
150
Number that identifies the line of the demand. -
DemandNumber: string
Maximum Length:
240
Number that identifies the demand. -
DemandPriority: number
Priority of the demand.
-
DemandStatus: string
Maximum Length:
30
User defined status of the line-item. Valid values include Approved or OnHold. -
DemandType: string
Maximum Length:
30
Type of demand order. Valid values include Order, Forecast, and Safety. -
EarliestDate: string
(date-time)
Date when the user created the earliest demand.
-
FolderPath: string
Maximum Length:
300
Path where the demand is located. -
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 of the demand. -
LatestDate: string
(date-time)
Date when the user created the most recent demand.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderClass: string
Maximum Length:
20
Order class of the demand. Valid values include HotOrder, Committed, and Uncommitted. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
Precision: integer
(int64)
Read Only:
true
Display precision of the demand line item. -
Quantity: number
Quantity for the demand line-item.
-
RequestDate: string
(date-time)
Date when the demand is requested.
-
ReservationsFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the demand order has reservations for this line-item. If N, then the demand order doesn't have reservations for this line-item. This attribute doesn't have a default value. -
SatisfactionDate: string
(date-time)
Date when the demand line-item is satisfied.
-
ShipCompleteFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then shipping is complete on the demand order. If N, then shipping isn't complete on the demand order. This attribute doesn't have a default value. -
ShipToAddress: string
Maximum Length:
240
Address to ship to of the demand order which can contain multiple lines. -
TargetCompletionDate: string
(date-time)
Date when the demand line-item completion is targeted.
-
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order.
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-items-item-response
Type:
Show Source
object
-
ApplySupplyToleranceFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then apply supply tolerance on the inventory item. If N, then don't apply supply tolerance on the inventory item. This attribute doesn't have a default value. -
ConsumptionTime: number
Target time of consumption of the inventory item.
-
ConsumptionTimeUnit: string
Maximum Length:
30
Time unit of consumption. Valid values include seconds, minutes, hours, days, shifts, weeks, and months. -
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
Description: string
Maximum Length:
500
Description of the production schedule. -
EarliestShortageConsumeDate: string
(date-time)
Value that indicates the earliest date when the item is available if a work order operation is short of supply.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemCode: string
Maximum Length:
300
Abbreviation that identifies the item. -
ItemType: string
Maximum Length:
30
Type of item. Valid values include Manufactured, Purchased, and Both. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
LeadTimeDays: number
Value that indicates the lead time of the Make or Buy items.
-
LeadTimeOverrideDays: number
Value that indicates the lead time of the make or buy items. This attribute overrides the lead time value that??s inherited from the LeadTimeDays attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumLevel: number
Maximum level of the inventory item.
-
MinimumLevel: number
Minimum level of the inventory item.
-
onHoldLots: array
On Hold Lots
Title:
On Hold Lots
The On Hold Lots resource manages the on-hand inventory that's on hold. -
OnHoldQuantity: number
Read Only:
true
The quantity of the lot that's on hold. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
PlanningMakeBuyValue: string
Maximum Length:
80
Value that indicates whether the item is a manufactured item or a purchased item. Valid values are Make and Buy. -
Precision: integer
(int64)
Display precision of the inventory item.
-
RebuildableFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the item is rebuildable. If N, then the item isn't rebuildable. This attribute doesn't have a default value. -
ReceivingCalendarId: integer
(int64)
Value that uniquely identifies the receiving calendar.
-
RelaxedMaximumLevelFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then relax the maximum value. If N, then don't relax the maximum value. This attribute doesn't have a default value. -
RelaxedMinimumLevelFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then relax the minimum value. If N, then don't relax the minimum value. This attribute doesn't have a default value. -
SaleableFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the item is available for sale. If N, then the item isn't available for sale. This attribute doesn't have a default value. -
ShortageQuantity: number
The amount that the item is short for the plan.
-
StartLevel: number
Start level of on-hand inventory item.
-
UnitOfMeasure: string
Maximum Length:
25
Name of the unit of measure. -
UOMCode: string
Maximum Length:
30
Abbreviation that identifies the unit of measure. -
UseConsumptionTimeFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then use consumption time. If N, then don't use consumption time. This attribute doesn't have a default value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : On Hold Lots
Type:
array
Title:
On Hold Lots
The On Hold Lots resource manages the on-hand inventory that's on hold.
Show Source
Nested Schema : productionSchedulingPlans-items-onHoldLots-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. -
Description: string
Read Only:
true
Maximum Length:500
Description of the on-hold lot. -
HoldDate: string
(date-time)
Read Only:
true
Date when the hold expires. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item. -
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. -
LotNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the inventory lot. -
OnHoldQuantity: number
Read Only:
true
The quantity of the lot that's on hold. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production schedule. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-lateDemandMeasures-item-response
Type:
Show Source
object
-
BucketStart: string
(date)
Read Only:
true
Bucket start date for late demands. -
LateDemandCount: integer
Read Only:
true
Count of the number of late demands. -
LateDemands: string
Read Only:
true
Maximum Length:4000
Late demands in the plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-lateWorkOrderMeasures-item-response
Type:
Show Source
object
-
BucketStart: string
(date)
Read Only:
true
Bucket start date for late work orders. -
LateWorkOrderCount: integer
Read Only:
true
Count of the number of late work orders. -
LateWorkOrders: string
Read Only:
true
Maximum Length:4000
Late work orders in the plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-peggingRelationships-item-response
Type:
Show Source
object
-
ConsumeByDurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the principal resource of a work center in an operation that consumes the supply. -
ConsumeByDurationResourceId: number
Read Only:
true
Value that uniquely identifies the principal resource that consumes the supply. -
ConsumeById: integer
(int64)
Read Only:
true
Value that uniquely identifies the demand that consumes the supply. -
ConsumeByOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation that consumes the supply. -
ConsumeByOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation that consumes the supply. -
ConsumeByOperationSequenceNumber: number
Read Only:
true
Number of the operation sequence that consumes the supply. -
ConsumeByResourceSequenceNumber: integer
Read Only:
true
Number of the resource sequence that consumes the supply. -
ConsumeByType: string
Read Only:
true
Maximum Length:30
The type of demand that consumes the supply. -
ConsumeByWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center that consumes the supply. -
ConsumeByWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center that consumes the supply. It's a primary key of the work center. -
ConsumeByWorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order that consumes the supply. -
ConsumeByWorkOrderNumber: string
Read Only:
true
Maximum Length:300
Number of the work order that consumes the supply. -
ConsumeDate: string
(date-time)
Read Only:
true
The date when the demand consumes the supply. -
DemandLineItemNumber: string
Read Only:
true
Maximum Length:150
Number of the demand line item that consumes the supply. -
DemandNumber: string
Read Only:
true
Maximum Length:240
Number of the demand that consumes the supply. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item. -
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the inventory lot. -
PeggingDepth: integer
Read Only:
true
The depth at which the pegging record falls in the pegging hierarchy. -
PeggingId: integer
Read Only:
true
Value that uniquely identifies the supply and demand pegging relationship. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production schedule. -
Quantity: number
Read Only:
true
Quantity that's pegged for the supply and demand. -
SupplyByDurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the principal resource in an operation of the supply that??s consumed. -
SupplyByDurationResourceId: number
Read Only:
true
Value that uniquely identifies the principal resource of the supply that??s consumed. -
SupplyById: integer
(int64)
Read Only:
true
Value that uniquely identifies the supply that's consumed. -
SupplyByOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that uniquely identifies the operation code of the supply that's consumed. -
SupplyByOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation of the supply that's consumed. -
SupplyByOperationSequenceNumber: number
Read Only:
true
Number of the operation sequence of the supply that's consumed. -
SupplyByResourceSequenceNumber: integer
Read Only:
true
Number of the resource sequence of the supply that's consumed. -
SupplyByType: string
Read Only:
true
Maximum Length:30
The type of supply that's consumed. -
SupplyByWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center of the supply that??s consumed. -
SupplyByWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center of the supply that's consumed. It's a primary key of the work center. -
SupplyByWorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order that's consumed. -
SupplyByWorkOrderNumber: string
Read Only:
true
Maximum Length:300
Number of the work order that's consumed. -
SupplyDate: string
(date-time)
Read Only:
true
The date when the supply is available to the demand. -
SupplyLineItemNumber: string
Read Only:
true
Maximum Length:150
Number of the supply line item that's consumed. -
SupplyNumber: string
Read Only:
true
Maximum Length:240
Number of the supply that's consumed. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-planStatus-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
CurrentRequest: integer
(int32)
Current request that's handled by the engine. This attribute will be reset to null on successful completion of the plan, otherwise it identifies the request that failed.
-
EndDate: string
(date-time)
Date and time when the plan execution session is no longer effective.
-
ErrorCode: integer
(int32)
Abbreviation that identifies the error that describes the reason of last request failure. Valid values include null, EnvironmentError: 0, DataError: 1, and SolveError: 2.
-
ExecutionId: integer
(int64)
Value that uniquely identifies the plan execution session in the engine.
-
ExecutionUser: string
Maximum Length:
64
User who launches the plan execution. -
JobId: integer
(int64)
Value that uniquely identifies the job to run the plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
planStatusDetails: array
Plan Status Details
Title:
Plan Status Details
The Plan Status Details resource manages the details of the different states of the schedule. -
StartDate: string
(date-time)
Date when the plan execution session is effective.
-
Status: integer
(int32)
Status of the overall execution of the plan. Valid values include PlanRunning: 0, PlanSucceeded: 1, and PlanFailed: 2.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Plan Status Details
Type:
array
Title:
Plan Status Details
The Plan Status Details resource manages the details of the different states of the schedule.
Show Source
Nested Schema : productionSchedulingPlans-planStatus-planStatusDetails-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EndDate: string
(date-time)
Date when the request handling is no longer effective.
-
ExecutionId: integer
(int64)
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Percentage: integer
(int32)
Percent of completeness of plan execution.
-
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
Request: integer
(int32)
Request handled by the engine. Valid values include OpenPlan: 1, ReopenPlan: 2, SolvePlan: 3, ReschedulePlan: 4, SavePlan: 5, ResetSavedPlan: 6, ClosePlan: 7, and AbortPlan: 8.
-
StartDate: string
(date-time)
Date when the request handling is effective.
-
Status: integer
(int32)
Status of the overall execution of the plan. Valid values include PlanRunning: 0, PlanSucceeded: 1, and PlanFailed: 2.
-
StepSequence: integer
(int32)
Number that identifies the sequence of the plan execution steps.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-reservations-item-response
Type:
Show Source
object
-
DemandHeaderId: integer
Read Only:
true
Value that uniquely identifies the demand header. -
DemandHeaderNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the demand header. -
DemandId: integer
(int64)
Read Only:
true
Value the uniquely identifies the demand. -
DemandLineId: integer
Read Only:
true
Value that uniquely identifies the demand line. -
DemandLineNumber: string
Read Only:
true
Maximum Length:150
Number that identifies the demand line. -
DemandSourceType: string
Read Only:
true
Maximum Length:80
Type of document that requests the inventory reservation. -
DemandSourceTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the type of document that requests the inventory reservation. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item. -
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the item. -
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. -
PrimaryReservationQuantity: number
Read Only:
true
Reserved quantity of the item. -
ReservationId: integer
Read Only:
true
Value that uniquely identifies the reservation. -
ResourceSequenceNumber: integer
Read Only:
true
Number that identifies the resource sequence of the operation material. -
SupplyHeaderId: integer
Read Only:
true
Value that uniquely identifies the supply header. -
SupplyHeaderNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the supply header. -
SupplyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplyLineId: integer
Read Only:
true
Value that uniquely identifies the supply line. -
SupplyLineNumber: string
Read Only:
true
Maximum Length:150
Number that identifies the supply line. -
SupplySourceType: string
Read Only:
true
Maximum Length:80
Type of supply document. -
SupplySourceTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the type of supply document. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceCalendars-item-response
Type:
Show Source
object
-
CalendarCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the calendar. -
CalendarId: integer
(int64)
Read Only:
true
Value that uniquely identifies the calendar. -
CapacityType: string
Read Only:
true
Maximum Length:30
Type of resource. Valid values include single capacity, multiple capacity, or batch. -
EndDate: string
(date-time)
Read Only:
true
Date when the resource calendar is no longer effective. -
EventType: string
Read Only:
true
Maximum Length:20
Type of calendar event. Valid values are Delay or Down. -
GroupMemberSequenceNumber: number
Read Only:
true
Number that identifies the display sequence for a member of a group which is used for the display order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
ResourceType: string
Read Only:
true
Maximum Length:30
Type of production resource. Valid values include Equipment or Labor. -
StartDate: string
(date-time)
Read Only:
true
Date when the resource calendar is effective. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceChangeoverSequences-item-response
Type:
Show Source
object
-
CapacityType: string
Read Only:
true
Maximum Length:30
Type of resource. Valid values includes single capacity, multiple capacity, or batch. -
ChangeoverDetails: string
Read Only:
true
Maximum Length:4000
Details of the changeover for the resource changeover sequences. -
ChangeoverInstanceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the changeover instance. -
DurationUnit: string
Read Only:
true
Maximum Length:30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, and days. -
ElapsedDuration: number
Read Only:
true
Duration that elapsed for the changeover sequences. -
EndDate: string
(date-time)
Read Only:
true
Date when the resource changeover sequence is no longer effective. -
FromResourceSequenceNumber: integer
Read Only:
true
Number that identifies the resource sequence of the from operation. -
FromWorkOrderOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the from operation for a resource changeover. -
FromWorkOrderOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the operation of the from work order. -
FromWorkOrderOperationName: string
Read Only:
true
Maximum Length:120
Name of the from operation for a resource changeover. -
GroupMemberSequenceNumber: number
Read Only:
true
Number that identifies the display sequence for a member of a group which is used for the display order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
ResourceType: string
Read Only:
true
Maximum Length:30
Type of production resource. Valid values include Equipment or Labor. -
RunDuration: number
Read Only:
true
Duration of running for the changeover instance. This value is less then or equal to elapsed duration. -
StartDate: string
(date-time)
Read Only:
true
Date when the resource changeover sequence is effective. -
ToResourceSequenceNumber: integer
Read Only:
true
Number that identifies the resource sequence of the to operation. -
ToWorkOrderOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the to operation for a resource changeover. -
ToWorkOrderOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the to work order operation. -
ToWorkOrderOperationName: string
Read Only:
true
Maximum Length:120
Name of the to operation name for a resource sequence. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceGroups-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. -
Description: string
Maximum Length:
2000
Description of the production schedule. -
GroupCode: string
Maximum Length:
300
Abbreviation that identifies the resource group. -
GroupId: integer
(int64)
Value the uniquely identifies the resource group.
-
groupMembers: array
Resource Group Members
Title:
Resource Group Members
The Resource Group Members resource manages the resources associated with a resource group. -
IncludeOSPSupplierFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the outside processing supplier is added to the resource group. If false, the outside processing supplier isn't added to the resource group. The default value is false. -
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)
Value that uniquely identifies the production schedule.
Nested Schema : Resource Group Members
Type:
array
Title:
Resource Group Members
The Resource Group Members resource manages the resources associated with a resource group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceGroups-groupMembers-item-response
Type:
Show Source
object
-
CreatedBy: string
Maximum Length:
64
User who created the record. -
CreationDate: string
(date-time)
Date and time when the user created the record.
-
LastUpdateDate: string
(date-time)
Date and time when the user most recently updated the record.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the record. -
LastUpdateLogin: string
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. -
MemberId: integer
(int64)
Value that uniquely identifies the resource for a member of a resource group.
-
MemberSequenceNumber: number
Number that identifies the display sequence for a member of a group which is used for the display order.
-
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
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.
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceGroupUtilization-item-response
Type:
Show Source
object
-
BucketStartDate: string
(date-time)
Read Only:
true
Date when the bucket for resource utilization calculations is effective. -
BucketType: string
Read Only:
true
Maximum Length:32
Type of bucket of resource utilization data. Valid values include daily or weekly. -
ChangeoverHours: number
Read Only:
true
Number of hours taken for a changeover. -
ChangeoverPercentage: number
Read Only:
true
Percentage of time taken for changeovers. -
DelayHours: number
Read Only:
true
Number of hours taken by delay time. -
DelayPercentage: number
Read Only:
true
Percentage of time taken for delays. -
DownHours: number
Read Only:
true
Number of hours taken by down time. -
DownPercentage: number
Read Only:
true
Percentage of time taken for down time. -
GroupCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource group. -
GroupId: integer
(int64)
Read Only:
true
Value the uniquely identifies the resource group. -
IdleHours: number
Read Only:
true
Number of hours the resource is idle. -
IdlePercentage: number
Read Only:
true
Percentage of time taken for idle time. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetAvailableHours: number
Read Only:
true
Number of net available hours of the resource. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
RunHours: number
Read Only:
true
Number of hours taken to preform a task. -
RunPercentage: number
Read Only:
true
Percentage of time used to perform a task. -
TotalAvailableHours: number
Read Only:
true
Number of total available hours of the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceOperationSequences-item-response
Type:
Show Source
object
-
AllowOffloadingFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the operation's resource can be offloaded. If false, the operation's resource can't be offloaded. This attribute doesn't have a default value. -
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. -
AttributeValues: string
Read Only:
true
Maximum Length:4000
Attribute values in the resource operation sequences. -
CapacityRequired: number
Read Only:
true
Number of resource units assigned to the operation resource. -
CapacityType: string
Read Only:
true
Maximum Length:30
Type of resource capacity. Valid values include single capacity, multiple capacity, or batch. -
ChangedByLastRepairFlag: boolean
Read Only:
true
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
Read Only:
true
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. -
CompletedQuantity: number
Read Only:
true
Quantity that's completed of the resource operation sequence. -
CompletionDate: string
(date-time)
Read Only:
true
Date when the resource operation sequence is completed. -
DisplaySlotNumber: integer
(int32)
Read Only:
true
Resource unit slot number that displays the operation resource. -
DurationResourceFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the operation is on the principal resource. If false, then the operation isn't on the principal resource. -
ExecutionSequence: number
Read Only:
true
Execution sequence of the work order operation. -
FirmPlannedFlag: boolean
Read Only:
true
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. -
FirmStatus: string
Read Only:
true
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. -
GroupMemberSequenceNumber: number
Read Only:
true
Number that identifies the display sequence for a member of a group which is used for the display order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation. -
OperationName: string
Read Only:
true
Maximum Length:120
Name of the operation in a list of operation sequences. -
OperationSequenceNumber: number
Read Only:
true
Number that identifies the operation sequence. -
OperationType: string
Read Only:
true
Maximum Length:30
Type of the resource operation, which indicates if it's an in house or and outside supplier operation. -
PeggedDemands: string
Read Only:
true
Maximum Length:4000
Demands and customers pegged to a work order. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
PrimaryItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the primary item. -
PrimaryItemDescription: string
Read Only:
true
Maximum Length:500
Description of the primary item that's produced. -
PrimaryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the primary item. -
PrimaryProductQuantity: number
Read Only:
true
Quantity planned to be produced for the work order. -
PrimaryProductRemainingQuantity: number
Read Only:
true
Quantity remaining to be produced for the work order. -
RejectedQuantity: number
Read Only:
true
Quantity rejected, if any, for the operation. -
RemainingQuantity: number
Read Only:
true
Quantity that's remaining of the resource operation sequence. -
RequestedDate: string
(date-time)
Read Only:
true
Date when the operation sequence is requested. -
ResourceActivityName: string
Read Only:
true
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)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
ResourceSequenceNumber: integer
Read Only:
true
Number that identifies the resource sequence of the resource operation. -
ResourceType: string
Read Only:
true
Maximum Length:30
Type of production resource. Valid values include Equipment or Labor. -
ScheduledDuration: number
Read Only:
true
Duration of schedule of the operation. -
ScheduledDurationUnit: string
Read Only:
true
Maximum Length:30
Time unit of measure for schedule duration of the operation. Valid values include second, minutes, hours, and days. -
ScheduledEndDate: string
(date-time)
Read Only:
true
Date when the schedule of the resource operation is no longer effective. -
ScheduledStartDate: string
(date-time)
Read Only:
true
Date when the schedule of the resource operation is effective. -
ScrappedQuantity: number
Read Only:
true
Quantity scrapped, if any, for the operation. -
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. If the serial number already exists in inventory, then it must be in the Out of Storage status and no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number doesn't exist in inventory, then the application creates a serial in inventory with the Out of Storage status. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier for the scheduled operation. -
SupplierName: string
Read Only:
true
Maximum Length:360
Name of the supplier associated with the scheduled operation. -
SupplierSiteCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the supplier associated with the scheduled operation. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site for the scheduled operation. -
SupplyPlanSupplyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supply plan for planned order supplies. -
SupplyReservationsFlag: boolean
Read Only:
true
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. -
TargetCompletionDate: string
(date-time)
Read Only:
true
Date when the work order is targeted to be scheduled. This attribute overrides the need-by date of the work order associated with the operation. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure for the primary product. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center. -
WorkMethodCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the user key to the work method. -
WorkMethodId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work method for which this work definition is applicable. -
WorkMethodName: string
Read Only:
true
Maximum Length:120
Name of the work method. -
WorkOrderId: integer
(int64)
Read Only:
true
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 the uniquely identifies the work order. -
WorkOrderOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order operation. It's a primary key of the work order operation. -
WorkOrderRemainingQuantity: number
Read Only:
true
Remaining quantity for the work order operation. -
WorkOrderSubTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the subtype of the work order. -
WorkOrderSubTypeName: string
Read Only:
true
Maximum Length:80
Name of the work order subtype. -
WorkOrderTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of the work order. -
WorkOrderTypeName: string
Read Only:
true
Maximum Length:80
Name of the work order type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceRelationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
DirectOnlyFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then direct feed is only between upstream and downstream resources. If false, then direct feed isn't just between upstream and downstream resources. This attribute doesn't have a default value. -
DownstreamGroupCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource group for the resource that's downstream. -
DownstreamGroupId: integer
(int64)
Read Only:
true
Value that uniquely identifies the downstream resource group. -
DownstreamResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource for the resource that's downstream. -
DownstreamResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the downstream resource. -
DownstreamWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center for the operation that's downstream. -
DownstreamWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the downstream work center. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
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. -
Rank: integer
(int32)
Read Only:
true
Rank of the resource relationship record. -
RelationshipId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource relationship record. -
UpstreamGroupCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource group for the resource that's upstream. -
UpstreamGroupId: integer
(int64)
Read Only:
true
Value that uniquely identifies the upstream resource group. -
UpstreamResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource that's upstream. -
UpstreamResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the upstream production resource. It's a primary key of the upstream production resource. -
UpstreamWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center for the operation that's upstream. -
UpstreamWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the upstream work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resources-item-response
Type:
Show Source
object
-
ApplyIdealSequenceFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then apply user-defined ideal sequence to a resource. If false, then don't apply user-defined ideal sequence to a resource. This attribute doesn't have a default value. -
AvailabilityCalendarCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the availability calendar. -
AvailabilityCalendarId: integer
(int64)
Value that uniquely identifies the available calendar.
-
CapacityType: string
Maximum Length:
30
Type of resource capacity. Valid values include single capacity, multiple capacity, or batch. -
ChangeoverCalculation: string
Maximum Length:
12
Value that indicates whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence. This attribute applies only to equipment resources. Valid values include Concurrent and Sequential. -
ChangeoverPosition: string
Maximum Length:
12
Value that indicates whether changeovers will be considered as setup or cleanup activities. This attribute applies only to equipment resources. Valid values include Setup and Cleanup. -
ConstraintMode: string
Maximum Length:
30
Mode of constraint. Valid values include RelaxCapacity, Relaxed, and Constrained. -
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EnforceHorizonStartFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the horizon start will be enforced during schedule generation. If N, then the horizon start won't be enforced during schedule generation. This attribute doesn't have a default value. -
FixedTimeFenceDuration: number
Duration of the fixed time fence from the start of the horizon.
-
FixedTimeFenceUnit: string
Maximum Length:
12
Time unit of measure for the fixed time fence. Valid values include seconds, minutes, hours, and days. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCapacity: number
Maximum capacity for multiple capacity resources.
-
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
PrebuildMaximum: number
Prebuild maximum considered by the dynamic resource allocation solver method.
-
PrebuildMaximumFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then use the prebuild maximum. If false, then don't use prebuild maximum. This attribute doesn't have a default value. -
PrebuildMaximumUnit: string
Maximum Length:
12
Time unit of measure for the prebuild maximum. Valid values include seconds, minutes, hours, and days. -
RankIndependentAttrCycleFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then continue ideal sequence independent of rank. If false, then don't continue ideal sequence independent of rank. This attribute doesn't have a default value. -
ResourceCode: string
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.
-
ResourceName: string
Maximum Length:
120
Name of the resource. -
ResourceType: string
Maximum Length:
30
Type of production resource. Valid values include Equipment or Labor. -
RestartSequenceAtCycleBoundaryFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the user-defined ideal attribute sequence will be restarted at each scheduling cycle boundary during schedule generation. If N, then the user-defined ideal attribute sequence won't be restarted. This attribute doesn't have a default value. -
usageLevels: array
Usage Levels
Title:
Usage Levels
The Usage Levels resource manages the usage levels for a production resource. -
WorkCenterCode: string
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.
-
WorkCenterName: string
Maximum Length:
120
Name of the work center that's associated with the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Usage Levels
Type:
array
Title:
Usage Levels
The Usage Levels resource manages the usage levels for a production resource.
Show Source
Nested Schema : productionSchedulingPlans-resources-usageLevels-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. -
EndDate: string
(date-time)
Date when the resource usage level is no longer effective.
-
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)
Value that uniquely identifies the production schedule.
-
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.
-
StartDate: string
(date-time)
Date when the resource usage level is effective.
-
UsageLevel: integer
(int64)
Level of resource usage.
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceUsageLevels-item-response
Type:
Show Source
object
-
CapacityType: string
Read Only:
true
Maximum Length:30
Type of resource capacity. Valid values include single capacity, multiple capacity, or batch. -
EndDate: string
(date-time)
Read Only:
true
Date when the resource usage level is no longer effective. -
GroupMemberSequenceNumber: number
Read Only:
true
Number that identifies the display sequence for a member of a group which is used for the display order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCapacity: integer
Read Only:
true
Maximum capacity used to determine resource usage levels. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
ResourceType: string
Read Only:
true
Maximum Length:30
Type of production resource. Valid values include Equipment or Labor. -
StartDate: string
(date-time)
Read Only:
true
Date when the resource usage level is effective. -
UsageLevel: integer
(int64)
Read Only:
true
Level of the resource usage. -
UsagePercentage: number
Read Only:
true
Percent of the resource usage level. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceUtilization-item-response
Type:
Show Source
object
-
BucketStartDate: string
(date-time)
Read Only:
true
Date when the bucket for resource utilization calculations is effective. -
BucketType: string
Read Only:
true
Maximum Length:32
Type of bucket of resource utilization data. Valid values include daily or weekly. -
CapacityType: string
Read Only:
true
Maximum Length:30
Type of resource capacity. Valid values include single capacity, multiple capacity, or batch. -
ChangeoverHours: number
Read Only:
true
Number of hours taken for a changeover. -
ChangeoverPercentage: number
Read Only:
true
Percentage of time taken for changeovers. -
DelayHours: number
Read Only:
true
Number of hours taken by delay time. -
DelayPercentage: number
Read Only:
true
Percentage of time taken for delays. -
DownHours: number
Read Only:
true
Number of hours taken by down time. -
DownPercentage: number
Read Only:
true
Percentage of time taken for down time. -
IdleHours: number
Read Only:
true
Number of hours the resource is idle. -
IdlePercentage: number
Read Only:
true
Percentage of time taken for idle time. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCapacity: number
Read Only:
true
Maximum capacity of the resource. -
NetAvailableHours: number
Read Only:
true
Number of net available hours of the resource. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production schedule. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
ResourceType: string
Read Only:
true
Maximum Length:30
Type of production resource. Valid values include Equipment or Labor. -
RunHours: number
Read Only:
true
Number of hours taken to preform a task. -
RunPercentage: number
Read Only:
true
Percentage of time used to perform a task. -
TotalAvailableHours: number
Read Only:
true
Number of total available hours of the resource. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-resourceUtilizationMeasures-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
ResourceType: string
Read Only:
true
Maximum Length:30
Type of production resource. Valid values include Equipment or Labor. -
ResourceUtilization: number
Read Only:
true
Value that indicates the resource utilization of a resource. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-scheduleMeasures-item-response
Type:
Show Source
object
-
ChangeoverTime: number
Read Only:
true
Key performance indicator for changeover time. -
ChangeoverTimeUnit: string
Read Only:
true
Maximum Length:30
Time unit of changeover duration. Valid values include seconds, minutes, hours, days, shifts, weeks, and months. -
CrewUtilization: number
Read Only:
true
Aggregate utilization of all resources that are of type labor. -
LateDemandCount: integer
Read Only:
true
Count of the number of late demands. -
LateWorkOrderCount: integer
Read Only:
true
Count of the number of late work orders. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MachineUtilization: number
Read Only:
true
Aggregate utilization of all resources that are of type equipment. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
ToolUtilization: number
Read Only:
true
Aggregate utilization of all resources that are of type tool.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-schedulingResources-item-response
Type:
Show Source
object
-
Attributes: string
Read Only:
true
Maximum Length:4000
Schedule attributes assigned to a production resource. -
AvailabilityCalendarCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the calendar that represents downtime for a resource. -
AvailabilityCalendarId: integer
(int64)
Read Only:
true
Value that uniquely identifies the maximum capacity used to determine resource usage levels. -
CapacityType: string
Read Only:
true
Maximum Length:30
Type of capacity. Valid values include single capacity, multiple capacity, or batch. -
ConstraintMode: string
Read Only:
true
Maximum Length:30
Mode of constraint. Valid values include RelaxCapacity, Relaxed, and Constrained. -
DisplayResourceUnitsFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: Y or N. If Y, then a row is displayed for each resource unit. If N, then only a summary row is displayed. The default value is N. -
DisplaySlotCount: integer
Read Only:
true
Total slot count for a resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCapacity: integer
Read Only:
true
Maximum number of resource units for a work center. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the production schedule. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
ResourceName: string
Read Only:
true
Maximum Length:120
Name of the resource. -
ResourceType: string
Read Only:
true
Maximum Length:30
Type of production resource. Valid values include Equipment or Labor. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center. -
WorkCenterName: string
Read Only:
true
Maximum Length:120
Name of the work center that's associated with the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-selectedItemCategories-item-response
Type:
Show Source
object
-
CatalogCode: string
Maximum Length:
30
Abbreviation that identifies the item catalog. -
CatalogId: integer
(int64)
Value that uniquely identifies the item catalog.
-
CategoryCode: string
Maximum Length:
820
Abbreviation that identifies the item category. -
CategoryId: integer
(int64)
Value that uniquely identifies the item category.
-
CategoryName: string
Maximum Length:
250
Name of the item category. -
CategorySetName: string
Maximum Length:
30
Name of the item category set. -
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. -
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)
Value that uniquely identifies the production schedule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-supplyEvents-item-response
Type:
Show Source
object
-
EarliestDate: string
(date-time)
Date when the item can be supplied at the earliest.
-
FolderPath: string
Maximum Length:
300
Path where the supply is located. -
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 for the supply. -
LatestDate: string
(date-time)
Date and time when the item can be supplier at the latest.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginAddress: string
Maximum Length:
240
Origin address of the supply. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
Precision: integer
(int64)
Read Only:
true
Display precision of the supply line item. -
Quantity: number
Quantity of the supply line item.
-
RequestDate: string
(date-time)
Date when the supply is requested.
-
RequestDateOverride: string
(date-time)
Date when the supply is requested. This attribute overrides the request date value that??s inherited from the RequestDate attribute.
-
ReservationsFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the demand order has reservations for this line item. If N, then the demand order doesn't have reservations for this line item. This attribute doesn't have a default value. -
SelectedDate: string
(date-time)
Date when the supply is expected to be available.
-
SupplierName: string
Maximum Length:
300
Name of the supplier. -
SupplierNumber: string
Maximum Length:
240
Number that identifies the supplier. -
SupplyHeaderId: integer
(int64)
Value that uniquely identifies the supply header.
-
SupplyId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplyLineItemNumber: string
Maximum Length:
150
Number that identifies the supply line item. -
SupplyNumber: string
Maximum Length:
240
Number that uniquely identifies the supplier. -
SupplyStatus: string
Maximum Length:
30
User-defined status of the line item. Valid values include Approved and OnHold. -
SupplyType: string
Maximum Length:
30
Type of the supply order. -
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order.
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperationAlternateResources-item-response
Type:
Show Source
object
-
AlternateResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource for an alternate resource. -
AlternateResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the alternate resource for a work order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation. -
OperationName: string
Read Only:
true
Maximum Length:120
Name of the operation for a resource alternate. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production schedule. -
Preference: number
Read Only:
true
Preference of the work order alternate operation resource. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key of the resource. -
ResourceSequenceNumber: number
Read Only:
true
Number that identifies the resource sequence of the work order operation alternate resource. -
ResourceSetCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the resource set for the alternate resource. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It's a primary key of the work center. -
WorkDefinitionOperationResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation resource. -
WorkOrderOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order operation. It's a primary key of the work order operation. -
WorkOrderOperationResourceId: integer
(int64)
Read Only:
true
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
Nested Schema : productionSchedulingPlans-workOrderOperationAttributes-item-response
Type:
Show Source
object
-
AttributeCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the attribute. -
AttributeId: integer
(int64)
Value that uniquely identifies the attribute.
-
AttributeName: string
Read Only:
true
Maximum Length:100
Name of the attribute associated with the work order operation. -
AttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that indicates the code of the attribute value. -
AttributeValueId: integer
(int64)
Value that uniquely identifies the attribute 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. -
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. -
OperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation. -
OperationName: string
Read Only:
true
Maximum Length:120
Name of the operation to identify the operation attribute values. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ResourceSequenceNumber: integer
Number that identifies the resource sequence of the operation attribute.
-
WoOperationId: integer
(int64)
Value that uniquely identifies the work order operation for the attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperations-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-workOrderOperations-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-workOrderOperations-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
Nested 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 : 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
Nested Schema : productionSchedulingPlans-workOrderTemporalRelations-item-response
Type:
Show Source
object
-
FromDurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the duration resource for the from operation of a work order operation. -
FromDurationResourceId: number
Read Only:
true
Value that uniquely identifies the from duration resource. -
FromOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the from operation of a work order. -
FromOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation for the from operation of a work order. -
FromOperationSequenceNumber: number
Read Only:
true
Number that identifies the from operation sequence. -
FromResourceSequenceNumber: integer
(int64)
Read Only:
true
Number that identifies the resource sequence of the from operation. -
FromWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center from the from operation of a resource. -
FromWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the operation of the work center. -
FromWorkOrderOperationId: integer
(int64)
Read Only:
true
Value that identifies the operation of the from work order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumSeparation: number
Maximum separation duration between operations.
-
MaximumSeparationUnit: string
Maximum Length:
20
Time unit of measure for the maximum separation. Valid values include seconds, minutes, hours, days, shifts, weeks, and months. -
MinimumSeparation: number
Minimum separation duration between operations.
-
MinimumSeparationUnit: string
Maximum Length:
20
Time unit of measure for the minimum separation. Valid values include seconds, minutes, hours, days, shifts, weeks, and months. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production schedule. -
TemporalConstraintType: string
Maximum Length:
20
Type of temporal constraint. Valid values include StartsAfterEnd, StartsAtEnd, StartsAfterStart, StartsAtStart, and EndsAtEnd. -
ToDurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource for the duration resource in the to operation. -
ToDurationResourceId: number
Read Only:
true
Value that uniquely identifies the resultant production resource. -
ToOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the to operation of a work order. -
ToOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation of a work order. -
ToOperationSequenceNumber: number
Read Only:
true
Number that identifies the to operation sequence. -
ToResourceSequenceNumber: integer
(int64)
Read Only:
true
Number that identifies the resource sequence of the to work order operation. -
ToWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the to work center. -
ToWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the to work center. -
ToWorkOrderOperationId: integer
(int64)
Read Only:
true
Value the uniquely identifies the to work order operation. -
WorkOrderId: integer
(int64)
Read Only:
true
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- applyCalendarPattern
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/action/applyCalendarPatternParameters:
- PlanId:
$request.path.PlanId
Request changing recurring calendar events to run scenarios with changing downtime or availability to assess the impact to the schedule. - PlanId:
- assets
-
Parameters:
- PlanId:
$request.path.PlanId
The Assets resource manages the assets that require maintenance. - PlanId:
- assignedAttributeValues
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/assignedAttributeValuesParameters:
- PlanId:
$request.path.PlanId
The Assigned Attribute Values resource manages the attributes that are assigned to work order operations that are used for scheduling. - PlanId:
- attributes
-
Parameters:
- PlanId:
$request.path.PlanId
The Attributes resource manages the attributes that are a part of the plan that are used for scheduling. - PlanId:
- calendarEvents
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/calendarEventsParameters:
- PlanId:
$request.path.PlanId
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available. - PlanId:
- calendars
-
Parameters:
- PlanId:
$request.path.PlanId
The Calendars resource manages the calendars that are part of the schedule to establish availability. - PlanId:
- changeoverInstances
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/changeoverInstancesParameters:
- PlanId:
$request.path.PlanId
The Changeover Instances resource manages the individual changeover instances that occur on a production resource as a result of the changeover rules. - PlanId:
- changeoverRules
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/changeoverRulesParameters:
- PlanId:
$request.path.PlanId
The Changeover Rules resource manages the changeover rules by attribute for a production resource or group. - PlanId:
- changeoverTimeMeasures
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/changeoverTimeMeasuresParameters:
- PlanId:
$request.path.PlanId
The KPI for Changeover Times resource manages the key performance indicator for changeover times of the production schedule used for reporting. - PlanId:
- demandEvents
-
Parameters:
- PlanId:
$request.path.PlanId
The Demand Events resource manages the demands to be considered in the production schedule. - PlanId:
- duplicatePlan
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/action/duplicatePlanParameters:
- PlanId:
$request.path.PlanId
Request to copy a plan and the necessary plan data to run scenarios - PlanId:
- items
-
Parameters:
- PlanId:
$request.path.PlanId
The Items resource manages the items that are part of the schedule and can include purchased, manufactured, and finished good items. - PlanId:
- lateDemandMeasures
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/lateDemandMeasuresParameters:
- PlanId:
$request.path.PlanId
The KPI for Late Demands resource manages the key performance indicator for late demands of the production schedule used for reporting. - PlanId:
- lateWorkOrderMeasures
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/lateWorkOrderMeasuresParameters:
- PlanId:
$request.path.PlanId
The KPI for Late Work Orders resource manages the key performance indicator for late work orders of the production schedule used for reporting. - PlanId:
- peggingRelationships
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/peggingRelationshipsParameters:
- PlanId:
$request.path.PlanId
The Pegging Relationships resource manages the pegging between different types of supply and demand. - PlanId:
- planStatus
-
Parameters:
- PlanId:
$request.path.PlanId
The Plan Statuses resource manages the different states of the schedule and determines when the schedule is completed. - PlanId:
- refreshPlanData
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/action/refreshPlanDataParameters:
- PlanId:
$request.path.PlanId
Refreshes and solves a plan in either constrained or unconstrained mode. - PlanId:
- releasePlan
-
Parameters:
- PlanId:
$request.path.PlanId
Requests to release a plan to the source application according to the release horizon. - PlanId:
- repairPlan
-
Parameters:
- PlanId:
$request.path.PlanId
Requests to manually schedule a work order operation resource for a given schedule. - PlanId:
- reservations
-
Parameters:
- PlanId:
$request.path.PlanId
The Reservations resource manages the reservations in a schedule. - PlanId:
- resourceCalendars
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resourceCalendarsParameters:
- PlanId:
$request.path.PlanId
The Resource Calendars resource manages the association of the calendar to the production resource. - PlanId:
- resourceChangeoverSequences
-
Parameters:
- PlanId:
$request.path.PlanId
The Resource Changeover Sequences resource manages the changeover sequences for a production resource. - PlanId:
- resourceGroupUtilization
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resourceGroupUtilizationParameters:
- PlanId:
$request.path.PlanId
The Resource Group Utilization resource manages the resource utilization of a production resource group. - PlanId:
- resourceGroups
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resourceGroupsParameters:
- PlanId:
$request.path.PlanId
The Resource Groups resource manages the user-defined groups of resources. - PlanId:
- resourceOperationSequences
-
Parameters:
- PlanId:
$request.path.PlanId
The Resource Operation Sequences resource manages the sequence of operations that occur on a production resource. - PlanId:
- resourceRelationships
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resourceRelationshipsParameters:
- PlanId:
$request.path.PlanId
The Resource Relationships resource manages the upstream and downstream production resource relationships that describe how a product can be manufactured in a multistage production environment. - PlanId:
- resourceUsageLevels
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resourceUsageLevelsParameters:
- PlanId:
$request.path.PlanId
The Resource Usage Levels resource manages the usage levels for a production resource. - PlanId:
- resourceUtilization
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resourceUtilizationParameters:
- PlanId:
$request.path.PlanId
The Resource Utilization resource manages the resource utilization of a production resource. - PlanId:
- resourceUtilizationMeasures
-
Parameters:
- PlanId:
$request.path.PlanId
The KPI for Resource Utilization resource manages the summary of the overall utilization of the production resources that are included in the schedule and used for reporting. - PlanId:
- resources
-
Parameters:
- PlanId:
$request.path.PlanId
The Resources resource manages production resources that are part of the production schedule. - PlanId:
- scheduleMeasures
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/scheduleMeasuresParameters:
- PlanId:
$request.path.PlanId
The KPI Summaries resource manages the summary of the overall key performance indicators of the production schedule used for reporting. - PlanId:
- schedulingResources
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/schedulingResourcesParameters:
- PlanId:
$request.path.PlanId
The Scheduling Resources resource manages the production resources used in the production schedule. - PlanId:
- selectedItemCategories
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/selectedItemCategoriesParameters:
- PlanId:
$request.path.PlanId
The Selected Item Categories resource manages the item categories used to establish the scope of items to include in the production schedule. - PlanId:
- solvePlan
-
Parameters:
- PlanId:
$request.path.PlanId
Requests to solve a plan. This action doesn't trigger a data refresh. - PlanId:
- stopSolvingPlan
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/action/stopSolvingPlanParameters:
- PlanId:
$request.path.PlanId
Requests to stop solving a plan and cancels the solve request. - PlanId:
- supplyEvents
-
Parameters:
- PlanId:
$request.path.PlanId
The Supply Events resource manages the supplies that are a part of the production schedule and can include purchase orders, transfer orders, and on hand. - PlanId:
- workOrderOperationAlternateResources
-
Parameters:
- PlanId:
$request.path.PlanId
The Work Order Operation Alternate Resources resource manages the viable alternate production resource that can be used for an operation. - PlanId:
- workOrderOperationAttributes
-
Parameters:
- PlanId:
$request.path.PlanId
The Work Order Operation Attributes resource manages the attributes that are relevant for a work order operation and used to generate a production schedule. - PlanId:
- workOrderOperations
-
Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/workOrderOperationsParameters:
- PlanId:
$request.path.PlanId
The Operations resource manages the operations that are a part of the work definition. - PlanId:
- workOrderTemporalRelations
-
Parameters:
- PlanId:
$request.path.PlanId
The Work Order Temporal Relations resource manages the temporal relations between the upstream and downstream operations. - PlanId:
- workOrders
-
Parameters:
- PlanId:
$request.path.PlanId
The Work Orders resource manages the work orders that are to be scheduled in the production schedule. - PlanId: