Get one forecast line due date
get
/fscmRestApi/resources/11.13.18.05/maintenanceForecasts/{ForecastId}/child/forecastLines
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.
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 -
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: Finds forecast due dates according to the forecast line ID identifier.
Finder Variables:- ForecastLineId; integer; Value that uniquely identifies a forecast line for a forecast due date.
- PrimaryKey: Finds forecast due dates according to the forecast line ID identifier.
-
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:- CalendarPattern; string; Name of the calendar pattern for the forecasted due date. This value is read-only.
- CalendarPatternId; integer; Value that uniquely identifies the calendar pattern for the forecasted due date. This value is read-only.
- CreateWoOption; string; Meaning of the create work order option of a work requirement. Values are either Item or Asset. This value is read-only.
- CreateWorkOrderOptionCode; string; 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; 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; Cycle interval in which the forecast is generated. This value is read-only.
- DueAtMeterReading; number; Value for the meter on the forecast due date. This value is read-only.
- ForecastDueDate; string; Date on which the forecast is due. This value is read-only.
- ForecastId; integer; Value that uniquely identifies the forecast due date for a work requirement and asset in a maintenance program. This value is read-only.
- ForecastLineId; integer; Value that uniquely identifies the forecast line for a work requirement and asset in a maintenance program. This value is read-only.
- ForecastNextDueBy; string; 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; 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; Indicates if the forecast will be incremented on a cycle of intervals or not. This value is read-only.
- MeterDailyRate; number; 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; Value that uniquely identifies the asset meter for the forecasted due date. This value is read-only.
- MeterName; string; Name of the asset meter for the forecasted due date. This value is read-only.
- NextWorkOrderOnlyFlag; boolean; 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; Number of intervals for a forecast that is incremented on a cycle of intervals. This value is read-only.
- RequirementEndDate; string; Date when a work requirement will no longer be considered by the maintenance forecast. This value is read-only.
- RequirementId; integer; Value that uniquely identifies a work requirement in a maintenance program. This value is read-only.
- RequirementName; string; Name that uniquely identifies a work requirement across all maintenance programs. This value is read-only.
- RequirementReference; string; Reference for a work requirement in a maintenance program. This value is read-only.
- RequirementStartDate; string; Date when a work requirement will be considered by the maintenance forecast. This value is read-only.
- RequirementType; string; Meaning of the type of a work requirement. Values are either Item or Asset. This value is read-only.
- RequirementTypeCode; string; 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; 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; Work definition code used in the generated forecast. This value is read-only.
- WorkDefinitionDescription; string; Work definition description used in the generated forecast. This value is read-only.
- WorkDefinitionId; integer; Work definition identifier used in the generated forecast. This value is read-only.
- WorkDefinitionName; string; Work definition name used in the generated forecast. This value is read-only.
- WorkDefinitionVersion; string; Work definition version used in the generated forecast. This value is read-only.
-
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:
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 TopResponse
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
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : maintenanceForecasts-forecastLines-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.