Jump to

• Request
• Response

Get all scheduled work orders

get

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/scheduledWorkOrders

Request

Path Parameters

• PlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the scheduled work orders.
    Finder Variables
    • PlanId; integer; Value that uniquely identifies the production schedule.
    • WorkOrderId; integer; Value that uniquely identifies the work order. It's a primary key of the work order.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActualEndDate; string; Date and time when the work order operation is no longer effective.
  • ActualStartDate; string; Date and time when the work order operation is actually effective.
  • AggregatedFlowScheduleId; integer; Value that uniquely identifies the aggregate flow schedule. This attribute is read only.
  • AssetDescription; string; Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset.
  • AssetId; integer; Value that uniquely identifies the asset charge. This attribute is read only.
  • AssetNumber; string; Number that uniquely identifies the asset.
  • BuildSequence; number; Sequence or order of flow schedules based on which manufacturing activity's carried out on the shop floor.
  • CompletedQuantity; number; Quantity of primary product completed so far in the work order.
  • Description; string; Quantity of primary product completed so far in the work order.
  • EarliestStartDate; string; Description of the production schedule.
  • FirmPlannedFlag; boolean; Date when the work order operation can be requested at the earliest.
  • InventoryItemId; integer; Value that uniquely identifies the inventory item.
  • ItemCode; string; Abbreviation that identifies the item.
  • ItemDescription; string; Description of the item that's produced by the work order.
  • MaintenanceOrganizationId; integer; Value that uniquely identifies the maintenance organization.
  • MaintenanceResourceCode; string; Abbreviation that identifies the maintenance resource.
  • MaintenanceResourceId; integer; Value that uniquely identifies the maintenance resource. It's a primary key of the resource.
  • MaintenanceWorkCenterCode; string; Abbreviation that identifies the maintenance work center.
  • MaintenanceWorkCenterId; integer; Value that uniquely identifies the maintenance work center. It's a primary key of the work center.
  • MaterialAvailable; string; 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.
  • NettablePlannedQuantity; number; Planned start quantity of the work order, after taking into account the cumulative yield factor.
  • NettableRemainingQuantity; number; Remaining quantity of the work order, after taking into account the completions, scrap, and cumulative yield factor.
  • OnHoldFlag; boolean; 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.
  • OrderClass; string; Class of the work order. Valid values include HotOrder, Committed, and Uncommitted.
  • PlanId; integer; 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.
  • ProductionLineCode; string; Code that identifies the production line.
  • ProductionLineId; integer; Value that uniquely identifies the production line.
  • ProductionLineName; string; Name of the production line.
  • ProductionLineRate; number; Rate at which production should progress per hour on a specific production line.
  • RejectedQuantity; number; Total rejected quantity across all operations for the work order.
  • RemainingQuantity; number; Quantity that's remaining.
  • RequestedDate; string; Date when the work order operation is requested.
  • RescheduledFlag; boolean; 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; Abbreviation that identifies the work definition for this work order.
  • ScheduledBuildSequence; number; The scheduled sequence or order of flow schedules based on which manufacturing activity's carried out on the shop floor.
  • ScheduledEndDate; string; Date when the work order is scheduled to complete.
  • ScheduledStartDate; string; Date when the work order is scheduled to start.
  • ScrappedQuantity; number; Total scrapped quantity across all operations for the work order.
  • SelectedForReleaseFlag; boolean; 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; Number that uniquely identifies the serial that the asset references. This attributes is applied when the item is serial controlled.
  • SupplyPlanSupplyId; integer; Value that uniquely identifies the supply plan for planned order supplies.
  • TargetCompletionDate; string; Date when the work order is targeted to be scheduled. This attribute overrides the need-by date of the work order.
  • UOMCode; string; Abbreviation that identifies the unit of measure for the primary product.
  • UnitOfMeasure; string; Name of the unit of measure.
  • WorkDefinitionId; integer; Value that uniquely identifies the work definition.
  • WorkDefinitionVersionNumber; string; Value that indicates the version of the work definition.
  • WorkMethodCode; string; Abbreviation that identifies the user key to the work method.
  • WorkMethodId; integer; Value that uniquely identifies the work method for which this work definition is applicable.
  • WorkMethodName; string; Name of the work method.
  • WorkOrderId; integer; Value that uniquely identifies the work order. It's a primary key of the work order.
  • WorkOrderNumber; string; Number that uniquely identifies the work order.
  • WorkOrderPriority; number; Value that indicates the value of the work order.
  • WorkOrderStatus; string; Value the indicates the status of the work order.
  • WorkOrderStatusName; string; The work order status.
  • WorkOrderSubTypeCode; string; Abbreviation that identifies the subtype of the work order.
  • WorkOrderSubTypeName; string; Name of the work order subtype.
  • WorkOrderType; string; Type of work order. Valid vales include Production, Maintenance, or EAM work order.
  • WorkOrderTypeCode; string; Abbreviation that identifies the type of the work order.
  • WorkOrderTypeName; string; Name of the work order type.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productionSchedulingPlans-scheduledWorkOrders

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingPlans-scheduledWorkOrders-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object productionSchedulingPlans-scheduledWorkOrders-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingPlans-scheduledWorkOrders-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productionSchedulingPlans-scheduledWorkOrders-item-response

Type: object

Show Source

• ActualEndDate: string (date-time)
  Read Only: true

  Date and time when the work order operation is no longer effective.
• ActualStartDate: string (date-time)
  Read Only: true

  Date and time when the work order operation is actually effective.
• AggregatedFlowScheduleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the aggregate flow schedule. This attribute is read only.
• 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 associated with a work order.
• BuildSequence: number
  Read Only: true

  Sequence or order of flow schedules based on which manufacturing activity's carried out on the shop floor.
• CompletedQuantity: number
  Read Only: true

  Quantity of primary product completed so far in the work order.
• Description: string
  Read Only: true

  Maximum Length: 500

  Quantity of primary product completed so far in the work order.
• EarliestStartDate: string (date-time)
  Read Only: true

  Description of the production schedule.
• FirmPlannedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Date when the work order operation can be requested at the earliest.
• 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.
• ItemDescription: string
  Read Only: true

  Maximum Length: 500

  Description of the item that's produced by the work order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaintenanceOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the maintenance organization.
• MaintenanceResourceCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the maintenance resource.
• MaintenanceResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the maintenance resource. It's a primary key of the resource.
• MaintenanceWorkCenterCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the maintenance work center.
• MaintenanceWorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the maintenance work center. It's a primary key of the work center.
• MaterialAvailable: string
  Read Only: true

  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.
• NettablePlannedQuantity: number
  Read Only: true

  Planned start quantity of the work order, after taking into account the cumulative yield factor.
• NettableRemainingQuantity: number
  Read Only: true

  Remaining quantity of the work order, after taking into account the completions, scrap, and cumulative yield factor.
• OnHoldFlag: boolean
  Read Only: true

  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.
• OrderClass: string
  Read Only: true

  Maximum Length: 20

  Class of the work order. Valid values include HotOrder, Committed, and Uncommitted.
• 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.
• PlannedStartQuantity: number
  Read Only: true

  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
  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.
• ProductionLineCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the production line.
• ProductionLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the production line.
• ProductionLineName: string
  Read Only: true

  Maximum Length: 120

  Name of the production line.
• ProductionLineRate: number
  Read Only: true

  Rate at which production should progress per hour on a specific production line.
• RejectedQuantity: number
  Read Only: true

  Total rejected quantity across all operations for the work order.
• RemainingQuantity: number
  Read Only: true

  Quantity that's remaining.
• RequestedDate: string (date-time)
  Read Only: true

  Date when the work order operation is requested.
• RescheduledFlag: boolean
  Read Only: true

  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
  Read Only: true

  The total quantity of demands reserved to the work order.
• RoutingCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the work definition for this work order.
• ScheduledBuildSequence: number
  Read Only: true

  The scheduled sequence or order of flow schedules based on which manufacturing activity's carried out on the shop floor.
• ScheduledEndDate: string (date-time)
  Read Only: true

  Date when the work order is scheduled to complete.
• ScheduledStartDate: string (date-time)
  Read Only: true

  Date when the work order is scheduled to start.
• ScrappedQuantity: number
  Read Only: true

  Total scrapped quantity across all operations for the work order.
• SelectedForReleaseFlag: boolean
  Read Only: true

  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)
  Read Only: true

  Value that uniquely identifies the supply plan for planned order supplies.
• 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.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the primary product.
• WorkDefinitionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work definition.
• WorkDefinitionVersionNumber: string
  Read Only: true

  Maximum Length: 10

  Value that indicates the version of the work definition.
• 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 that uniquely identifies the work order.
• WorkOrderPriority: number
  Read Only: true

  Value that indicates the value of the work order.
• WorkOrderStatus: string
  Read Only: true

  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
  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.
• WorkOrderType: string
  Read Only: true

  Maximum Length: 30

  Type of work order. Valid vales include Production, Maintenance, or EAM work order.
• 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.

{
    "type":"object",
    "properties":{
        "ActualEndDate":{
            "type":"string",
            "description":"Date and time when the work order operation is no longer effective.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualStartDate":{
            "type":"string",
            "description":"Date and time when the work order operation is actually effective.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AggregatedFlowScheduleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the aggregate flow schedule. This attribute is read only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset charge. This attribute is read only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValues":{
            "maxLength":4000,
            "type":"string",
            "description":"Attribute values associated with a work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BuildSequence":{
            "type":"number",
            "description":"Sequence or order of flow schedules based on which manufacturing activity's carried out on the shop floor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedQuantity":{
            "type":"number",
            "description":"Quantity of primary product completed so far in the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"Quantity of primary product completed so far in the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarliestStartDate":{
            "type":"string",
            "description":"Description of the production schedule.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmPlannedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Date when the work order operation can be requested at the earliest.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":500,
            "type":"string",
            "description":"Description of the item that's produced by the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaintenanceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the maintenance organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaintenanceResourceCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the maintenance resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaintenanceResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the maintenance resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaintenanceWorkCenterCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the maintenance work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaintenanceWorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the maintenance work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaterialAvailable":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NettablePlannedQuantity":{
            "type":"number",
            "description":"Planned start quantity of the work order, after taking into account the cumulative yield factor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NettableRemainingQuantity":{
            "type":"number",
            "description":"Remaining quantity of the work order, after taking into account the completions, scrap, and cumulative yield factor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OnHoldFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderClass":{
            "maxLength":20,
            "type":"string",
            "description":"Class of the work order. Valid values include HotOrder, Committed, and Uncommitted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeggedDemands":{
            "maxLength":4000,
            "type":"string",
            "description":"Demands and customers pegged to a work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedStartQuantity":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryProductQuantity":{
            "type":"number",
            "description":"Quantity planned to be produced for the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryProductRemainingQuantity":{
            "type":"number",
            "description":"Quantity remaining to be produced for the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductionLineCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the production line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductionLineName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the production line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductionLineRate":{
            "type":"number",
            "description":"Rate at which production should progress per hour on a specific production line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RejectedQuantity":{
            "type":"number",
            "description":"Total rejected quantity across all operations for the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RemainingQuantity":{
            "type":"number",
            "description":"Quantity that's remaining.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedDate":{
            "type":"string",
            "description":"Date when the work order operation is requested.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RescheduledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReservedQuantity":{
            "type":"number",
            "description":"The total quantity of demands reserved to the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoutingCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the work definition for this work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledBuildSequence":{
            "type":"number",
            "description":"The scheduled sequence or order of flow schedules based on which manufacturing activity's carried out on the shop floor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledEndDate":{
            "type":"string",
            "description":"Date when the work order is scheduled to complete.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledStartDate":{
            "type":"string",
            "description":"Date when the work order is scheduled to start.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScrappedQuantity":{
            "type":"number",
            "description":"Total scrapped quantity across all operations for the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SelectedForReleaseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the serial that the asset references. This attributes is applied when the item is serial controlled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyPlanSupplyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply plan for planned order supplies.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Date when the work order is targeted to be scheduled. This attribute overrides the need-by date of the work order.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the primary product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionVersionNumber":{
            "maxLength":10,
            "type":"string",
            "description":"Value that indicates the version of the work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the user key to the work method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work method for which this work definition is applicable.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkMethodName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the work method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order. It's a primary key of the work order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderPriority":{
            "type":"number",
            "description":"Value that indicates the value of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Value the indicates the status of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderStatusName":{
            "maxLength":120,
            "type":"string",
            "description":"The work order status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderSubTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the subtype of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderSubTypeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the work order subtype.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of work order. Valid vales include Production, Maintenance, or EAM work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderTypeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the work order type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top