Maintenance Programs
maintenancePrograms Based on 26C
Create, change and look up Maintenance Programs, with calendar patterns and work requirements. Actions include find by advanced search query and generate program forecasts.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)5 actions
- Record key
MaintenanceProgramId- Required on create
CodeNameOrganizationId- At a glance
- 33 fields1 finders7 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/maintenancePrograms?fields=ActiveEndDate,ActiveStartDate,AllowGlobalAssetsFlag,Code,CountOfAffectedAssets&limit=25&onlyData=true
{
"items": [
{
"ActiveEndDate": "2026-01-31",
"ActiveStartDate": "2026-01-31",
"AllowGlobalAssetsFlag": false,
"Code": "<string, max 30>",
"CountOfAffectedAssets": 0
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's 26C REST specification.
Fields 33
| Attribute | Type | Use |
|---|---|---|
ActiveEndDate | date | Optional on createUpdatableSearchable |
ActiveStartDate | date | Optional on createUpdatableSearchable |
AllowGlobalAssetsFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
Code | text · max 30 | Required on createUpdatableSearchable |
CountOfAffectedAssets | number | Read-only |
CountOfOpenWorkOrders | number | Read-only |
CountOfWorkRequirements | number | Read-only |
Description | text · max 240 | Optional on createUpdatableSearchable |
ForecastWindowInDays | number | Optional on createUpdatableSearchable |
InProcessFlag | yes/no · max 1 | Read-onlySearchable |
LastForecastDate | date | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
MaintenanceProgramId | number | Optional on createUpdatableSearchable |
Name | text · max 120 | Required on createUpdatableSearchable |
OrganizationCode | text | Optional on createSearchable |
OrganizationId | number | Required on createUpdatableSearchable |
OrganizationName | text | Optional on createSearchable |
ProgramReference | text · max 80 | Optional on createUpdatableSearchable |
ProgramSubType | text · max 80 | Read-onlySearchable |
ProgramSubTypeCode | text · max 30 | Optional on createUpdatableSearchable |
ProgramType | text · max 80 | Read-onlySearchable |
ProgramTypeCode | text · max 30 | Optional on createUpdatableSearchable |
ReviewComments | text · max 240 | Optional on createUpdatableSearchable |
ReviewedBy | text · max 80 | Optional on createUpdatableSearchable |
ReviewedOn | date | Optional on createUpdatableSearchable |
SuppressMergeCode | text · max 30 · default ORA_SUPPRESS | Optional on createUpdatableSearchable |
SuppressMergeCodeDescription | text | Optional on createUpdatableSearchable |
WorkOrderStartTime | text · max 5 | Optional on createUpdatableSearchable |
WorkOrderTimezone | text · max 255 | Read-onlySearchable |
WorkOrderTimezoneCode | text · max 30 | Optional on createUpdatableSearchable |
WorkOrderWindowInDays | number | Optional on createUpdatableSearchable |
WorkOrdersCreatedFlag | yes/no · max 1 | Read-only |
WorkRequirementsCreatedFlag | yes/no · max 1 | Read-only |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByOrganizationId·BindOrganizationId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 7
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/<name>. Add them to a GET with expand.
attachmentsGET · POST · PATCH · DELETE Image Attachments · 34 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionPrimaryCategoryFlagTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamecalendarPatternsGET · POST Calendar Patterns · 19 fieldsCalendarPatternIdMonthlySpecificDayMonthlyWeekdayMonthlyWeekdayOrdinalNameRepeatDailyEveryWeekdayFlagRepeatWeeklyDayFridayFlagRepeatWeeklyDayMondayFlagRepeatWeeklyDaySaturdayFlagRepeatWeeklyDaySundayFlagRepeatWeeklyDayThursdayFlagRepeatWeeklyDayTuesdayFlagRepeatWeeklyDayWednesdayFlagTypeYearlyMonthYearlySpecificDayYearlySpecificMonthYearlyWeekdayYearlyWeekdayOrdinalworkRequirementsGET · POST · PATCH · DELETE Work Requirements · 52 fieldsActiveEndDateActiveStartDateAllowWorkOrdersFlagAssetIdAssetNumberCalendarBasedFlagCalendarPatternIdCalendarPatternNameConditionBasedFlagCreateWorkOrderOptionCreateWorkOrderOptionCodeDayBasedFlagDayCalculateNextDueDayCalculateNextDueCodeDayIntervalForecastUsingACycleFlagForecastWindowInDaysHierarchyCodeHierarchyDescriptionHierarchyIdHierarchyNameHistoricalLastCompleteIntervalHistoricalLastCompletedDateIncludeAssetsIncludeAssetsCodeIntervalsInTheCycleInventoryItemIdInventoryItemNumberItemDescriptionMeterBasedFlagNameNextWorkOrderOnlyFlagOverrideSuppressMergeFlagProgramSuppressMergeCodeProgramSuppressMergeCodeDescriptionRequirementReferenceRouteCompletionCodeRouteCompletionMeaningRouteSkipAllowedFlagStatusStatusCodeSuppressMergeCodeSuppressMergeCodeDescriptionTypeTypeCodeWorkOrderFirmFlagWorkOrderPriorityWorkOrderStatusWorkOrderStatusCodeWorkOrderWindowInDaysWorkOrdersCreatedFlagWorkRequirementIdaffectedAssetsGET · POST · PATCH Affected Assets · 21 fieldsAllowWorkOrdersFlagAssetDescriptionAssetIdAssetNumberAssetStatusAssetStatusCodeCreateWorkOrderOptionCreateWorkOrderOptionCodeForecastOptionForecastOptionCodeForecastStartDateHistoricalLastCompleteIntervalHistoricalLastCompletedDateIntializeOptionIntializeOptionCodeMaintenanceOrganizationMaintenanceOrganizationIdOperatingOrganizationOperatingOrganizationIdSerialNumberWorkOrdersCreatedFlagconditionEventsGET · POST · PATCH · DELETE Condition Events · 5 fieldsConditionEventIdEventCodeEventCodeDescriptionEventCodeIdEventCodeNamemetersGET · POST · PATCH · DELETE Meters · 17 fieldsBaseIntervalCalculateNextDueCodeCalculateNextDueMeaningCalculatedUtilizationRateDailyUtilizationRateDisabledFlagEstimatedDailyIntervalMeterCodeMeterDefinitionIdMeterDescriptionMeterIdMeterIntervalIdNameRecordAtWoCompletionRecordAtWoCompletionCodeUOMCodeUnitOfMeasureworkDefinitionsGET · POST · PATCH · DELETE Work Definitions · 10 fieldsCodeDescriptionDisabledFlagDueAtCycleIntervalNameRepeatsInCycleFlagResequenceFlagWorkDefinitionIdWorkDefinitionMaintenanceNameIdWorkDefinitionRequirementId
Actions 5
POST …/action/findByAdvancedSearchQuery·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/action/generateProgramForecasts·organizationIdprogramIdListPOST …/action/generateProgramWorkOrders·organizationIdprogramIdListPOST …/{MaintenanceProgramId}/child/workRequirements/{WorkRequirementId}/action/excludeAllAffectedAssetsPOST …/{MaintenanceProgramId}/child/workRequirements/{WorkRequirementId}/action/includeAllAffectedAssets
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/maintenanceProgramsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByOrganizationIdfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:ActiveEndDate, notactiveenddate. - 10 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.