Jump to

• Request
• Response
• Examples

Get one program

get

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

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : maintenancePrograms-item-response

Type: object

Show Source

• ActiveEndDate: string (date)
  Title: End Date

  Date when the maintenance program stops forecasting. The end date is optional and can be updated after its creation.
• ActiveStartDate: string (date)
  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.
• AllowGlobalAssetsFlag: boolean
  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.
• calendarPatterns: array 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.
• Code: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the maintenance program. The code can be updated after its creation.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the maintenance program. The description 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 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaintenanceProgramId: 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.
• Name: string
  Title: Name

  Maximum Length: 120

  Name that identifies the maintenance program. The name can be updated after its creation.
• OrganizationCode: string
  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.
• OrganizationId: integer (int64)
  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
  Title: Program Reference

  Maximum Length: 80

  Value for a reference to the program. The optional value can be updated.
• ProgramSubType: string
  Title: Program Subtype

  Read Only: true

  Maximum Length: 80

  Name that identifies the user-defined subtype of maintenance program. This value is read-only.
• ProgramSubTypeCode: string
  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.
• ProgramType: string
  Title: Program Type

  Read Only: true

  Maximum Length: 80

  Name that identifies the user-defined type of maintenance program. This value is read-only.
• ProgramTypeCode: string
  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.
• ReviewComments: string
  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.
• ReviewedBy: string
  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.
• ReviewedOn: string (date)
  Title: Review Date

  Date when the user most recently reviewed the program. The date can be updated after its creation.
• SuppressMergeCode: string
  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.
• SuppressMergeCodeDescription: string
  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.
• WorkOrderStartTime: string
  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.
• WorkOrderTimezone: string
  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.
• WorkOrderTimezoneCode: string
  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.
• WorkOrderWindowInDays: integer (int32)
  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.
• workRequirements: array 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.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReviewedOn":{
            "title":"Review Date",
            "type":"string",
            "description":"Date when the user most recently reviewed the program. The date can be updated after its creation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the maintenance program. The description can be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramReference":{
            "title":"Program Reference",
            "maxLength":"80",
            "type":"string",
            "description":"Value for a reference to the program. The optional value can be updated.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name that identifies the maintenance program. The name can be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkOrderTimezoneCode":{
            "title":"Work Order Time Zone",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintenanceProgramId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramSubType":{
            "title":"Program Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"Name that identifies the user-defined subtype of maintenance program.  This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramSubTypeCode":{
            "title":"Program Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReviewedBy":{
            "title":"Program Reviewed By",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the user who most recently reviewed the program. The name can be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramType":{
            "title":"Program Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name that identifies the user-defined type of maintenance program. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the maintenance program stops forecasting. The end date is optional and can be updated after its creation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastWindowInDays":{
            "title":"Forecast Window in Days",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SuppressMergeCode":{
            "title":"Concurrent Requirements",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_SUPPRESS",
            "x-queryable":true
        },
        "ProgramTypeCode":{
            "title":"Program Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "calendarPatterns":{
            "title":"Calendar Patterns",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/maintenancePrograms-calendarPatterns-item-response"
            }
        },
        "WorkOrderWindowInDays":{
            "title":"Work Order Window in Days",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ReviewComments":{
            "title":"Review Comments",
            "maxLength":"240",
            "type":"string",
            "description":"Comments provided by the user who most recently reviewed the program. The comments can be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "Code":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the maintenance program. The code can be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the maintenance program is eligible to start forecasting. The start date is required and can be updated after its creation.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "workRequirements":{
            "title":"Work Requirements",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/maintenancePrograms-workRequirements-item-response"
            }
        },
        "WorkOrderStartTime":{
            "title":"Work Order Start Time",
            "maxLength":"5",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderTimezone":{
            "title":"Work Order Time Zone",
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowGlobalAssetsFlag":{
            "title":"Allow assets from other organizations",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SuppressMergeCodeDescription":{
            "title":"Concurrent Requirements",
            "type":"string",
            "description":"Name that describes if concurrent requirements will merge or suppress during work order creation. This value is derived from the suppress merge code.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object maintenancePrograms-calendarPatterns-item-response

{
    "title":"Calendar Patterns",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/maintenancePrograms-calendarPatterns-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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

• Array of: object maintenancePrograms-workRequirements-item-response

{
    "title":"Work Requirements",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/maintenancePrograms-workRequirements-item-response"
    }
}

Nested Schema : maintenancePrograms-calendarPatterns-item-response

Type: object

Show Source

• CalendarPatternId: integer (int64)
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• MonthlySpecificDay: integer (int32)
  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.
• MonthlyWeekday: string
  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.
• MonthlyWeekdayOrdinal: string
  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.
• Name: string
  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.
• RepeatDailyEveryWeekdayFlag: boolean
  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.
• RepeatWeeklyDayFridayFlag: boolean
  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.
• RepeatWeeklyDayMondayFlag: boolean
  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.
• RepeatWeeklyDaySaturdayFlag: boolean
  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.
• RepeatWeeklyDaySundayFlag: boolean
  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.
• RepeatWeeklyDayThursdayFlag: boolean
  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.
• RepeatWeeklyDayTuesdayFlag: boolean
  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.
• RepeatWeeklyDayWednesdayFlag: boolean
  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.
• Type: string
  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.
• YearlyMonth: string
  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.
• YearlySpecificDay: integer (int32)
  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.
• YearlySpecificMonth: string
  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.
• YearlyWeekday: string
  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.
• YearlyWeekdayOrdinal: string
  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.

{
    "type":"object",
    "properties":{
        "RepeatDailyEveryWeekdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatWeeklyDaySundayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MonthlyWeekdayOrdinal":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatWeeklyDayFridayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatWeeklyDayTuesdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlyMonth":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlySpecificMonth":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatWeeklyDaySaturdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlyWeekdayOrdinal":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MonthlyWeekday":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlySpecificDay":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Schedule Pattern",
            "maxLength":"120",
            "type":"string",
            "description":"Name that uniquely identifies the calendar pattern in a maintenance program. This value can't be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "RepeatWeeklyDayWednesdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "RepeatWeeklyDayThursdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MonthlySpecificDay":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "CalendarPatternId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RepeatWeeklyDayMondayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlyWeekday":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : maintenancePrograms-workRequirements-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ConditionBasedFlag":{
            "title":"Condition event",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "WorkOrderStatus":{
            "title":"Work Order Status",
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "conditionEvents":{
            "title":"Condition Events",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/maintenancePrograms-workRequirements-conditionEvents-item-response"
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status code of the work requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeAssets":{
            "title":"Include Assets",
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the option that enables users to select if assets in an item-based work requirement are automatically or manually included.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DayBasedFlag":{
            "title":"Day Based Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name that uniquely identifies the work requirement. This value can be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "meters":{
            "title":"Meters",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/maintenancePrograms-workRequirements-meters-item-response"
            }
        },
        "WorkOrderStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreateWorkOrderOption":{
            "title":"Create Work Orders Option",
            "maxLength":"80",
            "type":"string",
            "description":"Name that identifies if work orders will be automatically or manually created for the work requirement. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CalendarPatternId":{
            "title":"Schedule Pattern",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalendarPatternName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "IntervalsInTheCycle":{
            "title":"Number of Intervals per Cycle",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreateWorkOrderOptionCode":{
            "title":"Create Work Orders Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_AUTOMATIC",
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the work requirement stops forecasting. This value can be updated after its creation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DayCalculateNextDue":{
            "title":"Method to Calculate Next Due",
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the method used to calculate the next due occurrence of the day interval in the work requirement forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the status of the work requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "NextWorkOrderOnlyFlag":{
            "title":"Next Work Order Only",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ForecastWindowInDays":{
            "title":"Forecast Window in Days",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MeterBasedFlag":{
            "title":"Meter interval",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SuppressMergeCode":{
            "title":"Concurrent Requirements",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DayCalculateNextDueCode":{
            "title":"Method to Calculate Next Due",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the method used to calculate the next due occurrence of the day interval in the work requirement forecast.",
            "nullable":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_ASSET",
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Asset or Item",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DayInterval":{
            "title":"Day Interval",
            "type":"number",
            "description":"Number of days between cycle intervals in the forecast when day interval is used.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderWindowInDays":{
            "title":"Work Order Window in Days",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "WorkOrderFirmFlag":{
            "title":"Firm Work Orders",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "workDefinitions":{
            "title":"Work Definitions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/maintenancePrograms-workRequirements-workDefinitions-item-response"
            }
        },
        "AllowWorkOrdersFlag":{
            "title":"Allow Work Orders",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "IncludeAssetsCode":{
            "title":"Include Assets Code",
            "maxLength":"30",
            "type":"string",
            "description":"0ption that enables users to select if assets in an item-based work requirement are automatically or manually included.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkRequirementId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HistoricalLastCompleteInterval":{
            "title":"Historical Last Completed Interval",
            "type":"number",
            "description":"Historical cycle interval of accomplishment of the work requirement from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideSuppressMergeFlag":{
            "title":"Override for this requirement",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the work requirement begins forecasting. This value can be updated after its creation.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RequirementReference":{
            "title":"Requirement Reference",
            "maxLength":"80",
            "type":"string",
            "description":"Value for a reference to the work requirement. The optional value can be updated.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the option that enables users to select if the work requirement is associated with an asset or an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrdersCreatedFlag":{
            "title":"Work Orders Created",
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ForecastUsingACycleFlag":{
            "title":"Forecast using a cycle",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "affectedAssets":{
            "title":"Affected Assets",
            "type":"array",
            "description":"The Affected Assets resource allows defining which assets are to be included or excluded from the forecast of a work requirement.",
            "items":{
                "$ref":"#/components/schemas/maintenancePrograms-workRequirements-affectedAssets-item-response"
            }
        },
        "HistoricalLastCompletedDate":{
            "title":"Historical Last Completed Date",
            "type":"string",
            "description":"Historical date of accomplishment of the work requirement from an external system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarBasedFlag":{
            "title":"Calendar pattern",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "WorkOrderPriority":{
            "title":"Work Order Priority",
            "type":"number",
            "description":"Number that indicates the priority of the work order. This attribute is optional when creating the work order.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressMergeCodeDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that describes if concurrent requirements will merge or suppress during work order creation. This value is derived from the suppress merge code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object maintenancePrograms-workRequirements-affectedAssets-item-response

{
    "title":"Affected Assets",
    "type":"array",
    "description":"The Affected Assets resource allows defining which assets are to be included or excluded from the forecast of a work requirement.",
    "items":{
        "$ref":"#/components/schemas/maintenancePrograms-workRequirements-affectedAssets-item-response"
    }
}

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

• Array of: object maintenancePrograms-workRequirements-conditionEvents-item-response

{
    "title":"Condition Events",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/maintenancePrograms-workRequirements-conditionEvents-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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

• Array of: object maintenancePrograms-workRequirements-meters-item-response

{
    "title":"Meters",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/maintenancePrograms-workRequirements-meters-item-response"
    }
}

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

• Array of: object maintenancePrograms-workRequirements-workDefinitions-item-response

{
    "title":"Work Definitions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/maintenancePrograms-workRequirements-workDefinitions-item-response"
    }
}

Nested Schema : maintenancePrograms-workRequirements-affectedAssets-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "OperatingOrganizationId":{
            "title":"Operating Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the operating organization of the asset. This value is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetDescription":{
            "title":"Asset Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset in a work requirement. This value can't be updated,.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowWorkOrdersFlag":{
            "title":"Allow Work Orders",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoricalLastCompleteInterval":{
            "title":"Historical Last Completed Interval",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetStatus":{
            "title":"Asset Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the asset status code. This value can't be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OperatingOrganization":{
            "title":"Operating Organization",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the operating organization of the asset. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the asset in a work requirement. This value can't be updated,.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintenanceOrganizationId":{
            "title":"Maintenance Organization",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrdersCreatedFlag":{
            "title":"Work Orders Created",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetStatusCode":{
            "title":"Asset Status Code",
            "maxLength":"11",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastStartDate":{
            "title":"Forecasted Start Date",
            "type":"string",
            "description":"Date when the work requirement begins forecasting the asset. This value can be updated after its creation until the first work order is created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Serial number of the asset in a work requirement. This value can't be updated,.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreateWorkOrderOption":{
            "title":"Create Work Orders Option",
            "maxLength":"80",
            "type":"string",
            "description":"Name that identifies if work orders will be automatically or manually created for the work requirement. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoricalLastCompletedDate":{
            "title":"Historical Last Completed Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MaintenanceOrganization":{
            "title":"Maintenance Organization",
            "maxLength":"18",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreateWorkOrderOptionCode":{
            "title":"Create Work Orders Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies the asset in a work requirement This value can't be updated,.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : maintenancePrograms-workRequirements-conditionEvents-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "EventCodeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConditionEventId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EventCodeDescription":{
            "title":"Description",
            "maxLength":"540",
            "type":"string",
            "description":"Description of the condition event code. This value is read-only and can't be updated after its creation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCodeName":{
            "title":"Name",
            "maxLength":"540",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : maintenancePrograms-workRequirements-meters-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "DisabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BaseInterval":{
            "title":"Base Interval",
            "type":"number",
            "description":"Value of the interval that's used to calculate how often the forecast is due. This value can be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "CalculateNextDueCode":{
            "title":"Method to Calculate Next Due",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "MeterIntervalId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : maintenancePrograms-workRequirements-workDefinitions-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "DisabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "WorkDefinitionRequirementId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DueAtCycleInterval":{
            "title":"Due at Cycle Interval",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkDefinitionMaintenanceNameId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RepeatsInCycleFlag":{
            "title":"Repeats in Cycle",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

calendarPatterns

Operation: /fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/calendarPatterns

Parameters:

• MaintenanceProgramId: $request.path.MaintenanceProgramId

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.

workRequirements

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

Parameters:

• MaintenanceProgramId: $request.path.MaintenanceProgramId

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.

Back to Top

Examples

This example describes how to get one maintenance program.

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"

Example Response Body

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

{
	"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-01",
	"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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"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"
	}
	]
}

Back to Top