1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Maintenance
  4. Maintenance Work Orders

Get one work order

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}

Request

Path Parameters
  • Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order number when the application creates the work order.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : maintenanceWorkOrders-item-response
Type: object
Show Source
  • Title: Actual Completion Date
    Date when the work order actually completes. This attribute is read-only. The value of this attribute is set when the status of the work order is moved to completed.
  • Title: Actual Start Date
    Date when the work order actually starts. This attribute is read-only. The value of this attribute is set when the first transaction is performed against the work order.
  • Title: Allow completion to inventory
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the work order completes the work order assets to inventory. If false, then the work order does not complete the work order assets to inventory. The default value is false. This value can be updated when the work order is in unreleased status.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the work order can be associated with more than one asset. If false, then the work order can be associated with only one asset. The default value is false. This value cannot be updated in the work order.
  • Title: Allow out of sequence completion
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the work order operations can be completed out of sequence. If false, then the work order operations are completed in sequence. The default value is false. This value can be updated when the work order is in an unreleased status.
  • Read Only: true
    Description of an asset. The value is read only.
  • Value that uniquely identifies the asset on which the work order is performed. You must provide either the asset identifier or the asset number to create a single asset maintenance work order. When the value for "AllowMultipleAssetsFlag" is false it is a single asset maintenance work order. When the value for "AllowMultipleAssetsFlag" is true then either Item identifier or ItemNumber requires a value.
  • Number that uniquely identifies the asset on which the work order is performed. You must provide either the asset identifier or the asset number to create a single asset maintenance work order. When the value for "AllowMultipleAssetsFlag" is false it is a single asset maintenance work order. When the value for "AllowMultipleAssetsFlag" is true then either Item identifier or ItemNumber requires a value.
  • Attachments
    Title: Attachments
    The Attachments resource is used to view, create, and update attachments.
  • Title: Canceled Reason
    Maximum Length: 240
    Value that indicates the reason for which a work order is canceled. The reason for cancelation is required when the work order is moved to the canceled status. It is updatable only on canceled work orders.
  • Title: Closed Date
    Date when the work order is closed. You can optionally provide the work order closed date when closing a work order. The default value is the system date.
  • Completion locator to use, by default, during completion of asset to inventory. Applicable only if the work order has AllowCompletionToInventoryFlag as true.
  • Title: Completion Locator
    Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.
  • Title: Completion Subinventory
    Maximum Length: 10
    Completion subinventory to use, by default, during completion of asset to inventory. Applicable only if the work order has AllowCompletionToInventoryFlag as true.
  • Read Only: true
    Completion locator to use, by default, when the asset is rejected during completion of the asset to inventory. Applicable only if the work order has AllowCompletionToInventoryFlag as true.
  • Read Only: true
    Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.
  • Read Only: true
    Rejection subinventory to use, by default, when the asset is rejected during completion of asset to inventory. Applicable only if the work order has AllowCompletionToInventoryFlag as true.
  • Document References
    Title: Document References
    The Document References resource manages the documents that are referenced in the work order.
  • Default Value: false
    Contains one of the following values: Y or N. If Y, then the work order is exploded or re-exploded based on the work definition. If N, then the work order is not created based on the work definition; however, if the work definition code attribute has a value, this attribute is referenced in the work order. The default value is Y.
  • Title: Firm
    Maximum Length: 1
    Default Value: false
    Value that specifies during rescheduling/replanning ,the work order is to be considered. Contains one of the following values: true or false. If true, then planning does not consider the work order when rescheduling or re-planning. If false, then planning can suggest rescheduling and re-planning recommendations with respect to the work order. The default value is false.
  • Title: Include in planning
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work order is considered for inventory planning processes. If false, then the work order isn't considered for inventory planning processes. The default value is false. This value can be updated until the work order is completed.
  • Title: Item
    Value that uniquely identifies the item that the work order asset references. Item number is required for creating multiple asset maintenance work orders. When the value for "AllowMultipleAssetsFlag" is true then it is a required field. Either item identifier or ItemNumber requires a value. When the value for "AllowMultipleAssetsFlag" is false then it is derived from asset reference value.
  • Number that uniquely identifies the item that the work order asset references. Item number is required for creating multiple asset maintenance work orders. When the value for "AllowMultipleAssetsFlag" is true then it is a required field. Either InventoryItemId or ItemNumber requires a value. When the value for "AllowMultipleAssetsFlag" is false then it is derived from asset reference value.
  • Read Only: true
    Number that identifies the last count point operation sequence in a work order.
  • Links
  • Read Only: true
    Maximum Length: 1
    Indicates if the item is locator controlled. Values are true or false.
  • Read Only: true
    Lot number of the asset associated to the work order. The value is conditionally referenced in the asset based on the attributes of the item associated to the work order asset.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the maintenance program. The value is read only.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the maintenance program. The value is read only.
  • Read Only: true
    Value that uniquely identifies the maintenance program that is the source of the work order. The value is read only.
  • Title: Maintenance Program
    Read Only: true
    Maximum Length: 120
    Name of the maintenance program. The value is read only.
  • Title: Match Transaction Codes
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then only those material and resource transactions that have a matching repair transaction code in an active warranty contract are considered for creating a warranty entitlement. If false, then entitlements are created for all material and resource transactions. This attribute has a default value of false.
  • Abbreviation that identifies the maintenance work definition applicable to the work order. You must provide either the work definition code or the work definition identifier to create a maintenance work order. It is used to create the operation, resource and material details of the work order. If the work definition is updated then all the work order operations details are refreshed based on the new work definition.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of a work definition. This attribute is read-only.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of a work definition. This attribute is read-only.
  • Maximum Length: 255
    Abbreviation that identifies the maintenance organization in which the work order is executed. You must provide either the organization identifier or the organization code to create a work order. This attribute is not updatable.
  • Value that uniquely identifies the maintenance organization in which the work order is executed. You must provide either the organization identifier or the organization code to create a work order. This attribute is not updatable.
  • Title: Project Number
    Maximum Length: 25
    Number that identifies the project.
  • Title: Task Number
    Maximum Length: 100
    Number that identifies the task.
  • Title: Completion Date
    Date when the work order is scheduled to complete. You must provide either the planned start date or the planned completion date to create the work order. The default value is the system date.
  • Title: Start Date
    Date when the work order is scheduled to start. You must provide either the planned start date or the planned completion date to create the work order. The default value is the system date.
  • Title: Quantity
    Planned maintenance work order quantity. When the value for AllowMultipleAssetsFlag is false, it's a single asset maintenance work order and the value is derived from the asset quantity. When the value for AllowMultipleAssetsFlag is true, then the multiple asset work order and value is required at the time of work order creation along with item information.
  • Title: Primary Reason for Repair
    Read Only: true
    Maximum Length: 240
    Meaning of the primary reason for the repair code.
  • Title: Primary Reason for Repair Code
    Maximum Length: 30
    Abbreviation that identifies the primary reason for repair of the maintenance work order asset. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Flexfields for Project Details
    Title: Flexfields for Project Details
    The Flexfields for Project Details resource manages descriptive flexfields that contain details about the project.
  • Title: Released Date
    Date when the work order is released. You can optionally provide the work order released date when releasing a work order or update the date for a released work order. The default value is the system date.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work order has at least one resequenceable operation. If false, then the work order doesn't have any resequenceable operation. This attribute is automatically set based on the availability of the resequenceable operation.
  • Read Only: true
    Maximum Length: 255
    Value that specifies the description for the scheduling method that the application uses to schedule the work order.
  • Title: Scheduling Method
    Maximum Length: 30
    Default Value: DEFAULT_SCHEDULER
    Value that uniquely specifies the method that the application uses to schedule the work order. The list of accepted values is defined in the lookup type ORA_WIE_WO_SCHEDULING_METHOD. The default value is DEFAULT_SCHEDULER.
  • Read Only: true
    Serial number of an asset. The value is read only.
  • Title: Source Header Reference
    Read Only: true
    Maximum Length: 240
    Reference to the work order header in the source system.
  • Read Only: true
    Value that uniquely identifies the work order header in the source system.
  • Title: Source Line Reference
    Read Only: true
    Maximum Length: 240
    Reference to the work order line in the source system.
  • Read Only: true
    Value that uniquely identifies the work order line in the source system.
  • Maximum Length: 255
    Abbreviation that uniquely identifies the source system in which the work order is executed.
  • Title: Source System
    Value that uniquely identifies the source system.
  • Title: Source System Type
    Maximum Length: 30
    Type of source system. Values include INTERNAL or EXTERNAL.
  • Default Value: SUCCESS
    Name of the work order status.
  • Read Only: true
    Maximum Length: 240
    Description of the target item number associated to the work order. This is read-only attribute.
  • Title: Target Item
    Value that uniquely identifies the item that will be used work order asset transformation. The target item is applicable for both single asset and multiple asset maintenance work orders, however it's optional attribute. If a work order has a value for target item, then it's for asset transformation and when the work order is completed the asset will be updated with the target item.
  • Maximum Length: 300
    Number that uniquely identifies the item that will be used work order asset transformation. The target item is applicable for both single asset and multiple asset maintenance work orders, however it's optional attribute. If a work order has a value for target item, then it's for asset transformation and when the work order is completed the asset will be updated with the target item.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work order is considered as transform order. If false, then the work order isn't a transform order. This is a derived value and can't be updated.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that identifies the primary unit of measure (UOM) of the work order item.
  • Title: Warranty Repair
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work order is considered for warranty entitlement creation and claim review. If false, then the work order isn't considered for warranty entitlement creation and claim review. This attribute has a default value of false.
  • Read Only: true
    Unique identifier of the maintenance work definition names record.
  • Read Only: true
    Value that uniquely identifies the asset on which the work order is performed. You must provide either the asset identifier or the asset number to create a single asset maintenance work order. When the value for "AllowMultipleAssetsFlag" is false it is a single asset maintenance work order. When the value for "AllowMultipleAssetsFlag" is true then either Item identifier or ItemNumber requires a value.
  • Title: Date
    As-of reference date used to determine the work definition version. It is optional to provide the work definition as-of date. If it is not provided the work order start date is used. If the start date is not provided then the planned completion date is used. If the selected date is in the past then the system date is used. You can update the work definition as-of date only on unreleased work orders. If updated then the operation details are refreshed according to the work definition version. If provided during work order creation, the system date is used by default.
  • Title: Work Definition
    Value that uniquely identifies the maintenance work definition applicable to the work order. You must provide either the work definition code or the work definition identifier to create a maintenance work order. It is used to create the operation, resource, and material details of the work order. If the work definition is updated then all the work order operations details are updated based on the new work definition.
  • Title: Version
    Read Only: true
    Maximum Length: 10
    Version of a work definition. This attribute is read-only.
  • Title: Version
    Value that uniquely identifies the maintenance work definition version. This attribute is optional. If the value is not provided, it is derived from the work definition and the work definition as-of date.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the method that the work order uses. This attribute is read-only. The value of this attribute is derived from the context of work order creation. The work method value for maintenance work orders is MAINTENANCE.
  • Assets
    Title: Assets
    The assets that a multiple asset work order requires.
  • Read Only: true
    Value that uniquely identifies the asset on which the work order is performed. You must provide either the asset identifier or the asset number to create a single asset maintenance work order. When the value for "AllowMultipleAssetsFlag" is false it is a single asset maintenance work order. When the value for "AllowMultipleAssetsFlag" is true then either Item identifier or ItemNumber requires a value.
  • Title: Description
    Maximum Length: 240
    Description of the work order. This is the text entered by the user, which briefly describes the work to be performed. This attribute is optional to create a work order.
  • Flexfields for Work Orders
    Title: Flexfields for Work Orders
    The Flexfields for Work Orders resource manages the descriptive flexfields that the work order references.
  • Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order number when the application creates the work order.
  • Title: Work Order
    Maximum Length: 120
    Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
  • Operations
    Title: Operations
    The Operations for Maintenance Work Orders resource manages the maintenance operations that the work order requires.
  • Title: Priority
    Number that indicates the priority of the work order. This attribute is optional to create the work order.
  • Title: Work Order Status
    Read Only: true
    Maximum Length: 120
    Meaning of the work order status code. The value is read only.
  • Maximum Length: 255
    Abbreviation that identifies the work order status code. The list of valid values is defined in the WIE_WO_STATUSES_B table. It's optional to provide the work order status code at the time of work order creation. Valid values at creation are ORA_UNRELEASED, ORA_RELEASED, and ORA_ON_HOLD. The default value is ORA_UNRELEASED.
  • Title: Status
    Value that uniquely identifies the work order status.
  • Title: Work Order Subtype
    Read Only: true
    Maximum Length: 80
    Meaning of the work order subtype code. The value is read only.
  • Title: Subtype
    Maximum Length: 30
    Abbreviation that uniquely identifies the work order subtype. The list of accepted values is defined in lookup type ORA_MNT_WO_SUB_TYPE. The work order subtype is required to create the work order. If the work order subtype is not provided, the asset work order subtype is used by default.
  • Title: Work Order Type
    Read Only: true
    Maximum Length: 80
    Meaning of the work order type code. The value is read only.
  • Title: Type
    Maximum Length: 30
    Abbreviation that uniquely identifies the work order type. Valid values include CORRECTIVE or PREVENTIVE. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. The work order type is required to create the work order. If the work order type is not provided, the asset work order type is used by default.
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Document References
Type: array
Title: Document References
The Document References resource manages the documents that are referenced in the work order.
Show Source
Nested Schema : Flexfields for Project Details
Type: array
Title: Flexfields for Project Details
The Flexfields for Project Details resource manages descriptive flexfields that contain details about the project.
Show Source
Nested Schema : Assets
Type: array
Title: Assets
The assets that a multiple asset work order requires.
Show Source
Nested Schema : Flexfields for Work Orders
Type: array
Title: Flexfields for Work Orders
The Flexfields for Work Orders resource manages the descriptive flexfields that the work order references.
Show Source
Nested Schema : Operations
Type: array
Title: Operations
The Operations for Maintenance Work Orders resource manages the maintenance operations that the work order requires.
Show Source
Nested Schema : maintenanceWorkOrders-attachments-item-response
Type: object
Show Source
Nested Schema : maintenanceWorkOrders-documentReference-item-response
Type: object
Show Source
Nested Schema : maintenanceWorkOrders-ProjectDetailsDFF-item-response
Type: object
Show Source
  • Title: Context Value
    Read Only: true
    Maximum Length: 40
    Default Value: OM_Sales_Order
    Descriptive flexfield context name for project details.
  • Title: Context Value
    Descriptive flexfield context display value for project details.
  • Links
  • Value that uniquely identifies the project detail used by the work order. It is a primary key that the application generates when it creates the work order.
Nested Schema : maintenanceWorkOrders-WorkOrderAsset-item-response
Type: object
Show Source
  • Value that uniquely identifies the asset associated to the maintenance work order. When the value for "AllowMultipleAssetsFlag" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.
  • Number that uniquely identifies the asset associated to the maintenance work order. When the value for "AllowMultipleAssetsFlag" is True it is a multiple asset maintenance work order. For a multiple asset work order the child resource is used for managing assets associated to the work order when the work order is in unreleased status. When the work order status is other than unreleased the assets in the work order cannot be updated or deleted.
  • Read Only: true
    Value that uniquely identifies the item referenced in the work order asset. This attribute is read-only.
  • Links
  • Read Only: true
    Maximum Length: 80
    The lot number of the asset associated to the work order. The value is conditionally referenced in the asset based on the attributes of the item associated to the work order asset.
  • Title: Match Transaction Codes
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then only those material and resource transactions that have a matching repair transaction code in an active warranty contract are considered for creating a warranty entitlement. If false, then entitlements are created for all material and resource transactions. This attribute has a default value of false.
  • Identifier of the organization associated to the respective work order assets. This attribute is read-only.
  • Title: Primary Reason for Repair
    Read Only: true
    Maximum Length: 240
    Meaning of the primary reason for the repair code. This attribute is read-only.
  • Title: Primary Reason for Repair Code
    Maximum Length: 30
    Abbreviation that identifies the primary reason for repair of the maintenance work order asset. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Read Only: true
    Asset quantity and is read-only. The value is derived from the respective work order asset.
  • Read Only: true
    Maximum Length: 80
    The serial number of the asset associated to the work order. The value is conditionally referenced in the asset based on the attributes of the item associated to the work order asset.
  • Read Only: true
    Maximum Length: 3
    The primary unit of measure of the item associated to the asset in context.
  • Title: Warranty Repair
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work order is considered for warranty entitlement creation and claim review. If false, then the work order isn't considered for warranty entitlement creation and claim review. This attribute has a default value of false.
  • Value that uniquely identifies the asset association to the maintenance work order . This attribute is read-only. The value is generated when the asset is added to the work order.
  • Value that uniquely identifies the work order to which the asset is associated. This attribute is read-only.
Nested Schema : maintenanceWorkOrders-WorkOrderDFF-item-response
Type: object
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-item-response
Type: object
Show Source
  • Title: Automatically Transact
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then automatically report the operation when the operation occurs on the shop floor. If false, then do not report this operation automatically. If the operation is not significant, it is recommended that you set AutoTransactFlag to true. The Count Point attribute and the Automatically Transact attribute are mutually exclusive. You must make sure that each of these attributes do not both contain true. If Count Point and Automatically Transact each contain false, then the operation is optional. Note that the user can manually report component usage and resource usage for an optional operation. The default value is false.
  • Title: Count Point
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then make this operation a count point operation. If an operation occurs on the shop floor, the user must manually report it in the application when the operation occurs. If false, then do not make this operation a count point operation. the user does not need to report the operation. It is recommended that you configure each work order so that it includes at least one count point operation, and to make sure that the last operation that the work order performs is a count point operation. The default value is true.
  • Read Only: true
    Number that indicates the execution sequence of operations when the work order allows resequencing. It's a read-only value. This attribute is associated with a feature that requires opt in.
  • Title: Fixed
    Value that indicates a fixed lead time necessary to perform the supplier operation outside processing (OSP) item quantity. This attribute is optional to create a supplier operation.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that uniquely identifies the lead times unit of measure applicable to the supplier operation. This attribute is optional to create a supplier operation.
  • Links
  • Title: Description
    Maximum Length: 240
    Description of the operation to be performed during the work order execution. The operation description is optional to create the work order operation.
  • Title: Name
    Maximum Length: 120
    Name of the work order operation. The operation name is required to create an operation.
  • Title: Sequence
    Number that identifies the sequence to use when performing the work order operations. The operation sequence is required to create an operation. It must be a positive integer. Its value must be unique within the work order operations. If it is not provided, the last operation sequence incremented by 10 is used as sequence to create an operation.
  • Title: Operation Type
    Maximum Length: 30
    Default Value: IN_HOUSE
    Abbreviation that identifies the operation type. Valid values include IN_HOUSE or SUPPLIER. A list of accepted values is defined in the lookup type ORA_WIS_OPERATION_TYPE. The operation type is required to create the work order. The default value is IN_HOUSE.
  • Read Only: true
    Maximum Length: 255
    Description of the operation type. This attribute is read-only. The value of this attribute is derived from the operation type.
  • Value that uniquely identifies the organization where the operation is performed. This attribute is read-only. The value of this attribute is derived from the work order organization.
  • Read Only: true
    Maximum Length: 255
    Description of the outside processing (OSP) item. This attribute is read-only. The value of this attribute is derived from the outside processing item identifier.
  • Title: Outside Processing Item
    Value that uniquely identifies the outside processing (OSP) item representing the supplier operation. This attribute is required to create the supplier operation.
  • Maximum Length: 255
    Number that identifies the outside processing (OSP) item representing the supplier operation. This attribute is required to create the supplier operation.
  • Title: Completion Date
    Date when the operation is planned to finish. The date is set by the scheduling application. The planned completion date must not occur before the start date of the work order or after the finish date of the work order. This attribute is required. The default value is the work order planned end date.
  • Title: Start Date
    Date when the operation is planned to start. The scheduling application sets this date. The planned start date must not occur before the start date of the work order or after the finish date of the work order. This attribute is required it is defaulted to the work order planned start date if not provided.
  • Maximum Length: 255
    Abbreviation that identifies the reason for repair of the maintenance work order operation. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the reason for the repair code.
  • Maximum Length: 255
    Abbreviation that identifies the repair transaction for the maintenance work order operation. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Repair Transaction.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the repair transaction code.
  • Title: Allow Resequencing
    Maximum Length: 1
    Contains one of the following values: TRUE or FALSE. If TRUE, then the operation can be completed in different sequence. If FALSE, then the operation is completed in the defined sequence. If no value is provided for this attribute, the default value is FALSE.
  • Title: Generate shipment
    Maximum Length: 1
    Contains one of the following values: TRUE or FALSE. If TRUE, then shipping documents are generated. If FALSE, then shipping documents are not generated. If no value is provided for this attribute, the default value is based on the Shippable attribute of the Outside Processing(OSP) item. If Shippable is YES then the default value is TRUE.
  • Maximum Length: 255
    Abbreviation that identifies the operation.
  • Value that uniquely identifies the standard operation that the work order references. It is optional to provide a standard operation to create a work order operation. If provided the other operation attributes are inherited from the standard operation.
  • Maximum Length: 255
    Name of the standard operation that the work order operation references. This is a read-only attribute derived from the standard operation identifier.
  • Value that uniquely identifies the supplier performing the operation. This attribute is required if the operation is a supplier operation.
  • Maximum Length: 255
    Name of the supplier performing the operation. This attribute is read-only. The value of this attribute is derived from the supplier identifier.
  • Maximum Length: 255
    Abbreviation that identifies the supplier site where the operation is performed. This attribute is required if the operation is a supplier operation.
  • Value that uniquely identifies the supplier site where the operation is performed. This attribute is required if the operation is a supplier operation.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure of the quantities for the operation. This attribute is read-only. The value of this attribute is derived from the operation unit of measure code.
  • Title: UOM Code
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure (UOM) of the operation quantity.
  • Title: Variable
    Value that indicates the lead time necessary to perform the supplier operation for each unit of the outside processing (OSP) item. This attribute is optional to create a supplier operation.
  • Value that uniquely identifies the maintenance work definition operation from which the work order operation was created. This attribute is read-only. The value of this attribute is derived from the work definition.
  • Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the work order operation.
  • Maximum Length: 255
    Abbreviation that identifies the work accomplished against the maintenance work order operation. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the work accomplished code.
  • Read Only: true
    Value that uniquely identifies the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Maximum Length: 255
    Abbreviation that uniquely identifies the work center in which the operation is performed. You must provide either the work center identifier or the work center code to create an in-house work order operation.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the work center identifier.
  • Title: Work Center
    Value that uniquely identifies the work center in which the operation is performed. You must provide either the work center identifier or the work center code to create an in-house work order operation.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the work center identifier.
  • Read Only: true
    Value that uniquely identifies the maintenance work definition applicable to the work order. This attribute is read-only. The value of this attribute is derived from the work order.
  • Value that uniquely identifies the work order to which the operation belongs. This attribute is read-only.
  • Title: Work Order
    Read Only: true
    Maximum Length: 120
    Number that identifies the work order to which the operation belongs. This attribute is read-only. The value of this attribute is derived from the work order identifier.
  • Flexfields for Operations
    Title: Flexfields for Operations
    The Flexfields for Operations resource manages descriptive flexfields that each work order operation references.
  • Materials
    Title: Materials
    The Materials for Maintenance Work Orders resource manages the materials that the work order requires to perform a maintenance operation.
  • Resources
    Title: Resources
    The Resources for Maintenance Work Orders resource manages the resources that the work order requires to perform a maintenance operation.
Nested Schema : Flexfields for Operations
Type: array
Title: Flexfields for Operations
The Flexfields for Operations resource manages descriptive flexfields that each work order operation references.
Show Source
Nested Schema : Materials
Type: array
Title: Materials
The Materials for Maintenance Work Orders resource manages the materials that the work order requires to perform a maintenance operation.
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The Resources for Maintenance Work Orders resource manages the resources that the work order requires to perform a maintenance operation.
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationDFF-item-response
Type: object
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-item-response
Type: object
Show Source
  • Title: Allocated Quantity
    Quantity of material allocated during the picking process when a movement request is created for a work order operation item.
  • Title: Basis
    Maximum Length: 30
    Value that indicates whether the material quantity is fixed (for example, quantity per lot produced) or variable (for example, quantity per item produced). A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE. The default value is variable.
  • Title: Include in planning
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then planning considers the material when it plans the supply. If false, then planning does not consider the material when it plans the supply. The default value is true.
  • Value that uniquely identifies the material component item to issue to the work order. You must provide either the item number or the item identifier to create a work order operation material.
  • Maximum Length: 255
    Number that uniquely identifies the material component item to issue to the work order. You must provide either the item number or the item identifier to create a work order operation material.
  • Title: Issued Quantity
    Net quantity of the material issued to the operation.
  • Read Only: true
    Maximum Length: 300
    Number that identifies the material component item to issue to the work order. You must provide either the item number or the item identifier to create a work order operation material.
  • Links
  • Title: Sequence
    Number that identifies the sequence of the material component assigned to the work order operation. The sequence is required to create an operation material. The last operation material sequence incremented by 10 is used as sequence to create an operation material.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation to which the operation material belongs. This attribute is read-only. The value of this attribute is derived from the work order operation.
  • Title: Operation Sequence
    Read Only: true
    Number that identifies the sequence to use when performing the work order operations to which the operation material belongs. This attribute is read-only. The value of this attribute is derived from the work order operation.
  • Title: Picked Quantity
    Quantity of material picked when the pick slip is confirmed and is issued either directly to the work order or is moved to the supply subinventory for a work order operation item.
  • Quantity that the work order creates. This attribute is not applicable to maintenance work orders.
  • Title: Quantity per Product
    Material component quantity required to complete the work order operation per asset. It's a required attribute to create an operation material. The value of the RequiredQuantity attribute is calculated based on this value and the option chosen for basis type.
  • Maximum Length: 255
    Abbreviation that identifies the reason for repair of the maintenance work order operation material. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Meaning of the repair transaction code.
  • Title: Required Date
    Date when the plant requires the materials so it can perform the operation. This attribute is required. The default value is the operation start date. The required date must not occur before the operation start date, or after the operation completion date.
  • Title: Required Quantity
    Read Only: true
    Required component quantity. The value ia derived based on the value of Basis Type and Quantity attributes. This attribute is read-only.
  • Title: Reserved Quantity
    Quantity of material that is reserved for a work order operation item.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation the operation is referring to. This attribute is read-only. The value of this attribute is derived from the operation.
  • Read Only: true
    Value that uniquely identifies the standard operation the operation is referring to. This attribute is read-only. The value of this attribute is derived from the operation.
  • Read Only: true
    Maximum Length: 255
    Name of the supply locator from where the material component item is issued. This attribute is read-only. The value of this attribute is derived from the supply locator identifier.
  • Title: Supply Locator
    Value that uniquely identifies the supply subinventory locator from where the material is issued during an assembly or operation pull. The default value is the component item definition or the plant parameters.
  • Title: Supply Subinventory
    Maximum Length: 20
    Supply subinventory from where the material is issued during an assembly or operation pull. The default value is the component item definition or the plant parameters.
  • Title: Supply Type
    Maximum Length: 30
    Type of consumption of the material component. Valid values include 1: Push, 2: Assembly pull, 3: Operation pull, 4: Bulk, and 5: Supplier. This attribute is required to create an operation material. If the supply type is not provided the default value is material component item. If the work order was created with a work definition then the default value is based on the work definition.
  • Read Only: true
    Maximum Length: 80
    Description of the operation material supply type. This attribute is read-only. The value of this attribute is derived from the supply type code.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure of the material component quantity to be issued. It is the primary unit of measure of the item. This attribute is read-only. The value of this attribute is derived from the material component item.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure (UOM) of the operation material quantity.
  • Value that uniquely identifies the material for work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the operation material.
  • Read Only: true
    Value that uniquely identifies the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Read Only: true
    Value that uniquely identifies the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation.
  • Value that uniquely identifies the work order to which the operation material belongs. This attribute is read-only. The value of this attribute is derived from the work order.
  • Flexfields for Operation Materials
    Title: Flexfields for Operation Materials
    The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes.
Nested Schema : Flexfields for Operation Materials
Type: array
Title: Flexfields for Operation Materials
The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes.
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-WorkOrderOperationMaterialDFF-item-response
Type: object
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-item-response
Type: object
Show Source
  • Title: Assigned Units
    Default Value: 1
    Number of resource units required to perform the operation.
  • Title: Basis
    Maximum Length: 30
    Default Value: 1
    Contains one of the following values: 1 or 2. If 1, then the resource consumption is fixed. It does not change according to work order quantity. If 2, then the resource consumption is not fixed. It might change according to work order quantity. The default value is 2. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE. For maintenance work orders the work order quantity is always one.
  • Title: Charge Type
    Maximum Length: 30
    Abbreviation that identifies how the resource is charged. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE. The charge type is required. Valid values include MANUAL or AUTOMATIC. For a count point operation, the value must be AUTOMATIC for automatic transact operations and MANUAL for optional operations.
  • Maximum Length: 255
    Abbreviation that uniquely identifies the qualification profile. Values are predefined and created for equipment qualifications. This attribute is applicable only for equipment type resources. When it's specified, only those equipment resource instances that meet the qualifications can be reported for resource transactions. It's a non-mandatory attribute for a work order operation resource.
  • Title: Equipment Profile
    Value that uniquely identifies the qualification profile. Values are predefined and created for equipment qualifications. This attribute is applicable only for equipment type resources. When it's specified, only those equipment resource instances that meet the qualifications can be reported for resource transactions. It's a non-mandatory attribute for a work order operation resource.
  • Links
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation to which the operation resource belongs. This attribute is read-only. The value of this attribute is derived from the work order operation.
  • Title: Operation Sequence
    Read Only: true
    Number that identifies the sequence to use when performing the work order operations to which the operation resource belongs. This attribute is read-only. The value of this attribute is derived from the work order operation.
  • Value that uniquely identifies the organization where the operation is performed. This attribute is read-only. The value of this attribute is derived from the work order organization.
  • Title: Completion Date
    Date when the resource is planned to finish. The scheduling application sets this date. The planned completion date must not occur before the operation start date or after the operation finish date. This attribute is required. The default value is the operation end date.
  • Title: Start Date
    Date when the resource is planned to start. The scheduling application sets this date. The planned start date must not occur before the operation start date or after the operation finish date. This attribute is required. The default value is the operation start date.
  • Title: Principal
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then this resource is the principal resource among the group of simultaneous resources. If false, then this resource is not the principal resource. Note that one of the simultaneous resources must be a principal resource. The default value is false.
  • Maximum Length: 255
    Indicates the skills and qualifications that make up the resource's job profile. The lookup value is taken from the employee's human resource talent profile and must be a valid and active PROFILE_CODE.
  • Value that uniquely identifies the work order operation resource's job profile. The application generates this key value.
  • Maximum Length: 255
    Abbreviation that identifies the reason for repair of the maintenance work order operation resource. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the reason for the repair code.
  • Maximum Length: 255
    Abbreviation that identifies the repair transaction for the maintenance work order operation resource. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Repair Transaction.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the repair transaction code.
  • Title: Required Usage
    Resource usage that the plant requires to make the required work order quantity. The application calculates this value depending on whether the basis type is fixed or variable. Fixed: the required usage equals the usage rate. Variable: the required usage is the product of the usage rate and the work order quantity. For maintenance work orders the work order quantity is always one.
  • Maximum Length: 255
    Abbreviation that identifies the resource assigned to the work order operation. You must provide either the resource identifier or the resource code to create an operation resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the operation of the resource assigned to the work order operation such as labor or equipment. This attribute is read-only. The value of this attribute is derived from the resource.
  • Value that uniquely identifies the resource assigned to the work order operation. You must provide either the resource identifier or the resource code to create a work order operation resource.
  • Title: Sequence
    Number that indicates the unique sequence of the resource assigned to the work order operation. The sequence is required to create an operation resource. The resource sequence number can be same for more than one resource and they are called simultaneous resources. For simultaneous resources one of the resources must be a principal resource. When principal resource has scheduled = YES, then other resources have schedule = YES or NO, but when principal resource has scheduled = NO, other resources should have scheduled = NO.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of the resource assigned to the work order operation such as labor or equipment. This attribute is read-only. The value of this attribute is derived from the resource.
  • Title: Scheduled
    Read Only: true
    Maximum Length: 30
    This attribute is not currently used for Oracle Maintenance Cloud. You must use the ScheduledIndicator attribute instead.
  • 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 does not schedule the resource and it sets the start date equal to the completion date. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_SCHEDULE. The default value is YES.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation the operation is referring to. This attribute is read-only. The value of this attribute is derived from the operation.
  • Read Only: true
    Value that uniquely identifies the standard operation the operation is referring to. This attribute is read-only. The value of this attribute is derived from the operation.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure of the resource consumption. This attribute is read-only. The value of this attribute is derived from the resource.
  • Title: Usage Rate
    Resource usage rate that the plant requires to make the required work order quantity. The resource usage rate is used to calculate the required usage based on the basis type and the work order quantity. For maintenance work orders the work order quantity is always one.
  • Value that uniquely identifies the work order operation. This is a prepopulated row. This attribute is read-only. The value of this attribute is derived from the work order operation.
  • Read Only: true
    Value that uniquely identifies the work order operation resource. It is a primary key that the application generates when it creates the work order operation resource.
  • Maximum Length: 255
    Abbreviation that identifies the work accomplished against the maintenance work order operation resource. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the work accomplished code.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Read Only: true
    Value that uniquely identifies the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the work center identifier.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation.
  • Read Only: true
    Value that uniquely identifies the work order to which the operation resource belongs. This attribute is read-only. The value of this attribute is derived from the work order.
  • Flexfields for Resources
    Title: Flexfields for Resources
    The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.
  • Resource Instances
    Title: Resource Instances
    The Resource Instances for Maintenance Work Orders resource manages the resource instances that the work order requires to perform a maintenance operation.
Nested Schema : Flexfields for Resources
Type: array
Title: Flexfields for Resources
The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.
Show Source
Nested Schema : Resource Instances
Type: array
Title: Resource Instances
The Resource Instances for Maintenance Work Orders resource manages the resource instances that the work order requires to perform a maintenance operation.
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceDFF-item-response
Type: object
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-item-response
Type: object
Show Source
  • Maximum Length: 255
    Abbreviation that identifies the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
  • Value that uniquely identifies the equipment resource instance assigned to the operation resource. You must provide either the equipment resource identifier or a labor resource identifier to create an operation resource instance.
  • Title: Identifier
    Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
  • Maximum Length: 255
    Abbreviation that identifies the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the labor instance identifier.
  • Value that uniquely identifies the labor resource instance assigned to the operation resource. You must provide either the equipment resource identifier or a labor resource identifier to create an operation resource instance.
  • Title: Identifier
    Read Only: true
    Maximum Length: 30
    Value that uniquely identifies the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the labor instance identifier.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    Name of the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
  • Links
  • Value that uniquely identifies the organization in which the work order is performed. This attribute is read-only. The value of this attribute is derived from the work order.
  • Read Only: true
    Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is derived from the operation.
  • Value that uniquely identifies work order resource to which the resource instance is added. The operation resource identifier is required to create an operation resource instance.
  • Value that uniquely identifies the resource instance for the work order operation resource. The value is generated when the resource instance is created. This attribute is read-only.
  • Read Only: true
    Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order.
  • Flexfields for Resource Instances
    Title: Flexfields for Resource Instances
    The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.
Nested Schema : Flexfields for Resource Instances
Type: array
Title: Flexfields for Resource Instances
The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-item-response
Type: object
Show Source
Links
ProjectDetailsDFF
Parameters:
  • WorkOrderId: $request.path.WorkOrderId
The Flexfields for Project Details resource manages descriptive flexfields that contain details about the project.
WorkOrderAsset
Parameters:
  • WorkOrderId: $request.path.WorkOrderId
The assets that a multiple asset work order requires.
WorkOrderDFF
Parameters:
  • WorkOrderId: $request.path.WorkOrderId
The Flexfields for Work Orders resource manages the descriptive flexfields that the work order references.
WorkOrderOperation
Parameters:
  • WorkOrderId: $request.path.WorkOrderId
The Operations for Maintenance Work Orders resource manages the maintenance operations that the work order requires.
attachments
Parameters:
  • WorkOrderId: $request.path.WorkOrderId
The Attachments resource is used to view, create, and update attachments.
documentReference
Parameters:
  • WorkOrderId: $request.path.WorkOrderId
The Document References resource manages the documents that are referenced in the work order.
generateRepairSuggestion
Parameters:
  • WorkOrderId: $request.path.WorkOrderId
Suggests potential solutions for the work order based on similar work orders. Using the problem statement and work order details including the work order asset item, work order type, subtype, and condition event codes, a summary of previously completed or closed work orders with similar attributes will be generated using GenAI.
generateRepairSummaryPromptParams
Parameters:
  • WorkOrderId: $request.path.WorkOrderId
Gathers work order details including the work performed on an asset, and transforms the information into a string that can be sent as a payload to the Generative AI completions REST. The completions REST can then use this payload to assist in authoring a work summary note for the work order.
Back to Top

Examples

This example describes how to get one maintenance work order.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/maintenanceWorkOrders/WorkOrderId"

For example, the following command gets maintenance work order 25447:

curl -u username:password "https://servername/fscmRestApi/resources/version/maintenanceWorkOrders/25447"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "WorkOrderNumber": "M1-1518",
    "WorkOrderId": 25447,
    "WorkOrderDescription": null,
    "OrganizationCode": null,
    "OrganizationId": 207,
    "ItemNumber": "Fork Lift",
    "InventoryItemId": 300100111025244,
    "AssetNumber": "FL Panther",
    "AssetId": 300100111025610,
    "WoAssetId": 9003,
    "WorkOrderTypeCode": "PREVENTIVE",
    "WorkOrderSubTypeCode": "ORA_PLANNED",
    "MntWorkDefinitionCode": "30 Miles Maintenance",
    "WorkDefinitionId": 300100111034240,
    "WorkDefinitionVersionId": 300100111034241,
    "WorkDefinitionAsOfDateMnt": "2017-08-08T00:00:00+00:00",
    "WorkOrderStatusCode": "ORA_UNRELEASED",
    "WorkOrderStatusId": 10005,
    "Status": "SUCCESS",
    "PlannedStartDate": "2017-08-08T00:00:00+00:00",
    "PlannedCompletionDate": "2017-08-08T00:00:00+00:00",
    "ActualStartDate": null,
    "ActualCompletionDate": null,
    "WorkOrderPriority": 1,
    "WorkMethodCode": "MAINTENANCE",
    "CanceledReason": null
 
}
Back to Top