Get all requirements
get
/fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/workRequirements
Request
Path Parameters
-
MaintenanceProgramId(required): integer(int64)
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds work requirements in a maintenance program according to the requirement identifier.
Finder Variables:- WorkRequirementId; integer; Value that uniquely identifies the requirement.
- PrimaryKey: Finds work requirements in a maintenance program according to the requirement identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveEndDate; string; Date when the work requirement stops forecasting. This value can be updated after its creation.
- ActiveStartDate; string; Date when the work requirement begins forecasting. This value can be updated after its creation.
- AllowWorkOrdersFlag; boolean; 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.
- AssetId; integer; 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.
- AssetNumber; string; 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.
- CalendarBasedFlag; boolean; 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.
- CalendarPatternId; integer; 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.
- CalendarPatternName; string; 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.
- ConditionBasedFlag; boolean; 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.
- CreateWorkOrderOption; string; Name that identifies if work orders will be automatically or manually created for the work requirement. This value is read-only.
- CreateWorkOrderOptionCode; string; 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.
- DayBasedFlag; boolean; 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.
- DayCalculateNextDueCode; string; Code of the method used to calculate the next due occurrence of the day interval in the work requirement forecast.
- DayInterval; number; Number of days between cycle intervals in the forecast when day interval is used.
- ForecastUsingACycleFlag; boolean; 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.
- ForecastWindowInDays; integer; 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.
- HistoricalLastCompleteInterval; number; Historical cycle interval of accomplishment of the work requirement from an external system.
- HistoricalLastCompletedDate; string; Historical date of accomplishment of the work requirement from an external system.
- IncludeAssetsCode; string; 0ption that enables users to select if assets in an item-based work requirement are automatically or manually included.
- IntervalsInTheCycle; number; 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.
- InventoryItemId; integer; 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.
- InventoryItemNumber; string; 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.
- MeterBasedFlag; boolean; 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.
- Name; string; Name that uniquely identifies the work requirement. This value can be updated after its creation.
- NextWorkOrderOnlyFlag; boolean; 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.
- OverrideSuppressMergeFlag; boolean; 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.
- RequirementReference; string; Value for a reference to the work requirement. The optional value can be updated.
- Status; string; Meaning of the status of the work requirement.
- StatusCode; string; Status code of the work requirement.
- SuppressMergeCode; string; 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.
- SuppressMergeCodeDescription; string; Name that describes if concurrent requirements will merge or suppress during work order creation. This value is derived from the suppress merge code.
- Type; string; Meaning of the option that enables users to select if the work requirement is associated with an asset or an item.
- TypeCode; string; 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.
- WorkOrderFirmFlag; boolean; 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.
- WorkOrderPriority; number; Number that indicates the priority of the work order. This attribute is optional when creating the work order.
- WorkOrderStatus; string; 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.
- WorkOrderStatusCode; string; 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.
- WorkOrderWindowInDays; integer; 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.
- WorkRequirementId; integer; 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : maintenancePrograms-workRequirements
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : maintenancePrograms-workRequirements-item-response
Type:
Show Source
object
-
ActiveEndDate: string
(date)
Title:
End Date
Date when the work requirement stops forecasting. This value can be updated after its creation. -
ActiveStartDate: string
(date)
Title:
Start Date
Date when the work requirement begins forecasting. This value can be updated after its creation. -
affectedAssets: array
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. -
AllowWorkOrdersFlag: boolean
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. -
AssetId: integer
(int64)
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.
-
AssetNumber: string
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.
-
CalendarBasedFlag: boolean
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. -
CalendarPatternId: integer
(int64)
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. -
CalendarPatternName: string
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.
-
ConditionBasedFlag: boolean
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. -
conditionEvents: array
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. -
CreateWorkOrderOption: string
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. -
CreateWorkOrderOptionCode: string
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. -
DayBasedFlag: boolean
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. -
DayCalculateNextDue: string
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. -
DayCalculateNextDueCode: string
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. -
DayInterval: number
Title:
Day Interval
Number of days between cycle intervals in the forecast when day interval is used. -
ForecastUsingACycleFlag: boolean
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. -
ForecastWindowInDays: integer
(int32)
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. -
HistoricalLastCompletedDate: string
(date)
Title:
Historical Last Completed Date
Historical date of accomplishment of the work requirement from an external system. -
HistoricalLastCompleteInterval: number
Title:
Historical Last Completed Interval
Historical cycle interval of accomplishment of the work requirement from an external system. -
IncludeAssets: string
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. -
IncludeAssetsCode: string
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. -
IntervalsInTheCycle: number
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. -
InventoryItemId: integer
(int64)
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. -
InventoryItemNumber: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterBasedFlag: boolean
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: array
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. -
Name: string
Title:
Name
Maximum Length:120
Name that uniquely identifies the work requirement. This value can be updated after its creation. -
NextWorkOrderOnlyFlag: boolean
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. -
OverrideSuppressMergeFlag: boolean
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. -
RequirementReference: string
Title:
Requirement Reference
Maximum Length:80
Value for a reference to the work requirement. The optional value can be updated. -
Status: string
Title:
Status
Read Only:true
Maximum Length:255
Meaning of the status of the work requirement. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Status code of the work requirement. -
SuppressMergeCode: string
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. -
SuppressMergeCodeDescription: string
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. -
Type: string
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. -
TypeCode: string
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. -
workDefinitions: array
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. -
WorkOrderFirmFlag: boolean
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. -
WorkOrderPriority: number
Title:
Work Order Priority
Number that indicates the priority of the work order. This attribute is optional when creating the work order. -
WorkOrdersCreatedFlag: boolean
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. -
WorkOrderStatus: string
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. -
WorkOrderStatusCode: string
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. -
WorkOrderWindowInDays: integer
(int32)
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. -
WorkRequirementId: integer
(int64)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AllowWorkOrdersFlag: boolean
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. -
AssetDescription: string
Title:
Asset Description
Read Only:true
Maximum Length:240
Description of the asset in a work requirement. This value can't be updated,. -
AssetId: integer
(int64)
Title:
Asset ID
Value that uniquely identifies the asset in a work requirement This value can't be updated,. -
AssetNumber: string
Title:
Asset Number
Maximum Length:80
Number that uniquely identifies the asset in a work requirement. This value can't be updated,. -
AssetStatus: string
Title:
Asset Status
Read Only:true
Maximum Length:80
Meaning of the asset status code. This value can't be updated. -
AssetStatusCode: string
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. -
CreateWorkOrderOption: string
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. -
CreateWorkOrderOptionCode: string
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. -
ForecastStartDate: string
(date)
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. -
HistoricalLastCompletedDate: string
(date)
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. -
HistoricalLastCompleteInterval: number
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaintenanceOrganization: string
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. -
MaintenanceOrganizationId: integer
(int64)
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. -
OperatingOrganization: string
Title:
Operating Organization
Read Only:true
Maximum Length:18
Abbreviation that uniquely identifies the operating organization of the asset. This value is read-only. -
OperatingOrganizationId: integer
(int64)
Title:
Operating Organization ID
Value that uniquely identifies the operating organization of the asset. This value is read-only. -
SerialNumber: string
Title:
Serial Number
Read Only:true
Maximum Length:80
Serial number of the asset in a work requirement. This value can't be updated,. -
WorkOrdersCreatedFlag: boolean
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : maintenancePrograms-workRequirements-conditionEvents-item-response
Type:
Show Source
object
-
ConditionEventId: integer
(int64)
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.
-
EventCode: string
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.
-
EventCodeDescription: string
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. -
EventCodeId: integer
(int64)
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.
-
EventCodeName: string
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: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : maintenancePrograms-workRequirements-meters-item-response
Type:
Show Source
object
-
BaseInterval: number
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. -
CalculateNextDueCode: string
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. -
DisabledFlag: boolean
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterDefinitionId: integer
(int64)
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.
-
MeterIntervalId: integer
(int64)
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: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : maintenancePrograms-workRequirements-workDefinitions-item-response
Type:
Show Source
object
-
DisabledFlag: boolean
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. -
DueAtCycleInterval: number
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
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.
-
RepeatsInCycleFlag: boolean
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. -
WorkDefinitionId: integer
(int64)
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.
-
WorkDefinitionMaintenanceNameId: integer
(int64)
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. -
WorkDefinitionRequirementId: integer
(int64)
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all requirements.
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/maintenancePrograms/MaintenanceProgramId/child/workRequirements"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [ { "Name": "CALENDAR_PATTERN_ON_CYCLE", "WorkRequirementId": 300100179951295, "TypeCode": "ORA_ASSET", "InventoryItemId": 300100013645864, "InventoryItemNumber": "alm-lot-srl-001", "AssetId": 300100179879925, "AssetNumber": "Asset_With_Meter", "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, "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" } ] }, { "Name": "CALENDAR_PATTERN_BULK_A", "WorkRequirementId": 300100179955931, "TypeCode": "ORA_ASSET", "InventoryItemId": 300100013645864, "InventoryItemNumber": "alm-lot-srl-001", "AssetId": 300100179879925, "AssetNumber": "Asset_With_Meter", "ActiveStartDate": "2023-03-06", "ActiveEndDate": null, "ForecastUsingACycleFlag": true, "IntervalsInTheCycle": 7, "NextWorkOrderOnlyFlag": true, "CalendarBasedFlag": true, "CalendarPatternId": 300100179940482, "MeterBasedFlag": false, "ConditionBasedFlag": false, "SuppressMergeCode": null, "OverrideSuppressMergeFlag": false, "CalendarPatternName": "Daily Pattern every day", "SuppressMergeCodeDescription": null, "RequirementReference": null, "ForecastWindowInDays": null, "WorkOrderWindowInDays": null, "CreateWorkOrderOptionCode": "ORA_AUTOMATIC", "CreateWorkOrderOption": "Automatically", "WorkOrderStatusCode": "ORA_UNRELEASED", "WorkOrderStatus": "Unreleased", "WorkOrderFirmFlag": null, "WorkOrderPriority": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955931", "name": "workRequirements", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955931", "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/300100179955931/child/workDefinitions", "name": "workDefinitions", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955931/child/meters", "name": "meters", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955931/child/conditionEvents", "name": "conditionEvents", "kind": "collection" } ] }, { "Name": "CALENDAR_PATTERN_BULK_B", "WorkRequirementId": 300100179955936, "TypeCode": "ORA_ASSET", "InventoryItemId": 300100013645864, "InventoryItemNumber": "alm-lot-srl-001", "AssetId": 300100179879925, "AssetNumber": "Asset_With_Meter", "ActiveStartDate": "2023-03-06", "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": null, "ForecastWindowInDays": 90, "WorkOrderWindowInDays": null, "CreateWorkOrderOptionCode": "ORA_AUTOMATIC", "CreateWorkOrderOption": "Automatically", "WorkOrderStatusCode": "ORA_RELEASED", "WorkOrderStatus": "Unreleased", "WorkOrderFirmFlag": null, "WorkOrderPriority": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955936", "name": "workRequirements", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955936", "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/300100179955936/child/workDefinitions", "name": "workDefinitions", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955936/child/meters", "name": "meters", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955936/child/conditionEvents", "name": "conditionEvents", "kind": "collection" } ] }, { "Name": "CALENDAR_PATTERN_BULK_C", "WorkRequirementId": 300100179955939, "TypeCode": "ORA_ASSET", "InventoryItemId": 300100013645864, "InventoryItemNumber": "alm-lot-srl-001", "AssetId": 300100179879925, "AssetNumber": "Asset_With_Meter", "ActiveStartDate": "2023-03-06", "ActiveEndDate": null, "ForecastUsingACycleFlag": true, "IntervalsInTheCycle": 7, "NextWorkOrderOnlyFlag": true, "CalendarBasedFlag": true, "CalendarPatternId": 300100179940482, "MeterBasedFlag": false, "ConditionBasedFlag": false, "SuppressMergeCode": null, "OverrideSuppressMergeFlag": false, "CalendarPatternName": "Daily Pattern every day", "SuppressMergeCodeDescription": null, "RequirementReference": null, "ForecastWindowInDays": null, "WorkOrderWindowInDays": 45, "CreateWorkOrderOptionCode": "ORA_MANUAL", "CreateWorkOrderOption": "Manually", "WorkOrderStatusCode": "ORA_ON_HOLD", "WorkOrderStatus": "On Hold", "WorkOrderFirmFlag": null, "WorkOrderPriority": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955939", "name": "workRequirements", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955939", "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/300100179955939/child/workDefinitions", "name": "workDefinitions", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955939/child/meters", "name": "meters", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179955939/child/conditionEvents", "name": "conditionEvents", "kind": "collection" } ] } ], "count": 4, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements", "name": "workRequirements", "kind": "collection" } ] }