REST API for Oracle Fusion Cloud SCM

Get all forecast line due dates

get

/fscmRestApi/resources/11.13.18.05/maintenanceForecasts/{ForecastId}/child/forecastLines/{ForecastLineId}

Request

Path Parameters

ForecastId(required): integer(int64)

Value that uniquely identifies the forecast due date for a work requirement and asset in a maintenance program. This value is read-only.
ForecastLineId(required): integer(int64)

Value that uniquely identifies the forecast line for a work requirement and asset in a maintenance program. This value is read-only.

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.

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.

Root Schema : maintenanceForecasts-forecastLines-item-response

Type: object

Show Source

CalendarPattern: string

Title: Calendar Pattern

Read Only: true

Maximum Length: 120

Name of the calendar pattern for the forecasted due date. This value is read-only.
CalendarPatternId: integer (int64)

Title: Calendar Pattern ID

Value that uniquely identifies the calendar pattern for the forecasted due date. This value is read-only.
CreateWoOption: string

Title: Create Work Orders Option

Read Only: true

Maximum Length: 80

Meaning of the create work order option of a work requirement. Values are either Item or Asset. This value is read-only.
CreateWorkOrderOptionCode: string

Title: Create Work Orders Option Code

Read Only: true

Maximum Length: 30

Default Value: ORA_AUTOMATIC

Abbreviation that uniquely identifies if work orders will be created based on the forecast or not. Values are either ORA_AUTOMATIC or ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. This value is read-only.
DayIntervalValue: number

Title: Day Interval

Value for the number of days that will be incremented to calculate the forecast due dates into the future. This value is read-only.
DueAtCycleInterval: number

Title: Due at Cycle Interval

Cycle interval in which the forecast is generated. This value is read-only.
DueAtMeterReading: number

Title: Due at Meter Reading

Value for the meter on the forecast due date. This value is read-only.
ForecastDueDate: string (date)

Title: Due Date

Date on which the forecast is due. This value is read-only.
ForecastId: integer (int64)

Title: Forecast Id

Read Only: true

Value that uniquely identifies the forecast due date for a work requirement and asset in a maintenance program. This value is read-only.
ForecastInterval: string

Title: Forecast Interval

Read Only: true

Maximum Length: 255

Describes how each due date in the forecast is incremented. For a Calendar Pattern the pattern name is displayed. For a Day Interval the number of days of unit of measure is displayed. For a Meter the meter interval and unit of measure is displayed. For a Condition Event a null value is displayed. This value is read-only.
ForecastLineId: integer (int64)

Read Only: true

Value that uniquely identifies the forecast line for a work requirement and asset in a maintenance program. This value is read-only.
ForecastMethod: string

Title: Forecast Method

Read Only: true

Maximum Length: 255

Describes how a maintenance forecast is generated. A forecast can be generated by one these methods: Calendar Pattern, Day Interval value, Meter Template name or Condition Event code. This value is read-only.
ForecastNextDueBy: string

Title: Next Due Date Method

Read Only: true

Maximum Length: 255

Meaning of how the next due date in the forecast will be calculated. For a Calendar Pattern it will display as Last Completion. For a Day Interval it will display as Last Completion or Base Interval . For a Meter it will display as Last Completion or Base Interval. For a Condition Event nothing is displayed. This value is read-only.
ForecastNextDueByCode: string

Title: Next Due Date Code

Read Only: true

Maximum Length: 255

Abbreviation that indicates how the next due date in the forecast will be calculated. The values are ORA_BASE_INTERVAL or ORA_READING_HISTORY as defined in the lookup ORA_MNT_METER_NEXT_DUE. This value is read-only.
ForecastUsingCycleFlag: boolean

Title: Forecast using a cycle

Read Only: true

Maximum Length: 1

Indicates if the forecast will be incremented on a cycle of intervals or not. This value is read-only.
links: array Links

Title: Links

The link relations associated with the resource instance.
MeterDailyRate: number

Title: Meter Daily Rate

Value for the daily utilization rate that will be incremented to calculate the forecast due dates into the future. This value is read-only.
MeterId: integer (int64)

Title: Meter ID

Value that uniquely identifies the asset meter for the forecasted due date. This value is read-only.
MeterName: string

Title: Meter Name

Read Only: true

Maximum Length: 120

Name of the asset meter for the forecasted due date. This value is read-only.
NextWorkOrderOnlyFlag: boolean

Title: Next work order only

Maximum Length: 1

Indicates if the next work orders are created or not. If the value is equal to Y, then the next work order is only created after the completion of the last due work order in the forecast. This value is read-only.
NumberOfIntervals: number

Title: Number of Intervals per Cycle

Read Only: true

Number of intervals for a forecast that is incremented on a cycle of intervals. This value is read-only.
RequirementEndDate: string (date)

Title: End Date

Read Only: true

Date when a work requirement will no longer be considered by the maintenance forecast. This value is read-only.
RequirementId: integer (int64)

Title: Work Requirement

Value that uniquely identifies a work requirement in a maintenance program. This value is read-only.
RequirementName: string

Title: Work Requirement Name

Read Only: true

Maximum Length: 120

Name that uniquely identifies a work requirement across all maintenance programs. This value is read-only.
RequirementReference: string

Title: Requirement Reference

Read Only: true

Maximum Length: 80

Reference for a work requirement in a maintenance program. This value is read-only.
RequirementStartDate: string (date)

Title: Start Date

Read Only: true

Date when a work requirement will be considered by the maintenance forecast. This value is read-only.
RequirementType: string

Title: Type

Read Only: true

Maximum Length: 80

Meaning of the type of a work requirement. Values are either Item or Asset. This value is read-only.
RequirementTypeCode: string

Title: Type

Read Only: true

Maximum Length: 30

Abbreviation that uniquely identifies the type of a work requirement. Values are either ORA_ITEM or ORA_ASSET. This value is read-only.
SuppressFlag: boolean

Title: Suppress

Read Only: true

Maximum Length: 1

Value that indicates whether the work definition requirement is suppressed for the asset in the creation of the forecast. This value is read-only.
WorkDefinitionCode: string

Title: Code

Read Only: true

Maximum Length: 30

Work definition code used in the generated forecast. This value is read-only.
WorkDefinitionDescription: string

Title: Description

Read Only: true

Maximum Length: 240

Work definition description used in the generated forecast. This value is read-only.
WorkDefinitionId: integer (int64)

Title: Work Definition

Read Only: true

Work definition identifier used in the generated forecast. This value is read-only.
WorkDefinitionName: string

Title: Name

Read Only: true

Maximum Length: 120

Work definition name used in the generated forecast. This value is read-only.
WorkDefinitionVersion: string

Title: Version

Read Only: true

Maximum Length: 10

Work definition version used in the generated forecast. This value is read-only.

{
    "type":"object",
    "properties":{
        "RequirementStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when a work requirement will be considered by the maintenance forecast. This value is read-only.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionVersion":{
            "title":"Version",
            "maxLength":"10",
            "type":"string",
            "description":"Work definition version used in the generated forecast. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Date on which the forecast is due. This value is read-only.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "title":"Work Definition",
            "type":"integer",
            "description":"Work definition identifier used in the generated forecast. This value is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkDefinitionName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Work definition name used in the generated forecast. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Work definition description used in the generated forecast. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DueAtCycleInterval":{
            "title":"Due at Cycle Interval",
            "type":"number",
            "description":"Cycle interval in which the forecast is generated. This value is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "RequirementName":{
            "title":"Work Requirement Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name that uniquely identifies a work requirement across all maintenance programs. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastId":{
            "title":"Forecast Id",
            "type":"integer",
            "description":"Value that uniquely identifies the forecast due date for a work requirement and asset in a maintenance program. This value is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MeterId":{
            "title":"Meter ID",
            "type":"integer",
            "description":"Value that uniquely identifies the asset meter for the forecasted due date.  This value is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DueAtMeterReading":{
            "title":"Due at Meter Reading",
            "type":"number",
            "description":"Value for the meter on the forecast due date. This value is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "MeterName":{
            "title":"Meter Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the asset meter for the forecasted due date.  This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastMethod":{
            "title":"Forecast Method",
            "maxLength":"255",
            "type":"string",
            "description":"Describes how a maintenance forecast is generated. A forecast can be generated by one these methods: Calendar Pattern, Day Interval value, Meter Template name or Condition Event code. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreateWoOption":{
            "title":"Create Work Orders Option",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the create work order option of a work requirement.  Values are either Item or Asset. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarPatternId":{
            "title":"Calendar Pattern ID",
            "type":"integer",
            "description":"Value that uniquely identifies the calendar pattern for the forecasted due date.  This value is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreateWorkOrderOptionCode":{
            "title":"Create Work Orders Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies if work orders will be created based on the forecast or not. Values are either ORA_AUTOMATIC or ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_AUTOMATIC",
            "x-queryable":true
        },
        "RequirementId":{
            "title":"Work Requirement",
            "type":"integer",
            "description":"Value that uniquely identifies a work requirement in a maintenance program. This value is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SuppressFlag":{
            "title":"Suppress",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates whether the work definition requirement is suppressed for the asset in the creation of the forecast. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfIntervals":{
            "title":"Number of Intervals per Cycle",
            "type":"number",
            "description":"Number of intervals for a forecast that is incremented on a cycle of intervals. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarPattern":{
            "title":"Calendar Pattern",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the calendar pattern for the forecasted due date.  This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NextWorkOrderOnlyFlag":{
            "title":"Next work order only",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the next work orders are created or not. If the value is equal to Y, then the next work order is only created after the completion of the last due work order in the forecast. This value is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "RequirementTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the type of a work requirement.  Values are either ORA_ITEM or ORA_ASSET. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DayIntervalValue":{
            "title":"Day Interval",
            "type":"number",
            "description":"Value for the number of days that will be incremented to calculate the forecast due dates into the future. This value is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "MeterDailyRate":{
            "title":"Meter Daily Rate",
            "type":"number",
            "description":"Value for the daily utilization rate that will be incremented to calculate the forecast due dates into the future. This value is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the forecast line for a work requirement and asset in a maintenance program. This value is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ForecastNextDueByCode":{
            "title":"Next Due Date Code",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that indicates how the next due date in the forecast will be calculated.  The values are ORA_BASE_INTERVAL or  ORA_READING_HISTORY as defined in the lookup ORA_MNT_METER_NEXT_DUE. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastInterval":{
            "title":"Forecast Interval",
            "maxLength":"255",
            "type":"string",
            "description":"Describes how each due date in the forecast is incremented. For a Calendar Pattern the pattern name is displayed.  For a Day Interval the number of days of unit of measure is displayed. For a Meter the meter interval and unit of measure is displayed.  For a Condition Event a null value is displayed. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequirementReference":{
            "title":"Requirement Reference",
            "maxLength":"80",
            "type":"string",
            "description":"Reference for a work requirement in a maintenance program. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastNextDueBy":{
            "title":"Next Due Date Method",
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of how the next due date in the forecast will be calculated. For a Calendar Pattern it will display as Last Completion.  For a Day Interval it will display as Last Completion or Base Interval . For a Meter it will display as Last Completion or Base Interval.  For a Condition Event nothing is displayed. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Work definition code used in the generated forecast. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementType":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the type of a work requirement.  Values are either Item or Asset. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when a work requirement will no longer be considered by the maintenance forecast. This value is read-only.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastUsingCycleFlag":{
            "title":"Forecast using a cycle",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the forecast will be incremented on a cycle of intervals or not. This value is read-only.",
            "nullable":false,
            "readOnly":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."
        }
    }
}