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

Get all programs

get

/fscmRestApi/resources/11.13.18.05/maintenancePrograms

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • 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 maintenance programs according to the program identifier.
      Finder Variables:
      • MaintenanceProgramId; integer; Value that uniquely identifies the maintenance program.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 maintenance program stops forecasting. The end date is optional and can be updated after its creation.
    • ActiveStartDate; string; Date when the maintenance program is eligible to start forecasting. The start date is required and can be updated after its creation.
    • AllowGlobalAssetsFlag; boolean; Indicates that assets across other organizations can be considered by the maintenance forecast in a program. The optional value can be updated until work orders are created for the program.
    • Code; string; Abbreviation that identifies the maintenance program. The code can be updated after its creation.
    • Description; string; Description of the maintenance program. The description 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 program. If it's not defined, then either the value at the work requirement or the organization parameter is used. The optional value can be updated.
    • InProcessFlag; boolean; Value that uniquely identifies the in-process flag for a maintenance program. Valid values are true or false. If true, the maintenance program is in progress; otherwise, it's not.
    • LastForecastDate; string; Date when the last forecast was recorded.
    • LastUpdateDate; string; Date when the user most recently updated the program.
    • MaintenanceProgramId; integer; 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.
    • Name; string; Name that identifies the maintenance program. The name can be updated after its creation.
    • OrganizationCode; string; Abbreviation that identifies the organization where the maintenance program is managed. This attribute is a foreign key. Either the Organization ID or Code can be used during creation of a program. This value can't be updated after its creation.
    • OrganizationId; integer; Value that uniquely identifies the organization where the maintenance program is managed. This attribute is a foreign key. Either the Organization ID or Code can be used during creation of a maintenance program. This value can't be updated after its creation.
    • OrganizationName; string; Name of the organization where the maintenance program is managed. This attribute is a foreign key. Either the Organization ID or Code can be used during creation of a program. This value can't be updated after its creation.
    • ProgramReference; string; Value for a reference to the program. The optional value can be updated.
    • ProgramSubType; string; Name that identifies the user-defined subtype of maintenance program. This value is read-only.
    • ProgramSubTypeCode; string; Abbreviation that identifies the user-defined subtype of maintenance program. Valid values are optional and are defined in the lookup ORA_MNT_MX_PROGRAM_SUB_TYPE. The code can be updated.
    • ProgramType; string; Name that identifies the user-defined type of maintenance program. This value is read-only.
    • ProgramTypeCode; string; Abbreviation that identifies the user-defined type of maintenance program. Valid values are optional and are defined in the lookup ORA_MNT_MX_PROGRAM_TYPE. The code can be updated.
    • ReviewComments; string; Comments provided by the user who most recently reviewed the program. The comments can be updated after its creation.
    • ReviewedBy; string; Name of the user who most recently reviewed the program. The name can be updated after its creation.
    • ReviewedOn; string; Date when the user most recently reviewed the program. The date can be updated after its creation.
    • SuppressMergeCode; string; Abbreviation that specifies if concurrent requirements will merge or suppress during work order creation. Valid values are ORA_SUPPRESS or ORA_MERGE. The default value is ORA_SUPPRESS. The code can be updated after its creation.
    • 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.
    • WorkOrderStartTime; string; Value that represents the starting time of day for all work orders created for the program. If it's not defined, the start time is set to 8:00 AM. The optional value can be updated.
    • WorkOrderTimezone; string; Value that represents the time zone for all work orders created for the program. If it's not defined, the time zone is set to UTC. The optional value can be updated.
    • WorkOrderTimezoneCode; string; Abbreviation that identifies the time zone for all work orders that were created for the program. If it's not defined, the time zone is set to UTC. The optional value can be updated.
    • WorkOrderWindowInDays; integer; Value that represents the number of days into the future that work orders for the maintenance forecast will be created for a program. If it's not defined, then either the value at the work requirement or the organization parameter is used. The optional value can be updated.
    • WorkOrdersCreatedFlag; boolean; Value that indicates whether any work orders have been created for the maintenance program. Valid values are true or false. If true, work orders exist; if false, no work orders have been created for this maintenance program.
  • 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
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : maintenancePrograms
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : maintenancePrograms-item-response
Type: object
Show Source
  • Title: End Date
    Date when the maintenance program stops forecasting. The end date is optional and can be updated after its creation.
  • Title: Start Date
    Date when the maintenance program is eligible to start forecasting. The start date is required and can be updated after its creation.
  • Title: Allow assets from other organizations
    Maximum Length: 1
    Default Value: false
    Indicates that assets across other organizations can be considered by the maintenance forecast in a program. The optional value can be updated until work orders are created for the program.
  • Attachments
    Title: Attachments
    Attachment management capabilities: view, create, and update.
  • Calendar Patterns
    Title: Calendar Patterns
    The Calendar Patterns resource allows defining unique calendar patterns in a maintenance program. Patterns are used in a work requirement as the basis for creating a maintenance program forecast.
  • Title: Code
    Maximum Length: 30
    Abbreviation that identifies the maintenance program. The code can be updated after its creation.
  • Read Only: true
    This value identifies the assets count included the maintenance program.
  • Read Only: true
    This value identifies the open work orders count included the maintenance program.
  • Read Only: true
    This value identifies the work requirements counts included the maintenance program.
  • Title: Description
    Maximum Length: 240
    Description of the maintenance program. The description 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 program. If it's not defined, then either the value at the work requirement or the organization parameter is used. The optional value can be updated.
  • Read Only: true
    Maximum Length: 1
    Value that uniquely identifies the in-process flag for a maintenance program. Valid values are true or false. If true, the maintenance program is in progress; otherwise, it's not.
  • Title: Last Forecast Date
    Date when the last forecast was recorded.
  • Read Only: true
    Date when the user most recently updated the program.
  • Links
  • 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.
  • Title: Name
    Maximum Length: 120
    Name that identifies the maintenance program. The name can be updated after its creation.
  • Title: Organization
    Abbreviation that identifies the organization where the maintenance program is managed. This attribute is a foreign key. Either the Organization ID or Code can be used during creation of a program. This value can't be updated after its creation.
  • Value that uniquely identifies the organization where the maintenance program is managed. This attribute is a foreign key. Either the Organization ID or Code can be used during creation of a maintenance program. This value can't be updated after its creation.
  • Name of the organization where the maintenance program is managed. This attribute is a foreign key. Either the Organization ID or Code can be used during creation of a program. This value can't be updated after its creation.
  • Title: Program Reference
    Maximum Length: 80
    Value for a reference to the program. The optional value can be updated.
  • Title: Program Subtype
    Read Only: true
    Maximum Length: 80
    Name that identifies the user-defined subtype of maintenance program. This value is read-only.
  • Title: Program Subtype Code
    Maximum Length: 30
    Abbreviation that identifies the user-defined subtype of maintenance program. Valid values are optional and are defined in the lookup ORA_MNT_MX_PROGRAM_SUB_TYPE. The code can be updated.
  • Title: Program Type
    Read Only: true
    Maximum Length: 80
    Name that identifies the user-defined type of maintenance program. This value is read-only.
  • Title: Program Type Code
    Maximum Length: 30
    Abbreviation that identifies the user-defined type of maintenance program. Valid values are optional and are defined in the lookup ORA_MNT_MX_PROGRAM_TYPE. The code can be updated.
  • Title: Review Comments
    Maximum Length: 240
    Comments provided by the user who most recently reviewed the program. The comments can be updated after its creation.
  • Title: Program Reviewed By
    Maximum Length: 80
    Name of the user who most recently reviewed the program. The name can be updated after its creation.
  • Title: Review Date
    Date when the user most recently reviewed the program. The date can be updated after its creation.
  • Title: Concurrent Requirements
    Maximum Length: 30
    Default Value: ORA_SUPPRESS
    Abbreviation that specifies if concurrent requirements will merge or suppress during work order creation. Valid values are ORA_SUPPRESS or ORA_MERGE. The default value is ORA_SUPPRESS. The code can be updated after its creation.
  • Title: Concurrent Requirements
    Name that describes if concurrent requirements will merge or suppress during work order creation. This value is derived from the suppress merge code.
  • Read Only: true
    Maximum Length: 255
    Value that indicates whether any work orders have been created for the maintenance program. Valid values are true or false. If true, work orders exist; if false, no work orders have been created for this maintenance program.
  • Title: Work Order Start Time
    Maximum Length: 5
    Value that represents the starting time of day for all work orders created for the program. If it's not defined, the start time is set to 8:00 AM. The optional value can be updated.
  • Title: Work Order Time Zone
    Read Only: true
    Maximum Length: 255
    Value that represents the time zone for all work orders created for the program. If it's not defined, the time zone is set to UTC. The optional value can be updated.
  • Title: Work Order Time Zone
    Maximum Length: 30
    Abbreviation that identifies the time zone for all work orders that were created for the program. If it's not defined, the time zone is set to UTC. The optional value can be updated.
  • Title: Work Order Window in Days
    Value that represents the number of days into the future that work orders for the maintenance forecast will be created for a program. If it's not defined, then either the value at the work requirement or the organization parameter is used. The optional value can be updated.
  • Work Requirements
    Title: Work Requirements
    The Work Requirements resource allows defining unique work requirements in a maintenance program. Work requirements define how often maintenance will be due and what work will be required for one or more assets.
  • Read Only: true
    Maximum Length: 255
    Value that uniquely identifies the work requirement created flag. Valid values are true or false. If true, the work requirement exists; if false, the work requirements haven't yet been created. The default value is false. This value can't be updated.
Nested Schema : Attachments
Type: array
Title: Attachments
Attachment management capabilities: view, create, and update.
Show Source
Nested Schema : Calendar Patterns
Type: array
Title: Calendar Patterns
The Calendar Patterns resource allows defining unique calendar patterns in a maintenance program. Patterns are used in a work requirement as the basis for creating a maintenance program forecast.
Show Source
Nested Schema : Work Requirements
Type: array
Title: Work Requirements
The Work Requirements resource allows defining unique work requirements in a maintenance program. Work requirements define how often maintenance will be due and what work will be required for one or more assets.
Show Source
Nested Schema : maintenancePrograms-attachments-item-response
Type: object
Show Source
Nested Schema : maintenancePrograms-calendarPatterns-item-response
Type: object
Show Source
  • Value that uniquely identifies a calendar pattern. The application generates this value when it creates a calendar pattern. The calendar pattern ID and its attributes can't be updated after its creation.
  • Links
  • Value of the specific numerical day in a month when a monthly calendar pattern is due. This value can't be updated after its creation.
  • Maximum Length: 30
    Name of the specific day of the week when a monthly calendar pattern is due. The name is used with an ordinal value to define which day in the month the monthly calendar pattern is due. This value can't be updated after its creation.
  • Maximum Length: 30
    Value that's used to define the specific ordinal day names, such as second Monday and last Monday. For each day of a week, the first, second, third, fourth, or last day of the month can be provided. This value can't be updated after its creation.
  • Title: Schedule Pattern
    Maximum Length: 120
    Name that uniquely identifies the calendar pattern in a maintenance program. This value can't be updated after its creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the daily calendar pattern is due during days that are identified as weekdays. If false, then the daily calendar pattern is due all seven days of the week. The default value is false. This value can't be updated after its creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Friday. If false, then the weekly calendar pattern isn't due on Friday. The default value is false. This value can't be updated after its creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Monday. If false, then the weekly calendar pattern isn't due on Monday. The default value is false. This value can't be updated after its creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Saturday. If false, then the weekly calendar pattern isn't due on Saturday. The default value is false. This value can't be updated after its creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Sunday. If false, then the weekly calendar pattern isn't due on Sunday. The default value is false. This value can't be updated after its creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Thursday. If false, then the weekly calendar pattern isn't due on Thursday. The default value is false. This value can't be updated after its creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Tuesday. If false, then the weekly calendar pattern isn't due on Tuesday. The default value is false. This value can't be updated after its creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Wednesday. If false, then the weekly calendar pattern isn't due on Wednesday. The default value is false. This value can't be updated after its creation.
  • Title: Frequency
    Maximum Length: 30
    Value that specifies the frequency of a calendar pattern. Valid values include ORA_DAILY, ORA_WEEKLY, ORA_MONTHLY, or ORA_YEARLY. The default value is ORA_WEEKLY. This value can't be updated after its creation.
  • Maximum Length: 30
    Value of the month in which a numerical date is due for a yearly calendar pattern. You must define the numerical date and ordinal value. This value can't be updated after its creation.
  • Value of the specific numerical date in a month for which a yearly calendar pattern is due. You must define the specific month. This value can't be updated after its creation.
  • Maximum Length: 30
    Value of the specific month for which a yearly calendar pattern is due. You must define the specific numerical date in the month. This value can't be updated after its creation.
  • Maximum Length: 30
    Name of the specific day of the week for which a yearly calendar pattern is due. The name is used with an ordinal value to define which day with a month the yearly calendar pattern is due. This value can't be updated after its creation.
  • Maximum Length: 30
    Value that's used to define the specific ordinal day names, such as second Monday and last Monday. For each day of a week, the first, second, third, fourth, or last day of the month can be provided with the weekday name. This value can't be updated after its creation.
Nested 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
    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.
  • Maximum Length: 255
    Alternate primary key for the logical hierarchy entity.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The detailed description of the logical hierarchy.
  • Value that uniquely identifies the Asset Route Business Object. This is defined as a special type of Asset Logical Hierarchy.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    The name of the logical hierarchy.
  • 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.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the asset item.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that indicates the default merge or suppress option for the maintenance program. Valid values are ORA_SUPPRESS or ORA_MERGE. The value is read only.
  • Read Only: true
    Maximum Length: 255
    Name of the default merge or suppress option for the maintenance program. The value is read only.
  • Title: Requirement Reference
    Maximum Length: 80
    Value for a reference to the work requirement. The optional value can be updated.
  • Read Only: true
    Maximum Length: 30
    Code used by the work order completion process to complete the assets that are part of the asset route. Valid values are Automatic (ORA_AUTOMATIC) or Manual (ORA_MANUAL).
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Meaning of the mode used in the work order completion process.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the assets included in the asset route can be skipped during the work order completion process.
  • Title: Status
    Read Only: true
    Maximum Length: 255
    Meaning of the status of the work requirement.
  • Title: Status Code
    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.
  • Read Only: true
    Maximum Length: 255
    Name that identifies the status of the affected asset.
  • Maximum Length: 30
    Forecast status of the affected asset.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Name that indicates whether the affected asset will be calculated from the forecast start date or the historical last completion date.
  • Maximum Length: 16
    Requirement initialization code for the affected asset.
  • 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: Calculated Rate
    Read Only: true
    Calculated average value of a specified number of active readings in history. This attribute is read-only.
  • 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.
  • Title: Method to Calculate Next Due
    Read Only: true
    Maximum Length: 255
    Meaning of the option code that specifies how the next due forecast interval is calculated. This is a read-only attribute.
  • Title: Daily Rate
    Read Only: true
    Expected average daily total of readings to be entered for a meter. This is a read-only attribute.
  • 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.
  • Title: Estimated Daily Interval
    Read Only: true
    Calculated ratio of the base interval to the daily utilization rate for a meter associated with a work requirement. This is a read-only attribute.
  • Links
  • Title: Meter Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the asset meter used to forecast a work requirement. Either the meter name or ID can be used in a POST, PATCH, or GET action. This is a read-only attribute.
  • 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.
  • Title: Meter Description
    Read Only: true
    Maximum Length: 240
    Description of the asset meter used to forecast a work requirement. Either the meter name or ID can be used in a POST, PATCH, or GET action. This is a read-only attribute.
  • Value that uniquely identifies the asset meter used to forecast a work requirement. Either the meter name or ID can be used in a POST, PATCH, or GET action. This is a read-only attribute.
  • 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.
  • Title: Meter Name
    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.
  • Title: Meter Entry
    Read Only: true
    Maximum Length: 255
    Meaning of the option code that specifies whether a meter reading is required for the work order. This is a read-only attribute.
  • Title: Meter Entry
    Read Only: true
    Maximum Length: 255
    Abbreviation of the option code that specifies whether a meter reading is required for the work order. This is a read-only attribute.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Name of the UOM for the asset meter used to forecast a work requirement. This is a read-only attribute.
  • Title: Meter UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation of the UOM for the asset meter used to forecast a work requirement. This is a read-only attribute.
Nested Schema : maintenancePrograms-workRequirements-workDefinitions-item-response
Type: object
Show Source
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Indicates the user-defined code for the maintenance work definition.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Indicates the description of the maintenance work definition.
  • 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.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the work definition has resequenced operations.
  • 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
findByAdvancedSearchQuery
Method used to perform a search on asset qualifications based on qualification requirements.
Back to Top

Examples

This example describes how to get all the maintenance programs.

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"

Example Response Body

The following example includes the contents of the response body in JSON format:
{    
"items": [
	{
		"Name": "REST_MP_HEADER_CAL_PATTERNS",
		"Code": "REST_MP_HEADER_CAL_PATTERNS",
		"MaintenanceProgramId": 300100179940471,
		"Description": "SINGLE PAYLOAD: HEADER AND 4 CALENDAR PATTERNS",
		"OrganizationId": 300100113363336,
		"OrganizationCode": "MNTALM",
		"OrganizationName": "Maintenance Organization for ALM",
		"SuppressMergeCode": "ORA_SUPPRESS",
		"SuppressMergeCodeDescription": "Suppress",
		"ActiveStartDate": "2018-12-01",
		"ActiveEndDate": null,
		"ReviewedBy": "Anonymous",
		"ReviewedOn": "2018-12-01",
		"ReviewComments": "Approved",
	       "ProgramTypeCode": "ORA_MAINTENANCE",
		"ProgramType": "Maintenance",
		"ProgramSubTypeCode": "User_Defined_Code_A",
		"ProgramSubType": "User Defined Code A",
		"AllowGlobalAssetsFlag": true,
		"ProgramReference": "Program Reference 123ABC",
		"ForecastWindowInDays": 90,
		"WorkOrderWindowInDays": 30,
		"WorkOrderStartTime": "7:30",
		"WorkOrderTimezoneCode": "America/New_York",
		"WorkOrderTimezone": "US Eastern Time"
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471",
			"name": "maintenancePrograms",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471",
			"name": "maintenancePrograms",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements",
			"name": "workRequirements",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/calendarPatterns",
			"name": "calendarPatterns",
			"kind": "collection"
		}
		]
	},
	{
		"Name": "REST_MP_HEADER_ONLY",
		"Code": "REST_MP_HEADER_ONLY",
		"MaintenanceProgramId": 300100179925454,
		"Description": "SINGLE PAYLOAD: HEADER ONLY",
		"OrganizationId": 300100113363336,
		"OrganizationCode": "MNTALM",
		"OrganizationName": "Maintenance Organization for ALM",
		"SuppressMergeCode": "ORA_SUPPRESS",
		"SuppressMergeCodeDescription": "Suppress",
		"ActiveStartDate": "2018-12-15",
		"ActiveEndDate": null,
		"ReviewedBy": "Anonymous",
		"ReviewedOn": "2018-12-01",
		"ReviewComments": "Approved",
		"ProgramTypeCode": "ORA_MAINTENANCE",
		"ProgramType": "Maintenance",
		"ProgramSubTypeCode": null,
		"ProgramSubType": null,
		"AllowGlobalAssetsFlag": false,
		"ProgramReference": null,
		"ForecastWindowInDays": null,
		"WorkOrderWindowInDays": null,
		"WorkOrderStartTime": null,
		"WorkOrderTimezoneCode": null,
		"WorkOrderTimezone": null
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179925454",
			"name": "maintenancePrograms",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179925454",
			"name": "maintenancePrograms",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179925454/child/workRequirements",
			"name": "workRequirements",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179925454/child/calendarPatterns",    
			"name": "calendarPatterns",
			"kind": "collection"
		}
		]
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/",
		"name": "maintenancePrograms",
		"kind": "collection"
	}
	]
}
Back to Top