1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Maintenance
  4. Maintenance Programs
  5. Work Requirements

Create one requirement

post

/fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/workRequirements

Request

Path Parameters
  • Value that uniquely identifies a maintenance program. The application generates this value and is referenced during retrieval and update of a maintenance program definition. This value can't be updated after its creation.
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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: End Date
    Date when the work requirement stops forecasting. This value can be updated after its creation.
  • Title: Start Date
    Date when the work requirement begins forecasting. This value can be updated after its creation.
  • Affected Assets
    Title: Affected Assets
    The Affected Assets resource allows defining which assets are to be included or excluded from the forecast of a work requirement.
  • Value that uniquely identifies the asset for which the work requirement is effective. The value is required if the requirement type is Asset. Either asset ID or number can be used during POST, PATCH, or GET. This value can be updated after its creation.
  • Number that uniquely identifies the asset for which the work requirement is effective. The number is required if the requirement type is Asset. Either asset ID or number can be used during POST, PATCH, or GET. This value can be updated after its creation.
  • Title: Calendar pattern
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then a calendar pattern is used to forecast the work requirement. If false, then this method isn't considered in the forecast. The default value is true, therefore a calendar pattern must be defined and selected to generate a forecast. This value can be updated after its creation.
  • Title: Schedule Pattern
    Value of the calendar pattern that's used to forecast the work requirement. The value is required if the calendar-based flag is true. This value can be updated after its creation.
  • Name of the calendar pattern that's used to forecast the work requirement. The name is required if the calendar based flag is true. This value can be updated after its creation.
  • Title: Condition event
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a condition event code can be used to create a work order from the work requirement by using a service. If false, then this method is considered during maintenance work order creation by using a service. The default value is false. This value can be updated after its creation.
  • Condition Events
    Title: Condition Events
    The Condition Events resource allows defining condition events in a maintenance program. Condition events are used by IoT (Internet of Things) to create incident based work orders.
  • Title: Create Work Orders Option Code
    Maximum Length: 30
    Default Value: ORA_AUTOMATIC
    Abbreviation that identifies if work orders will be automatically or manually created for the work requirement. Valid values are ORA_AUTOMATIC and ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. The default value is Automatic and the value can be updated.
  • Title: Day Based Indicator
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a day interval is used to forecast the work requirement. If false, then this method isn't considered in the forecast. The default value is false. This value can be updated after its creation.
  • Title: Method to Calculate Next Due
    Maximum Length: 30
    Code of the method used to calculate the next due occurrence of the day interval in the work requirement forecast.
  • Title: Day Interval
    Number of days between cycle intervals in the forecast when day interval is used.
  • Title: Forecast using a cycle
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then the forecast considers cycle intervals. If false, then there's only one repeating interval. The default value is true, therefore the number of intervals in a cycle must also be defined. This value can be updated after its creation.
  • Title: Forecast Window in Days
    Value that represents the number of days into the future that the maintenance forecast will be created for a work requirement. If it's not defined, then either the value at the program header or the organization parameter is used. The optional value can be updated.
  • Title: Historical Last Completed Date
    Historical date of accomplishment of the work requirement from an external system.
  • Title: Historical Last Completed Interval
    Historical cycle interval of accomplishment of the work requirement from an external system.
  • Title: Include Assets Code
    Maximum Length: 30
    0ption that enables users to select if assets in an item-based work requirement are automatically or manually included.
  • Title: Number of Intervals per Cycle
    Number of intervals within a single cycle. The value is required if the forecast using a cycle flag is true. This value can be updated after its creation.
  • Title: Asset or Item
    Value that uniquely identifies the item for which the work requirement is effective. The value is required if the requirement type is Item. Either item ID or number can be used during POST, PATCH, or GET. This value can be updated after its creation.
  • Number that uniquely identifies the item for which the work requirement is effective. The number is required if the requirement type is Item. Either item ID or number can be used during POST, PATCH, or GET. This value can be updated after its creation.
  • Title: Meter interval
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a meter interval is used to forecast the work requirement. If false, then this method isn't considered in the forecast. The default value is false. This value can be updated after its creation.
  • Meters
    Title: Meters
    The Meters resource allows defining meters in a maintenance program. Meters are used in a work requirement as the basis for creating a maintenance program forecast.
  • Title: Name
    Maximum Length: 120
    Name that uniquely identifies the work requirement. This value can be updated after its creation.
  • Title: Next Work Order Only
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then only the next work order is created by the forecast. If false, then all work orders within the defined number of days for the organization are created. The default value is false. This value can be updated after its creation.
  • Title: Override for this requirement
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the work requirement overrides the suppress merge option at the maintenance program header. If false, then the header level option is used. The default value is false. If true, then the override option must be defined. This value can be updated after its creation.
  • Title: Requirement Reference
    Maximum Length: 80
    Value for a reference to the work requirement. The optional value can be updated.
  • Title: Concurrent Requirements
    Maximum Length: 30
    Abbreviation that indicates if concurrent requirements are merged or suppressed during work order creation within the work requirement. Valid values are ORA_SUPPRESS or ORA_MERGE. The default value ORA_SUPPRESS is used if a value isn't passed and the override merge and suppress option is true. This value can be updated after its creation only if the suppress merge override flag is true.
  • Title: Type
    Maximum Length: 30
    Default Value: ORA_ASSET
    Value that specifies if the work requirement applies to an item or an individual asset. Valid values include ORA_ASSET or ORA_ITEM. The default is ORA_ASSET. This value can be updated after its creation.
  • Work Definitions
    Title: Work Definitions
    The Work Definitions resource allows defining work definitions in a maintenance program. Work definitions define what work will be required each time a work requirement is due.
  • Title: Firm Work Orders
    Maximum Length: 1
    Default Value: false
    Value that specifies during rescheduling or replanning if the work order is to be considered. Contains one of the following values: true or false. If true, then planning doesn't consider the work order when rescheduling or replanning. If false, then planning can suggest rescheduling and replanning recommendations with respect to the work order. The default value is false and it can be updated.
  • Title: Work Order Priority
    Number that indicates the priority of the work order. This attribute is optional when creating the work order.
  • Maximum Length: 255
    Abbreviation that identifies the work order status code. Only values related to the predefined status of Released, Unreleased, or On-hold can be provided. The source of the valid values is defined in the WIE_WO_STATUSES_B table. If the optional value isn't defined, then the default value of Unreleased is used for newly created work orders. The value can be updated.
  • Title: Work Order Window in Days
    Value that represents the number of days into the future that work orders for maintenance forecast will be created for a work requirement. If it's not defined, then either the value at the program header or the organization parameter is used. The optional value can be updated.
  • Value that uniquely identifies the work requirement. The application generates this value when it creates a new requirement. This value is referenced during retrieval and update of a work requirement. This value can't be updated after its creation.
Nested Schema : Affected Assets
Type: array
Title: Affected Assets
The Affected Assets resource allows defining which assets are to be included or excluded from the forecast of a work requirement.
Show Source
Nested Schema : Condition Events
Type: array
Title: Condition Events
The Condition Events resource allows defining condition events in a maintenance program. Condition events are used by IoT (Internet of Things) to create incident based work orders.
Show Source
Nested Schema : Meters
Type: array
Title: Meters
The Meters resource allows defining meters in a maintenance program. Meters are used in a work requirement as the basis for creating a maintenance program forecast.
Show Source
Nested Schema : Work Definitions
Type: array
Title: Work Definitions
The Work Definitions resource allows defining work definitions in a maintenance program. Work definitions define what work will be required each time a work requirement is due.
Show Source
Nested Schema : maintenancePrograms-workRequirements-affectedAssets-item-post-request
Type: object
Show Source
  • Title: Asset ID
    Value that uniquely identifies the asset in a work requirement This value can't be updated,.
  • Title: Asset Number
    Maximum Length: 80
    Number that uniquely identifies the asset in a work requirement. This value can't be updated,.
  • Title: Asset Status Code
    Maximum Length: 11
    Abbreviation that specifies if an asset is included or excluded from the forecast in a work requirement. Valid values are ORA_INCLUDE or ORA_EXCLUDE as defined in the lookup ORA_MNT_AFF_ASSET_STATUS. The code can be updated.
  • Title: Create Work Orders Option Code
    Maximum Length: 30
    Abbreviation that identifies if work orders will be automatically or manually created for the affected asset. Valid values are ORA_AUTOMATIC and ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. The default value is Automatic and the code can be updated.
  • Title: Forecasted Start Date
    Date when the work requirement begins forecasting the asset. This value can be updated after its creation until the first work order is created.
  • Title: Historical Last Completed Date
    Historical date of accomplishment of the work requirement from an external system. This value can be updated after its creation until the first work order is created.
  • Title: Historical Last Completed Interval
    Historical cycle interval of accomplishment of the work requirement from an external system. This value can be updated after its creation until the first work order is created.
  • Title: Maintenance Organization
    Value that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.
  • Title: Operating Organization ID
    Value that uniquely identifies the operating organization of the asset. This value is read-only.
Nested Schema : maintenancePrograms-workRequirements-conditionEvents-item-post-request
Type: object
Show Source
  • Value that identifies a condition event code within a work requirement. The application generates this value when a condition event code is associated with a work requirement. This value can't be updated after its creation.
  • Abbreviation that identifies the condition event code that can be used to create a work order from the work requirement. The code, name, or ID is required if the condition-based mark is true. The value can be updated after its creation.
  • Value of the condition event code that can be used to create a work order from the work requirement. The ID, name, or code is required if the condition-based mark is true. The value can be updated after its creation.
Nested Schema : schema
Type: object
Show Source
  • Title: Base Interval
    Value of the interval that's used to calculate how often the forecast is due. This value can be updated after its creation.
  • Title: Method to Calculate Next Due
    Maximum Length: 30
    Abbreviation that specifies how the next due forecast interval is calculated. Valid values are ORA_BASE_INTERVAL or ORA_LAST_COMPLETION. This value can be updated after its creation.
  • Maximum Length: 1
    Default Value: false
    Value that indicates whether a meter is disabled or not. Contains one of the following values: true or false. If true, then the meter is disabled. If false, then the meter isn't disabled. If there are work orders created for the work requirement, this attribute is set to true when deleting a meter.
  • Value that uniquely identifies the asset meter used to forecast a work requirement. Either meter name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Value that identifies a unique meter within a work requirement. The application generates this value when a meter is associated with a work requirement. This value can't be updated after its creation.
  • Name of the meter used to forecast a work requirement. Either meter name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
Nested Schema : maintenancePrograms-workRequirements-workDefinitions-item-post-request
Type: object
Show Source
  • Maximum Length: 1
    Default Value: false
    Value that indicates whether a work definition is disabled or not. Contains one of the following values: true or false. If true, then the work definition is disabled. If false, then the work definition isn't disabled. If there are work orders created for the work requirement, this attribute is set to true when deleting a work definition.
  • Title: Due at Cycle Interval
    Value that specifies the interval in a cycle at which the work definition is due. The value is required if the repeats-in-cycle mark is true. This value can be updated after its creation.
  • Name of the work definition. Either work definition name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Title: Repeats in Cycle
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work definition repeats in the cycle at the interval value. If false, then the work definition doesn't repeat but is due only at the interval value. The default value is true. This value can be updated after its creation.
  • Value that uniquely identifies the work definition. Either work definition name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Value that uniquely identifies a work definition within a work requirement. The application generates this value when a work definition is associated with a work requirement. This value can't be updated after its creation.
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 : maintenancePrograms-workRequirements-item-response
Type: object
Show Source
  • Title: End Date
    Date when the work requirement stops forecasting. This value can be updated after its creation.
  • Title: Start Date
    Date when the work requirement begins forecasting. This value can be updated after its creation.
  • Affected Assets
    Title: Affected Assets
    The Affected Assets resource allows defining which assets are to be included or excluded from the forecast of a work requirement.
  • Title: Allow Work Orders
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then work orders are allowed to be created for the applicable asset in the work requirement. If false, then work orders can't be created for the applicable asset. The default value is false. This value can't be updated.
  • Value that uniquely identifies the asset for which the work requirement is effective. The value is required if the requirement type is Asset. Either asset ID or number can be used during POST, PATCH, or GET. This value can be updated after its creation.
  • Number that uniquely identifies the asset for which the work requirement is effective. The number is required if the requirement type is Asset. Either asset ID or number can be used during POST, PATCH, or GET. This value can be updated after its creation.
  • Title: Calendar pattern
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then a calendar pattern is used to forecast the work requirement. If false, then this method isn't considered in the forecast. The default value is true, therefore a calendar pattern must be defined and selected to generate a forecast. This value can be updated after its creation.
  • Title: Schedule Pattern
    Value of the calendar pattern that's used to forecast the work requirement. The value is required if the calendar-based flag is true. This value can be updated after its creation.
  • Name of the calendar pattern that's used to forecast the work requirement. The name is required if the calendar based flag is true. This value can be updated after its creation.
  • Title: Condition event
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a condition event code can be used to create a work order from the work requirement by using a service. If false, then this method is considered during maintenance work order creation by using a service. The default value is false. This value can be updated after its creation.
  • Condition Events
    Title: Condition Events
    The Condition Events resource allows defining condition events in a maintenance program. Condition events are used by IoT (Internet of Things) to create incident based work orders.
  • Title: Create Work Orders Option
    Read Only: true
    Maximum Length: 80
    Name that identifies if work orders will be automatically or manually created for the work requirement. This value is read-only.
  • Title: Create Work Orders Option Code
    Maximum Length: 30
    Default Value: ORA_AUTOMATIC
    Abbreviation that identifies if work orders will be automatically or manually created for the work requirement. Valid values are ORA_AUTOMATIC and ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. The default value is Automatic and the value can be updated.
  • Title: Day Based Indicator
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a day interval is used to forecast the work requirement. If false, then this method isn't considered in the forecast. The default value is false. This value can be updated after its creation.
  • Title: Method to Calculate Next Due
    Read Only: true
    Maximum Length: 255
    Meaning of the method used to calculate the next due occurrence of the day interval in the work requirement forecast.
  • Title: Method to Calculate Next Due
    Maximum Length: 30
    Code of the method used to calculate the next due occurrence of the day interval in the work requirement forecast.
  • Title: Day Interval
    Number of days between cycle intervals in the forecast when day interval is used.
  • Title: Forecast using a cycle
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then the forecast considers cycle intervals. If false, then there's only one repeating interval. The default value is true, therefore the number of intervals in a cycle must also be defined. This value can be updated after its creation.
  • Title: Forecast Window in Days
    Value that represents the number of days into the future that the maintenance forecast will be created for a work requirement. If it's not defined, then either the value at the program header or the organization parameter is used. The optional value can be updated.
  • Title: Historical Last Completed Date
    Historical date of accomplishment of the work requirement from an external system.
  • Title: Historical Last Completed Interval
    Historical cycle interval of accomplishment of the work requirement from an external system.
  • Title: Include Assets
    Read Only: true
    Maximum Length: 255
    Meaning of the option that enables users to select if assets in an item-based work requirement are automatically or manually included.
  • Title: Include Assets Code
    Maximum Length: 30
    0ption that enables users to select if assets in an item-based work requirement are automatically or manually included.
  • Title: Number of Intervals per Cycle
    Number of intervals within a single cycle. The value is required if the forecast using a cycle flag is true. This value can be updated after its creation.
  • Title: Asset or Item
    Value that uniquely identifies the item for which the work requirement is effective. The value is required if the requirement type is Item. Either item ID or number can be used during POST, PATCH, or GET. This value can be updated after its creation.
  • Number that uniquely identifies the item for which the work requirement is effective. The number is required if the requirement type is Item. Either item ID or number can be used during POST, PATCH, or GET. This value can be updated after its creation.
  • Links
  • Title: Meter interval
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then a meter interval is used to forecast the work requirement. If false, then this method isn't considered in the forecast. The default value is false. This value can be updated after its creation.
  • Meters
    Title: Meters
    The Meters resource allows defining meters in a maintenance program. Meters are used in a work requirement as the basis for creating a maintenance program forecast.
  • Title: Name
    Maximum Length: 120
    Name that uniquely identifies the work requirement. This value can be updated after its creation.
  • Title: Next Work Order Only
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then only the next work order is created by the forecast. If false, then all work orders within the defined number of days for the organization are created. The default value is false. This value can be updated after its creation.
  • Title: Override for this requirement
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the work requirement overrides the suppress merge option at the maintenance program header. If false, then the header level option is used. The default value is false. If true, then the override option must be defined. This value can be updated after its creation.
  • Title: Requirement Reference
    Maximum Length: 80
    Value for a reference to the work requirement. The optional value can be updated.
  • Title: Status
    Read Only: true
    Maximum Length: 255
    Meaning of the status of the work requirement.
  • Title: Status Code
    Read Only: true
    Maximum Length: 30
    Status code of the work requirement.
  • Title: Concurrent Requirements
    Maximum Length: 30
    Abbreviation that indicates if concurrent requirements are merged or suppressed during work order creation within the work requirement. Valid values are ORA_SUPPRESS or ORA_MERGE. The default value ORA_SUPPRESS is used if a value isn't passed and the override merge and suppress option is true. This value can be updated after its creation only if the suppress merge override flag is true.
  • Read Only: true
    Maximum Length: 255
    Name that describes if concurrent requirements will merge or suppress during work order creation. This value is derived from the suppress merge code.
  • Title: Type
    Read Only: true
    Maximum Length: 255
    Meaning of the option that enables users to select if the work requirement is associated with an asset or an item.
  • Title: Type
    Maximum Length: 30
    Default Value: ORA_ASSET
    Value that specifies if the work requirement applies to an item or an individual asset. Valid values include ORA_ASSET or ORA_ITEM. The default is ORA_ASSET. This value can be updated after its creation.
  • Work Definitions
    Title: Work Definitions
    The Work Definitions resource allows defining work definitions in a maintenance program. Work definitions define what work will be required each time a work requirement is due.
  • Title: Firm Work Orders
    Maximum Length: 1
    Default Value: false
    Value that specifies during rescheduling or replanning if the work order is to be considered. Contains one of the following values: true or false. If true, then planning doesn't consider the work order when rescheduling or replanning. If false, then planning can suggest rescheduling and replanning recommendations with respect to the work order. The default value is false and it can be updated.
  • Title: Work Order Priority
    Number that indicates the priority of the work order. This attribute is optional when creating the work order.
  • Title: Work Orders Created
    Read Only: true
    Maximum Length: 255
    Contains one of the following values: true or false. If true, then work orders for the work requirement exist. If false, then work orders for the work requirements haven't been created yet. The default value is false. This value can't be updated.
  • Title: Work Order Status
    Read Only: true
    Maximum Length: 120
    Abbreviation that identifies the work order status. Only values related to the predefined status of Released, Unreleased, or On-Hold can be provided. The source of the valid values is defined in the WIE_WO_STATUSES_B table. If the optional value isn't defined, then the default value of Unreleased is used for newly created work orders. The value can be updated.
  • Maximum Length: 255
    Abbreviation that identifies the work order status code. Only values related to the predefined status of Released, Unreleased, or On-hold can be provided. The source of the valid values is defined in the WIE_WO_STATUSES_B table. If the optional value isn't defined, then the default value of Unreleased is used for newly created work orders. The value can be updated.
  • Title: Work Order Window in Days
    Value that represents the number of days into the future that work orders for maintenance forecast will be created for a work requirement. If it's not defined, then either the value at the program header or the organization parameter is used. The optional value can be updated.
  • Value that uniquely identifies the work requirement. The application generates this value when it creates a new requirement. This value is referenced during retrieval and update of a work requirement. This value can't be updated after its creation.
Nested Schema : Affected Assets
Type: array
Title: Affected Assets
The Affected Assets resource allows defining which assets are to be included or excluded from the forecast of a work requirement.
Show Source
Nested Schema : Condition Events
Type: array
Title: Condition Events
The Condition Events resource allows defining condition events in a maintenance program. Condition events are used by IoT (Internet of Things) to create incident based work orders.
Show Source
Nested Schema : Meters
Type: array
Title: Meters
The Meters resource allows defining meters in a maintenance program. Meters are used in a work requirement as the basis for creating a maintenance program forecast.
Show Source
Nested Schema : Work Definitions
Type: array
Title: Work Definitions
The Work Definitions resource allows defining work definitions in a maintenance program. Work definitions define what work will be required each time a work requirement is due.
Show Source
Nested Schema : maintenancePrograms-workRequirements-affectedAssets-item-response
Type: object
Show Source
  • Title: Allow Work Orders
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then work orders are allowed to be created for the applicable asset in the work requirement. If false, then work orders can't be created for the applicable asset. The default value is false. This value can't be updated.
  • Title: Asset Description
    Read Only: true
    Maximum Length: 240
    Description of the asset in a work requirement. This value can't be updated,.
  • Title: Asset ID
    Value that uniquely identifies the asset in a work requirement This value can't be updated,.
  • Title: Asset Number
    Maximum Length: 80
    Number that uniquely identifies the asset in a work requirement. This value can't be updated,.
  • Title: Asset Status
    Read Only: true
    Maximum Length: 80
    Meaning of the asset status code. This value can't be updated.
  • Title: Asset Status Code
    Maximum Length: 11
    Abbreviation that specifies if an asset is included or excluded from the forecast in a work requirement. Valid values are ORA_INCLUDE or ORA_EXCLUDE as defined in the lookup ORA_MNT_AFF_ASSET_STATUS. The code can be updated.
  • Title: Create Work Orders Option
    Read Only: true
    Maximum Length: 80
    Name that identifies if work orders will be automatically or manually created for the work requirement. This value is read-only.
  • Title: Create Work Orders Option Code
    Maximum Length: 30
    Abbreviation that identifies if work orders will be automatically or manually created for the affected asset. Valid values are ORA_AUTOMATIC and ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. The default value is Automatic and the code can be updated.
  • Title: Forecasted Start Date
    Date when the work requirement begins forecasting the asset. This value can be updated after its creation until the first work order is created.
  • Title: Historical Last Completed Date
    Historical date of accomplishment of the work requirement from an external system. This value can be updated after its creation until the first work order is created.
  • Title: Historical Last Completed Interval
    Historical cycle interval of accomplishment of the work requirement from an external system. This value can be updated after its creation until the first work order is created.
  • Links
  • Title: Maintenance Organization
    Read Only: true
    Maximum Length: 18
    Abbreviation that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.
  • Title: Maintenance Organization
    Value that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.
  • Title: Operating Organization
    Read Only: true
    Maximum Length: 18
    Abbreviation that uniquely identifies the operating organization of the asset. This value is read-only.
  • Title: Operating Organization ID
    Value that uniquely identifies the operating organization of the asset. This value is read-only.
  • Title: Serial Number
    Read Only: true
    Maximum Length: 80
    Serial number of the asset in a work requirement. This value can't be updated,.
  • Title: Work Orders Created
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then work orders for the work requirement exist. If false, then work orders for the work requirements haven't been created yet. The default value is false. This value can't be updated.
Nested Schema : maintenancePrograms-workRequirements-conditionEvents-item-response
Type: object
Show Source
  • Value that identifies a condition event code within a work requirement. The application generates this value when a condition event code is associated with a work requirement. This value can't be updated after its creation.
  • Abbreviation that identifies the condition event code that can be used to create a work order from the work requirement. The code, name, or ID is required if the condition-based mark is true. The value can be updated after its creation.
  • Title: Description
    Read Only: true
    Maximum Length: 540
    Description of the condition event code. This value is read-only and can't be updated after its creation.
  • Value of the condition event code that can be used to create a work order from the work requirement. The ID, name, or code is required if the condition-based mark is true. The value can be updated after its creation.
  • Title: Name
    Read Only: true
    Maximum Length: 540
    Name of the condition event code that can be used to create a work order from the work requirement. The name, code, or ID is required if the condition-based mark is true. The value can be updated after its creation.
  • Links
Nested Schema : maintenancePrograms-workRequirements-meters-item-response
Type: object
Show Source
  • Title: Base Interval
    Value of the interval that's used to calculate how often the forecast is due. This value can be updated after its creation.
  • Title: Method to Calculate Next Due
    Maximum Length: 30
    Abbreviation that specifies how the next due forecast interval is calculated. Valid values are ORA_BASE_INTERVAL or ORA_LAST_COMPLETION. This value can be updated after its creation.
  • Maximum Length: 1
    Default Value: false
    Value that indicates whether a meter is disabled or not. Contains one of the following values: true or false. If true, then the meter is disabled. If false, then the meter isn't disabled. If there are work orders created for the work requirement, this attribute is set to true when deleting a meter.
  • Links
  • Value that uniquely identifies the asset meter used to forecast a work requirement. Either meter name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Value that identifies a unique meter within a work requirement. The application generates this value when a meter is associated with a work requirement. This value can't be updated after its creation.
  • Name of the meter used to forecast a work requirement. Either meter name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
Nested Schema : maintenancePrograms-workRequirements-workDefinitions-item-response
Type: object
Show Source
  • Maximum Length: 1
    Default Value: false
    Value that indicates whether a work definition is disabled or not. Contains one of the following values: true or false. If true, then the work definition is disabled. If false, then the work definition isn't disabled. If there are work orders created for the work requirement, this attribute is set to true when deleting a work definition.
  • Title: Due at Cycle Interval
    Value that specifies the interval in a cycle at which the work definition is due. The value is required if the repeats-in-cycle mark is true. This value can be updated after its creation.
  • Links
  • Name of the work definition. Either work definition name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Title: Repeats in Cycle
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work definition repeats in the cycle at the interval value. If false, then the work definition doesn't repeat but is due only at the interval value. The default value is true. This value can be updated after its creation.
  • Value that uniquely identifies the work definition. Either work definition name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Read Only: true
    Value that uniquely identifies the name of a work definition within a work requirement. The application generates this value when a work definition is created.
  • Value that uniquely identifies a work definition within a work requirement. The application generates this value when a work definition is associated with a work requirement. This value can't be updated after its creation.
Links
affectedAssets
Parameters:
  • MaintenanceProgramId: $request.path.MaintenanceProgramId
  • WorkRequirementId: $request.path.WorkRequirementId
The Affected Assets resource allows defining which assets are to be included or excluded from the forecast of a work requirement.
conditionEvents
Parameters:
  • MaintenanceProgramId: $request.path.MaintenanceProgramId
  • WorkRequirementId: $request.path.WorkRequirementId
The Condition Events resource allows defining condition events in a maintenance program. Condition events are used by IoT (Internet of Things) to create incident based work orders.
meters
Parameters:
  • MaintenanceProgramId: $request.path.MaintenanceProgramId
  • WorkRequirementId: $request.path.WorkRequirementId
The Meters resource allows defining meters in a maintenance program. Meters are used in a work requirement as the basis for creating a maintenance program forecast.
workDefinitions
Parameters:
  • MaintenanceProgramId: $request.path.MaintenanceProgramId
  • WorkRequirementId: $request.path.WorkRequirementId
The Work Definitions resource allows defining work definitions in a maintenance program. Work definitions define what work will be required each time a work requirement is due.
Back to Top

Examples

This example describes how to create one requirement.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/maintenancePrograms/MaintenanceProgramId/child/workRequirements"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. 

{
	"Name": "CALENDAR_PATTERN_ON_CYCLE",
	"TypeCode":"ORA_ASSET",
	"AssetNumber": "Asset_With_Meter",
	"ActiveStartDate": "2023-08-01",
	"ForecastUsingACycleFlag": true,
	"IntervalsInTheCycle": 7,
	"NextWorkOrderOnlyFlag": true,
	"CalendarBasedFlag": true,
	"MeterBasedFlag": false,
	"ConditionBasedFlag": false,
	"OverrideSuppressMergeFlag": "N",
	"CalendarPatternName": "Daily Pattern every weekday",
    "RequirementReference": "Reference DEF456",
    "ForecastWindowInDays": 60,
    "WorkOrderWindowInDays": 30,
    "CreateWorkOrderOptionCode": "ORA_AUTOMATIC",
    "WorkOrderStatusCode": "ORA_UNRELEASED",
    "WorkOrderFirmFlag": true,
    "WorkOrderPriority": 1
	"workDefinitions":[
	{
		"Name": "Weekly Maintenance",
		"RepeatsInCycleFlag": "Y",
		"DueAtCycleInterval": 1
	},
	{
		"Name": "Daily Maintenance",
		"RepeatsInCycleFlag": "Y",
		"DueAtCycleInterval": 3
	}
	]
}

Example Response Body

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

{
	"Name": "CALENDAR_PATTERN_ON_CYCLE",
	"WorkRequirementId": 300100179951295,
	"TypeCode": "ORA_ASSET",
	"InventoryItemId": 300100013645864,
	"InventoryItemNumber": "alm-lot-srl-001",
	"AssetId": 300100179879925,
	"AssetNumber": null,
	"ActiveStartDate": "2023-08-01",
	"ActiveEndDate": null,
	"ForecastUsingACycleFlag": true,
	"IntervalsInTheCycle": 7,
	"NextWorkOrderOnlyFlag": true,
	"CalendarBasedFlag": true,
	"CalendarPatternId": 300100179940481,
	"MeterBasedFlag": false,
	"ConditionBasedFlag": false,
	"SuppressMergeCode": null,
	"OverrideSuppressMergeFlag": false,
	"CalendarPatternName": "Daily Pattern every weekday",
	"SuppressMergeCodeDescription": null,
	"RequirementReference": "Reference DEF456",
    "ForecastWindowInDays": 60,
    "WorkOrderWindowInDays": 30,
    "CreateWorkOrderOptionCode": "ORA_AUTOMATIC",
    "CreateWorkOrderOption": "Automatically",
    "WorkOrderStatusCode": "ORA_UNRELEASED",
    "WorkOrderStatus": "Unreleased",
    "WorkOrderFirmFlag": true,
    "WorkOrderPriority": 1,
	"workDefinitions": [
	{
		"RepeatsInCycleFlag": true,
		"DisabledFlag": false,
		"DueAtCycleInterval": 1,
		"WorkDefinitionRequirementId": 300100179951296,
		"WorkDefinitionMaintenanceNameId": null,
		"Name": null,
		"WorkDefinitionId": 300100118178830,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295/child/workDefinitions/300100179951296",
			"name": "workDefinitions",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295/child/workDefinitions/300100179951296",
			"name": "workDefinitions",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295",
			"name": "workRequirements",
			"kind": "item"
		}
		]
	},
	{
		"RepeatsInCycleFlag": true,
		"DisabledFlag": false,
		"DueAtCycleInterval": 3,
		"WorkDefinitionRequirementId": 300100179951299,
		"WorkDefinitionMaintenanceNameId": null,
		"Name": null,
		"WorkDefinitionId": 300100118178763,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295/child/workDefinitions/300100179951299",
			"name": "workDefinitions",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295/child/workDefinitions/300100179951299",
			"name": "workDefinitions",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295",
			"name": "workRequirements",
			"kind": "item"
		}
		]
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295",
		"name": "workRequirements",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295",
		"name": "workRequirements",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471",
		"name": "maintenancePrograms",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295/child/workDefinitions",
		"name": "workDefinitions",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295/child/meters",
		"name": "meters",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179951295/child/conditionEvents",
		"name": "conditionEvents",
		"kind": "collection"
	}
	]
}
Back to Top