Jump to

• Request
• Response
• Examples

Get all

get

/fscmRestApi/resources/11.13.18.05/maintenanceForecasts

Request

Query Parameters

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

  • PrimaryKey
    Finder Variables
    • ForecastId; integer;
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssetDescription; string
  • AssetId; integer
  • AssetLocation; string
  • AssetLocationCode; string
  • AssetNumber; string
  • AssetOperatingOrgCode; string
  • AssetOperatingOrgId; integer
  • AssetSerialNumber; string
  • CreatedBy; string
  • CreationDate; string
  • ForecastDueDate; string
  • ForecastId; integer
  • ForecastOrganizationCode; string
  • ForecastOrganizationId; integer
  • ForecastStatus; string
  • ForecastStatusCode; string
  • GlobalAssetsFlag; boolean
  • ItemId; integer
  • ItemNumber; string
  • LastUpdateDate; string
  • LastUpdatedBy; string
  • MultipleForecastLinesFlag; boolean
  • ProgramCode; string
  • ProgramId; integer
  • ProgramName; string
  • ProgramOrganizationCode; string
  • ProgramOrganizationId; integer
  • ProgramReference; string
  • ProgramSubType; string
  • ProgramSubTypeCode; string
  • ProgramType; string
  • ProgramTypeCode; string
  • RequestedWoOrganizationCode; string
  • RequestedWoOrganizationId; integer
  • RequestedWoStartDate; string
  • RequirementName; string
  • RootAssetId; integer
  • RootAssetNumber; string
  • SkipDueDateFlag; boolean
  • WarrantyRepairFlag; boolean
  • WorkOrderId; integer
  • WorkOrderNumber; string
  • WorkOrderOrganizationCode; string
  • WorkOrderOrganizationId; integer
  • WorkOrderStartDate; string
  • WorkOrderStatus; string
  • WorkOrderStatusCode; string
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  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 : maintenanceForecasts

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/maintenanceForecasts-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object maintenanceForecasts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/maintenanceForecasts-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 : maintenanceForecasts-item-response

Type: object

Show Source

• AssetDescription: string
  Title: Asset Description

  Read Only: true

  Maximum Length: 240
• AssetId: integer (int64)
  Title: Asset ID

  Read Only: true
• AssetLocation: string
  Title: Asset Location

  Read Only: true

  Maximum Length: 80
• AssetLocationCode: string
  Title: Location Organization Code

  Read Only: true

  Maximum Length: 80
• AssetNumber: string
  Title: Asset Number

  Read Only: true

  Maximum Length: 80
• AssetOperatingOrgCode: string
  Title: Operating Organization

  Read Only: true

  Maximum Length: 18
• AssetOperatingOrgId: integer (int64)
  Title: Operating Organization ID

  Read Only: true
• AssetSerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• ForecastDueDate: string (date)
  Title: Due Date

  Read Only: true
• ForecastId: integer (int64)
  Title: Forecast Id

  Read Only: true
• forecastLines: array Forecast Lines
  Title: Forecast Lines
• ForecastOrganizationCode: string
  Title: Forecast Organization

  Read Only: true

  Maximum Length: 18
• ForecastOrganizationId: integer (int64)
  Title: Forecast Organization ID
• ForecastStatus: string
  Title: Forecast Status

  Read Only: true

  Maximum Length: 255
• ForecastStatusCode: string
  Title: Forecast Status Code

  Read Only: true

  Maximum Length: 255
• GlobalAssetsFlag: boolean
  Title: Allow assets from other organizations

  Read Only: true

  Maximum Length: 1
• ItemId: integer (int64)
  Title: Item ID

  Read Only: true
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultipleForecastLinesFlag: boolean
  Title: Work Requirement Name

  Read Only: true

  Maximum Length: 255
• ProgramCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30
• ProgramId: integer (int64)
  Title: Program Id

  Read Only: true
• ProgramName: string
  Title: Program Name

  Read Only: true

  Maximum Length: 120
• ProgramOrganizationCode: string
  Title: Program Organization

  Read Only: true

  Maximum Length: 18
• ProgramOrganizationId: integer (int64)
  Title: Program Organization ID

  Read Only: true
• ProgramReference: string
  Title: Program Reference

  Read Only: true

  Maximum Length: 80
• ProgramSubType: string
  Title: Program Subtype

  Read Only: true

  Maximum Length: 80
• ProgramSubTypeCode: string
  Title: Program Subtype Code

  Read Only: true

  Maximum Length: 30
• ProgramType: string
  Title: Program Type

  Read Only: true

  Maximum Length: 80
• ProgramTypeCode: string
  Title: Program Type Code

  Read Only: true

  Maximum Length: 30
• RequestedWoOrganizationCode: string
  Title: Requested Organization

  Read Only: true

  Maximum Length: 18
• RequestedWoOrganizationId: integer (int64)
  Title: Requested Organization Id
• RequestedWoStartDate: string (date-time)
  Title: Requested Start Date
• RequirementName: string
  Read Only: true

  Maximum Length: 255
• RootAssetId: integer (int64)
  Title: Root Asset ID

  Read Only: true
• RootAssetNumber: string
  Title: Root Asset Number

  Read Only: true

  Maximum Length: 80
• SkipDueDateFlag: boolean
  Title: Skip Due Date

  Maximum Length: 1
• WarrantyRepairFlag: boolean
  Title: Warranty Repair

  Read Only: true

  Maximum Length: 1
• WorkOrderId: integer (int64)
  Title: Work Order ID
• WorkOrderNumber: string
  Title: Work Order Number

  Read Only: true

  Maximum Length: 120
• WorkOrderOrganizationCode: string
  Title: Work Order Organization

  Read Only: true

  Maximum Length: 18
• WorkOrderOrganizationId: integer (int64)
  Title: Work Order Organization Id

  Read Only: true
• WorkOrderStartDate: string (date-time)
  Title: Work Order Planned Start Date

  Read Only: true
• WorkOrderStatus: string
  Title: Work Order Status

  Read Only: true

  Maximum Length: 120
• WorkOrderStatusCode: string
  Title: Work Order Status Code

  Read Only: true

  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "AssetDescription":{
            "title":"Asset Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetLocation":{
            "title":"Asset Location",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetLocationCode":{
            "title":"Location Organization Code",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetOperatingOrgCode":{
            "title":"Operating Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetOperatingOrgId":{
            "title":"Operating Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastDueDate":{
            "title":"Due Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastId":{
            "title":"Forecast Id",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ForecastOrganizationCode":{
            "title":"Forecast Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastOrganizationId":{
            "title":"Forecast Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ForecastStatus":{
            "title":"Forecast Status",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastStatusCode":{
            "title":"Forecast Status Code",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GlobalAssetsFlag":{
            "title":"Allow assets from other organizations",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleForecastLinesFlag":{
            "title":"Work Requirement Name",
            "maxLength":255,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramId":{
            "title":"Program Id",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program Name",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramOrganizationCode":{
            "title":"Program Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramOrganizationId":{
            "title":"Program Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramReference":{
            "title":"Program Reference",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramSubType":{
            "title":"Program Subtype",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramSubTypeCode":{
            "title":"Program Subtype Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramType":{
            "title":"Program Type",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeCode":{
            "title":"Program Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedWoOrganizationCode":{
            "title":"Requested Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedWoOrganizationId":{
            "title":"Requested Organization Id",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestedWoStartDate":{
            "title":"Requested Start Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RequirementName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootAssetId":{
            "title":"Root Asset ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RootAssetNumber":{
            "title":"Root Asset Number",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SkipDueDateFlag":{
            "title":"Skip Due Date",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyRepairFlag":{
            "title":"Warranty Repair",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "title":"Work Order ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order Number",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderOrganizationCode":{
            "title":"Work Order Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderOrganizationId":{
            "title":"Work Order Organization Id",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderStartDate":{
            "title":"Work Order Planned Start Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderStatus":{
            "title":"Work Order Status",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderStatusCode":{
            "title":"Work Order Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "forecastLines":{
            "title":"Forecast Lines",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/maintenanceForecasts-forecastLines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Forecast Lines

Type: array

Title: Forecast Lines

Show Source

• Array of: object maintenanceForecasts-forecastLines-item-response

{
    "title":"Forecast Lines",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/maintenanceForecasts-forecastLines-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 : maintenanceForecasts-forecastLines-item-response

Type: object

Show Source

• CalendarPattern: string
  Title: Calendar Pattern

  Read Only: true

  Maximum Length: 120
• CalendarPatternId: integer (int64)
  Title: Calendar Pattern ID
• CreateWoOption: string
  Title: Create Work Orders Option

  Read Only: true

  Maximum Length: 80
• CreateWorkOrderOptionCode: string
  Title: Create Work Orders Option Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_AUTOMATIC
• DayIntervalValue: number
  Title: Day Interval
• DueAtCycleInterval: number
  Title: Due at Cycle Interval
• DueAtMeterReading: number
  Title: Due at Meter Reading
• ForecastDueDate: string (date)
  Title: Due Date
• ForecastId: integer (int64)
  Title: Forecast Id

  Read Only: true
• ForecastInterval: string
  Title: Forecast Interval

  Read Only: true

  Maximum Length: 255
• ForecastLineId: integer (int64)
  Read Only: true
• ForecastMethod: string
  Title: Forecast Method

  Read Only: true

  Maximum Length: 255
• ForecastNextDueBy: string
  Title: Next Due Date Method

  Read Only: true

  Maximum Length: 255
• ForecastNextDueByCode: string
  Title: Next Due Date Code

  Read Only: true

  Maximum Length: 255
• ForecastUsingCycleFlag: boolean
  Title: Forecast using a cycle

  Read Only: true

  Maximum Length: 1
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterDailyRate: number
  Title: Meter Daily Rate
• MeterId: integer (int64)
  Title: Meter ID
• MeterName: string
  Title: Meter Name

  Read Only: true

  Maximum Length: 120
• NextWorkOrderOnlyFlag: boolean
  Title: Next work order only

  Maximum Length: 1
• NumberOfIntervals: number
  Title: Number of Intervals per Cycle

  Read Only: true
• RequirementEndDate: string (date)
  Title: End Date

  Read Only: true
• RequirementId: integer (int64)
  Title: Work Requirement
• RequirementName: string
  Title: Work Requirement Name

  Read Only: true

  Maximum Length: 120
• RequirementReference: string
  Title: Requirement Reference

  Read Only: true

  Maximum Length: 80
• RequirementStartDate: string (date)
  Title: Start Date

  Read Only: true
• RequirementType: string
  Title: Type

  Read Only: true

  Maximum Length: 80
• RequirementTypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30
• SuppressFlag: boolean
  Title: Suppress

  Read Only: true

  Maximum Length: 1
• WorkDefinitionCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30
• WorkDefinitionDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240
• WorkDefinitionId: integer (int64)
  Title: Work Definition

  Read Only: true
• WorkDefinitionName: string
  Title: Name

  Read Only: true

  Maximum Length: 120
• WorkDefinitionVersion: string
  Title: Version

  Read Only: true

  Maximum Length: 10

{
    "type":"object",
    "properties":{
        "CalendarPattern":{
            "title":"Calendar Pattern",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarPatternId":{
            "title":"Calendar Pattern ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreateWoOption":{
            "title":"Create Work Orders Option",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreateWorkOrderOptionCode":{
            "title":"Create Work Orders Option Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_AUTOMATIC",
            "x-queryable":true
        },
        "DayIntervalValue":{
            "title":"Day Interval",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "DueAtCycleInterval":{
            "title":"Due at Cycle Interval",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "DueAtMeterReading":{
            "title":"Due at Meter Reading",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastDueDate":{
            "title":"Due Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ForecastId":{
            "title":"Forecast Id",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ForecastInterval":{
            "title":"Forecast Interval",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ForecastLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ForecastMethod":{
            "title":"Forecast Method",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ForecastNextDueBy":{
            "title":"Next Due Date Method",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastNextDueByCode":{
            "title":"Next Due Date Code",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastUsingCycleFlag":{
            "title":"Forecast using a cycle",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterDailyRate":{
            "title":"Meter Daily Rate",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "MeterId":{
            "title":"Meter ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeterName":{
            "title":"Meter Name",
            "maxLength":120,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextWorkOrderOnlyFlag":{
            "title":"Next work order only",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfIntervals":{
            "title":"Number of Intervals per Cycle",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementEndDate":{
            "title":"End Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementId":{
            "title":"Work Requirement",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequirementName":{
            "title":"Work Requirement Name",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementReference":{
            "title":"Requirement Reference",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementStartDate":{
            "title":"Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementType":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SuppressFlag":{
            "title":"Suppress",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "title":"Work Definition",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionVersion":{
            "title":"Version",
            "maxLength":10,
            "type":"string",
            "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"
            }
        }
    }
}

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."
        }
    }
}

Links

generateWorkRequirementForecasts

Operation: /fscmRestApi/resources/11.13.18.05/maintenanceForecasts/action/generateWorkRequirementForecasts

manageForecastWorkOrders

Operation: /fscmRestApi/resources/11.13.18.05/maintenanceForecasts/action/manageForecastWorkOrders

Back to Top

Examples

This example describes how to get all forecast due dates for maintenance programs.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/maintenanceForecasts"

Example Response Body

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

{
    "items": [
        {
            "ForecastId": 20354,
            "ForecastStatusCode": "ORA_PLANNED",
            "ForecastStatus": "Planned",
            "ProgramOrganizationId": 300100113363336,
            "ProgramOrganizationCode": "OPS_ORG_A",
            "ProgramId": 300100583272981,
            "ProgramCode": "MAINTENANCE_PROGRAM",
            "ProgramName": "MAINTENANCE_PROGRAM",
            "ProgramTypeCode": "ORA_MAINTENANCE",
            "ProgramType": "Maintenance",
            "ProgramSubTypeCode": "Subtype 1",
            "ProgramSubType": "Subtype 1 M",
            "ProgramReference": "PREF123",
            "GlobalAssetsFlag": true,
            "RequirementName": "ACO_WR_1",
            "ItemId": 300100581367310,
            "ItemNumber": "ALM-MX-ITEM-001",
            "AssetId": 300100581367872,
            "AssetNumber": "ALM_ASSET_002",
            "AssetDescription": "ALM-MX-ITEM-001-DESC",
            "AssetSerialNumber": "ALM_ASSET_002",
            "AssetOperatingOrgId": 300100113363336,
            "AssetOperatingOrgCode": "OPS_ORG_A",
            "AssetLocationCode": "ORA_UNKNOWN",
            "AssetLocation": "Unknown",
            "RootAssetId": 300100581367872,
            "RootAssetNumber": "ALM_ASSET_002",
            "ForecastDueDate": "2023-08-08",
            "SkipDueDateFlag": false,
            "ForecastOrganizationId": 300100113363336,
            "ForecastOrganizationCode": "OPS_ORG_A",
            "RequestedWoStartDate": null,
            "RequestedWoOrganizationId": 300100113363336,
            "RequestedWoOrganizationCode": "OPS_ORG_A",
            "WorkOrderId": null,
            "WorkOrderNumber": null,
            "WorkOrderOrganizationId": null,
            "WorkOrderOrganizationCode": null,
            "WorkOrderStartDate": null,
            "WorkOrderStatusCode": null,
            "WorkOrderStatus": null,
            "WarrantyRepairFlag": false,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-08-01T20:46:40+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-08-01T20:46:40+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20354",
                    "name": "maintenanceForecasts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20354",
                    "name": "maintenanceForecasts",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20354/child/forecastLines",
                    "name": "forecastLines",
                    "kind": "collection"
                }
            ]
        },
        {
            "ForecastId": 20355,
            "ForecastStatusCode": "ORA_PLANNED",
            "ForecastStatus": "Planned",
            "ProgramOrganizationId": 300100113363336,
            "ProgramOrganizationCode": "OPS_ORG_A",
            "ProgramId": 300100583272981,
            "ProgramCode": "MAINTENANCE_PROGRAM",
            "ProgramName": "MAINTENANCE_PROGRAM",
            "ProgramTypeCode": "ORA_MAINTENANCE",
            "ProgramType": "Maintenance",
            "ProgramSubTypeCode": "Subtype 1",
            "ProgramSubType": "Subtype 1 M",
            "ProgramReference": "PREF123",
            "GlobalAssetsFlag": true,
            "RequirementName": "ACO_WR_1",
            "ItemId": 300100581367310,
            "ItemNumber": "ALM-MX-ITEM-001",
            "AssetId": 300100581367872,
            "AssetNumber": "ALM_ASSET_002",
            "AssetDescription": "ALM-MX-ITEM-001-DESC",
            "AssetSerialNumber": "ALM_ASSET_002",
            "AssetOperatingOrgId": 300100113363336,
            "AssetOperatingOrgCode": "OPS_ORG_A",
            "AssetLocationCode": "ORA_UNKNOWN",
            "AssetLocation": "Unknown",
            "RootAssetId": 300100581367872,
            "RootAssetNumber": "ALM_ASSET_002",
            "ForecastDueDate": "2023-08-15",
            "SkipDueDateFlag": false,
            "ForecastOrganizationId": 300100113363336,
            "ForecastOrganizationCode": "OPS_ORG_A",
            "RequestedWoStartDate": null,
            "RequestedWoOrganizationId": 300100113363336,
            "RequestedWoOrganizationCode": "OPS_ORG_A",
            "WorkOrderId": null,
            "WorkOrderNumber": null,
            "WorkOrderOrganizationId": null,
            "WorkOrderOrganizationCode": null,
            "WorkOrderStartDate": null,
            "WorkOrderStatusCode": null,
            "WorkOrderStatus": null,
            "WarrantyRepairFlag": false,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-08-01T20:46:40+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-08-01T20:46:40+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20355",
                    "name": "maintenanceForecasts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20355",
                    "name": "maintenanceForecasts",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20355/child/forecastLines",
                    "name": "forecastLines",
                    "kind": "collection"
                }
            ]
        },
        {
            "ForecastId": 20356,
            "ForecastStatusCode": "ORA_PLANNED",
            "ForecastStatus": "Planned",
            "ProgramOrganizationId": 300100113363336,
            "ProgramOrganizationCode": "OPS_ORG_A",
            "ProgramId": 300100583272981,
            "ProgramCode": "MAINTENANCE_PROGRAM",
            "ProgramName": "MAINTENANCE_PROGRAM",
            "ProgramTypeCode": "ORA_MAINTENANCE",
            "ProgramType": "Maintenance",
            "ProgramSubTypeCode": "Subtype 1",
            "ProgramSubType": "Subtype 1 M",
            "ProgramReference": "PREF123",
            "GlobalAssetsFlag": true,
            "RequirementName": "ACO_WR_1",
            "ItemId": 300100581367310,
            "ItemNumber": "ALM-MX-ITEM-001",
            "AssetId": 300100581367872,
            "AssetNumber": "ALM_ASSET_002",
            "AssetDescription": "ALM-MX-ITEM-001-DESC",
            "AssetSerialNumber": "ALM_ASSET_002",
            "AssetOperatingOrgId": 300100113363336,
            "AssetOperatingOrgCode": "OPS_ORG_A",
            "AssetLocationCode": "ORA_UNKNOWN",
            "AssetLocation": "Unknown",
            "RootAssetId": 300100581367872,
            "RootAssetNumber": "ALM_ASSET_002",
            "ForecastDueDate": "2023-08-22",
            "SkipDueDateFlag": false,
            "ForecastOrganizationId": 300100113363336,
            "ForecastOrganizationCode": "OPS_ORG_A",
            "RequestedWoStartDate": null,
            "RequestedWoOrganizationId": 300100113363336,
            "RequestedWoOrganizationCode": "OPS_ORG_A",
            "WorkOrderId": null,
            "WorkOrderNumber": null,
            "WorkOrderOrganizationId": null,
            "WorkOrderOrganizationCode": null,
            "WorkOrderStartDate": null,
            "WorkOrderStatusCode": null,
            "WorkOrderStatus": null,
            "WarrantyRepairFlag": false,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-08-01T20:46:40+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-08-01T20:46:40+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20356",
                    "name": "maintenanceForecasts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20356",
                    "name": "maintenanceForecasts",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/maintenanceForecasts/20356/child/forecastLines",
                    "name": "forecastLines",
                    "kind": "collection"
                }
            ]
        }
    ]
}

Back to Top